org.apache.avalon.activation.appliance
Interface Engine

All Known Subinterfaces:
Block
All Known Implementing Classes:
AbstractBlock

public interface Engine

The Engine interface defines the contract for service that provide appliance resolution.

Version:
$Revision: 1.3 $ $Date: 2003/11/22 12:52:55 $
Author:
Avalon Development Team

Method Summary
 Appliance locate(DependencyDescriptor dependency)
          Return an appliance relative to a supplied dependency descriptor.
 Appliance locate(DependencyModel dependency)
          Return an appliance relative to a supplied dependency model.
 Appliance locate(StageDescriptor stage)
          Return an appliance relative to a supplied stage descriptor.
 Appliance locate(StageModel stage)
          Return an appliance relative to a supplied stage model.
 Appliance locate(String path)
          Return an appliance relative to a supplied path.
 

Method Detail

locate

public Appliance locate(DependencyModel dependency)
                 throws NoProviderDefinitionException,
                        ApplianceException
Return an appliance relative to a supplied dependency model.

Parameters:
dependency - the dependency model
Returns:
the appliance
Throws:
NoProviderDefinitionException - if no provider an be found for the supplied dependency
ApplianceException - if an error occurs during appliance resolution

locate

public Appliance locate(DependencyDescriptor dependency)
                 throws NoProviderDefinitionException,
                        ApplianceException
Return an appliance relative to a supplied dependency descriptor.

Parameters:
dependency - the dependency descriptor
Returns:
the appliance
Throws:
NoProviderDefinitionException - if no provider an be found for the supplied dependency
ApplianceException - if an error occurs during appliance resolution

locate

public Appliance locate(StageModel stage)
                 throws NoProviderDefinitionException,
                        ApplianceException
Return an appliance relative to a supplied stage model.

Parameters:
stage - the stage model
Returns:
the appliance
Throws:
NoProviderDefinitionException - if no provider an be found for the supplied stage
ApplianceException - if an error occurs during appliance resolution

locate

public Appliance locate(StageDescriptor stage)
                 throws NoProviderDefinitionException,
                        ApplianceException
Return an appliance relative to a supplied stage descriptor.

Parameters:
stage - the stage descriptor
Returns:
the appliance
Throws:
NoProviderDefinitionException - if no provider an be found for the supplied stage
ApplianceException - if an error occurs during appliance resolution

locate

public Appliance locate(String path)
                 throws IllegalArgumentException,
                        ApplianceException
Return an appliance relative to a supplied path.

Parameters:
path - the appliance path
Returns:
the appliance
Throws:
IllegalArgumentException - if the supplied path is invalid
ApplianceException - if an error occurs during appliance resolution


Copyright © Apache Software Foundation. All Rights Reserved.