org.apache.avalon.composition.model
Interface DeploymentContext

All Known Implementing Classes:
DefaultDeploymentContext

public interface DeploymentContext

Defintion of a deployment context.

Version:
$Revision: 1.2 $ $Date: 2003/10/28 12:53:48 $
Author:
Avalon Development Team

Field Summary
static String CLASSLOADER_KEY
          The standard context entry key for the partition name.
static String HOME_KEY
          The standard context entry key for the partition name.
static String NAME_KEY
          The standard context entry key for the partition name.
static String PARTITION_KEY
          The standard context entry key for the partition name.
static String TEMP_KEY
          The standard context entry key for the partition name.
 
Method Summary
 ClassLoader getClassLoader()
          Return the classloader for the component.
 ContainmentContext getContainmentContext()
          Return the containment context.
 Class getDeploymentClass()
          Return the component class.
 File getHomeDirectory()
          Return the working directory for the component.
 Logger getLogger()
          Return the logging channel assignable to the deployment model.
 String getName()
          Return the name that the component will execute under.
 String getPartitionName()
          Return the partition name that the component will execute within.
 DeploymentProfile getProfile()
          Return the deployment profile.
 SystemContext getSystemContext()
          Return the system context.
 File getTempDirectory()
          Return the temporary directory for the component.
 Type getType()
          Return the component type.
 void register(EntryModel model)
          Add a context entry model to the deployment context.
 Object resolve(String alias)
          Get a context entry from the deployment context.
 

Field Detail

PARTITION_KEY

public static final String PARTITION_KEY
The standard context entry key for the partition name.

See Also:
Constant Field Values

NAME_KEY

public static final String NAME_KEY
The standard context entry key for the partition name.

See Also:
Constant Field Values

CLASSLOADER_KEY

public static final String CLASSLOADER_KEY
The standard context entry key for the partition name.

See Also:
Constant Field Values

HOME_KEY

public static final String HOME_KEY
The standard context entry key for the partition name.

See Also:
Constant Field Values

TEMP_KEY

public static final String TEMP_KEY
The standard context entry key for the partition name.

See Also:
Constant Field Values
Method Detail

getPartitionName

public String getPartitionName()
Return the partition name that the component will execute within.

Returns:
the partition name

getName

public String getName()
Return the name that the component will execute under.

Returns:
the name

getSystemContext

public SystemContext getSystemContext()
Return the system context.

Returns:
the system context

getContainmentContext

public ContainmentContext getContainmentContext()
Return the containment context.

Returns:
the containment context

getHomeDirectory

public File getHomeDirectory()
Return the working directory for the component.

Returns:
the working directory

getTempDirectory

public File getTempDirectory()
Return the temporary directory for the component.

Returns:
the temporary directory

getLogger

public Logger getLogger()
Return the logging channel assignable to the deployment model.

Returns:
the logging channel

getProfile

public DeploymentProfile getProfile()
Return the deployment profile.

Returns:
the profile

getType

public Type getType()
Return the component type.

Returns:
the type defintion

getDeploymentClass

public Class getDeploymentClass()
Return the component class.

Returns:
the class

getClassLoader

public ClassLoader getClassLoader()
Return the classloader for the component.

Returns:
the classloader

register

public void register(EntryModel model)
Add a context entry model to the deployment context.

Parameters:
model - the entry model

resolve

public Object resolve(String alias)
               throws ContextException
Get a context entry from the deployment context.

Parameters:
alias - the entry lookup key
Returns:
value the corresponding value
Throws:
ContextException - if a key corresponding to the supplied alias is unknown


Copyright © Apache Software Foundation. All Rights Reserved.