org.apache.avalon.composition.model
Interface DeploymentModel

All Superinterfaces:
Commissionable, Resolver
All Known Subinterfaces:
ComponentModel, ContainmentModel
All Known Implementing Classes:
DefaultComponentModel, DefaultContainmentModel, DefaultDeploymentModel

public interface DeploymentModel
extends Commissionable, Resolver

Model desribing a deployment scenario.

Version:
$Revision: 1.20 $ $Date: 2004/03/17 10:30:08 $
Author:
Avalon Development Team

Field Summary
static String DEPLOYMENT_TIMEOUT_KEY
           
static String SEPARATOR
           
 
Method Summary
 AccessControlContext getAccessControlContext()
          Return the access control context.
 CategoriesDirective getCategories()
          Return the logging categories.
 DeploymentModel[] getConsumerGraph()
          Return the set of models consuming this model.
 long getDeploymentTimeout()
          Return the default deployment timeout value declared in the kernel configuration.
 Logger getLogger()
          Return the assigned logging channel.
 Mode getMode()
          Return the mode of model establishment.
 String getName()
          Return the name of the model.
 String getPath()
          Return the model partition path.
 DeploymentModel[] getProviderGraph()
          Return the set of models supplying this model.
 DeploymentModel[] getProviders()
          Return the set of models assigned as providers.
 String getQualifiedName()
          Return the model fully qualified name.
 ServiceDescriptor[] getServices()
          Return the set of services produced by the model.
 boolean isaCandidate(DependencyDescriptor dependency)
          Return TRUE is this model is capable of supporting a supplied depedendency.
 boolean isaCandidate(ReferenceDescriptor reference)
          Return TRUE is this model is capable of supporting a supplied service.
 boolean isaCandidate(StageDescriptor stage)
          Return TRUE is this model is capable of supporting a supplied stage dependency.
 boolean isAssembled()
          Returns the assembled state of the model.
 void setCategories(CategoriesDirective categories)
          Set categories.
 
Methods inherited from interface org.apache.avalon.composition.model.Commissionable
commission, decommission
 
Methods inherited from interface org.apache.avalon.composition.model.Resolver
release, resolve, resolve
 

Field Detail

SEPARATOR

public static final String SEPARATOR
See Also:
Constant Field Values

DEPLOYMENT_TIMEOUT_KEY

public static final String DEPLOYMENT_TIMEOUT_KEY
See Also:
Constant Field Values
Method Detail

getName

public String getName()
Return the name of the model.

Returns:
the name

getPath

public String getPath()
Return the model partition path.

Returns:
the path

getQualifiedName

public String getQualifiedName()
Return the model fully qualified name.

Returns:
the fully qualified name

getMode

public Mode getMode()
Return the mode of model establishment.

Returns:
the mode

getLogger

public Logger getLogger()
Return the assigned logging channel.

Returns:
the logging channel

getCategories

public CategoriesDirective getCategories()
Return the logging categories.

Returns:
the logging categories

setCategories

public void setCategories(CategoriesDirective categories)
Set categories.

Parameters:
categories - the logging categories

getAccessControlContext

public AccessControlContext getAccessControlContext()
Return the access control context.

Returns:
the access control context

getServices

public ServiceDescriptor[] getServices()
Return the set of services produced by the model.

Returns:
the services

isaCandidate

public boolean isaCandidate(DependencyDescriptor dependency)
Return TRUE is this model is capable of supporting a supplied depedendency.

Returns:
true if this model can fulfill the dependency

isaCandidate

public boolean isaCandidate(StageDescriptor stage)
Return TRUE is this model is capable of supporting a supplied stage dependency.

Returns:
true if this model can fulfill the dependency

isaCandidate

public boolean isaCandidate(ReferenceDescriptor reference)
Return TRUE is this model is capable of supporting a supplied service.

Parameters:
reference - the service reference descriptor
Returns:
true if this model can fulfill the service

isAssembled

public boolean isAssembled()
Returns the assembled state of the model.

Returns:
true if this model is assembled

getConsumerGraph

public DeploymentModel[] getConsumerGraph()
Return the set of models consuming this model.

Returns:
the consumers

getProviderGraph

public DeploymentModel[] getProviderGraph()
Return the set of models supplying this model.

Returns:
the providers

getProviders

public DeploymentModel[] getProviders()
Return the set of models assigned as providers.

Returns:
the providers consumed by the model
Throws:
IllegalStateException - if invoked prior to the completion of the assembly phase

getDeploymentTimeout

public long getDeploymentTimeout()
Return the default deployment timeout value declared in the kernel configuration. The implementation looks for a value assigned under the property key "urn:composition:deployment.timeout" and defaults to 1000 msec if undefined.

Returns:
the default deployment timeout value


Copyright © The Apache Software Foundation. All Rights Reserved.