org.apache.avalon.composition.model
Interface DeploymentModel

All Superinterfaces:
Model
All Known Implementing Classes:
DefaultDeploymentModel

public interface DeploymentModel
extends Model

Deployment model defintion.

Version:
$Revision: 1.7 $ $Date: 2003/12/14 14:09:59 $
Author:
Avalon Development Team

Method Summary
 boolean getActivationPolicy()
          Return the activation policy for the model.
 CategoriesDirective getCategories()
          Return the logging categories.
 int getCollectionPolicy()
          Return the collection policy for the model.
 Configuration getConfiguration()
          Return the configuration to be applied to the component.
 ContextModel getContextModel()
          Return the context model for this deployment model.
 DependencyModel[] getDependencyModels()
          Return the dependency models for this deployment model.
 Class getDeploymentClass()
          Return the class for the deployable target.
 Class[] getInterfaces()
          Return the set of services produced by the model as a array of classes.
 Parameters getParameters()
          Return the configuration to be applied to the component.
 StageModel[] getStageModels()
          Return the stage models for this deployment model.
 Type getType()
          Return the deployment type.
 boolean isContextDependent()
          Rest if the component type backing the model requires the establishment of a runtime context.
 boolean isParameterizable()
          Test if the component type backing the model is parameterizable.
 void revertActivationPolicy()
          Set the activation policy for the model to the default value.
 void setActivationPolicy(boolean policy)
          Set the activation policy for the model.
 void setCategories(CategoriesDirective categories)
          Set categories.
 void setCollectionPolicy(int policy)
          Set the collection policy to a supplied value.
 void setConfiguration(Configuration config)
          Set the configuration to the supplied value.
 void setConfiguration(Configuration config, boolean policy)
          Set the configuration to the supplied value.
 void setParameters(Parameters parameters)
          Set the parameters to the supplied value.
 void setParameters(Parameters parameters, boolean policy)
          Set the parameters to the supplied value.
 
Methods inherited from interface org.apache.avalon.composition.model.Model
getMode, getName, getPath, getQualifiedName, getServices, isaCandidate, isaCandidate
 

Method Detail

getType

public Type getType()
Return the deployment type.

Returns:
the type

getActivationPolicy

public boolean getActivationPolicy()
Return the activation policy for the model.

Returns:
the activaltion policy

getCollectionPolicy

public int getCollectionPolicy()
Return the collection policy for the model. If a profile does not declare a collection policy, the collection policy declared by the type will be used.

Returns:
the collection policy
See Also:
InfoDescriptor.WEAK, InfoDescriptor.SOFT, InfoDescriptor.HARD

setCollectionPolicy

public void setCollectionPolicy(int policy)
Set the collection policy to a supplied value.

Parameters:
policy - the collection policy
See Also:
InfoDescriptor.WEAK, InfoDescriptor.SOFT, InfoDescriptor.HARD, InfoDescriptor.UNDEFINED

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

setActivationPolicy

public void setActivationPolicy(boolean policy)
Set the activation policy for the model.

Parameters:
policy - the activaltion policy

revertActivationPolicy

public void revertActivationPolicy()
Set the activation policy for the model to the default value.


getDeploymentClass

public Class getDeploymentClass()
Return the class for the deployable target.

Returns:
the class

setConfiguration

public void setConfiguration(Configuration config)
Set the configuration to the supplied value. The supplied configuration will replace the existing configuration.

Parameters:
config - the supplied configuration

setConfiguration

public void setConfiguration(Configuration config,
                             boolean policy)
Set the configuration to the supplied value. The supplied configuration may suppliment or replace the existing configuration.

Parameters:
config - the supplied configuration
policy - if TRUE the supplied configuration replaces the current configuration otherwise the resoved configuration shall be layed above the configuration supplied with the profile which in turn is layer above the type default configuration (if any)

getConfiguration

public Configuration getConfiguration()
Return the configuration to be applied to the component. The implementation returns the current configuration state. If the the component type does not implementation the Configurable interface, the implementation returns null.

Returns:
the qualified configuration

isParameterizable

public boolean isParameterizable()
Test if the component type backing the model is parameterizable.

Returns:
TRUE if the component type is parameterizable otherwise FALSE

setParameters

public void setParameters(Parameters parameters)
Set the parameters to the supplied value. The supplied parameters value will replace the existing parameters value.

Parameters:
parameters - the supplied parameters value

setParameters

public void setParameters(Parameters parameters,
                          boolean policy)
Set the parameters to the supplied value. The supplied parameters value may suppliment or replace the existing parameters value.

Parameters:
parameters - the supplied parameters
policy - if TRUE the supplied parameters replaces the current parameters value otherwise the existing and supplied values are aggregrated

getParameters

public Parameters getParameters()
Return the configuration to be applied to the component. The implementation returns the current configuration state. If the the component type does not implementation the Configurable interface, the implementation returns null.

Returns:
the qualified configuration

isContextDependent

public boolean isContextDependent()
Rest if the component type backing the model requires the establishment of a runtime context.

Returns:
TRUE if the component type requires a runtime context otherwise FALSE

getContextModel

public ContextModel getContextModel()
Return the context model for this deployment model.

Returns:
the context model if this model is context dependent, else the return value is null

getDependencyModels

public DependencyModel[] getDependencyModels()
Return the dependency models for this deployment model.

Returns:
the dependency models

getStageModels

public StageModel[] getStageModels()
Return the stage models for this deployment model.

Returns:
the stage models

getInterfaces

public Class[] getInterfaces()
Return the set of services produced by the model as a array of classes.

Returns:
the service classes


Copyright © Apache Software Foundation. All Rights Reserved.