javax.enterprise.deploy.spi

Interface DeploymentConfiguration

public interface DeploymentConfiguration

A container for server specific configuration for a top level deployment.

Version:

$Revision$

Author:

Adrian Brock

Method Summary

Methods

Modifier and Type	Method and Description
DConfigBeanRoot	getDConfigBeanRoot(DDBeanRoot bean) Return the top level configuration for a deployment descriptor
DeployableObject	getDeployableObject() Return an object that provides access to the deployment descriptor
void	removeDConfigBean(DConfigBeanRoot bean) Remove a root configuration and all its children
void	restore(InputStream input) Restores a full set of configuration beans
DConfigBeanRoot	restoreDConfigBean(InputStream input, DDBeanRoot bean) Restore a configuration from an input stream
void	save(OutputStream output) Saves the fulls set of configuration beans
void	saveDConfigBean(OutputStream output, DConfigBeanRoot bean) Save a configuration to an output stream

Method Detail

getDeployableObject

DeployableObject getDeployableObject()

Return an object that provides access to the deployment descriptor

Returns:

the deployable object

getDConfigBeanRoot

DConfigBeanRoot getDConfigBeanRoot(DDBeanRoot bean)
                                   throws ConfigurationException

Return the top level configuration for a deployment descriptor

Parameters:

bean - the root of the deployment descriptor

Returns:

the configuration

Throws:

ConfigurationException - for an error in the deployment descriptor

removeDConfigBean

void removeDConfigBean(DConfigBeanRoot bean)
                       throws BeanNotFoundException

Remove a root configuration and all its children

Parameters:

bean - the configuration

Throws:

BeanNotFoundException - when the bean is not found

restoreDConfigBean

DConfigBeanRoot restoreDConfigBean(InputStream input,
                                 DDBeanRoot bean)
                                   throws ConfigurationException

Restore a configuration from an input stream

Parameters:

input - the input stream

bean - the deployment descriptor

Returns:

the configuration

Throws:

ConfigurationException - when there is an error in the configuration

saveDConfigBean

void saveDConfigBean(OutputStream output,
                   DConfigBeanRoot bean)
                     throws ConfigurationException

Save a configuration to an output stream

Parameters:

output - the output stream

bean - the configuration

Throws:

ConfigurationException - when there is an error in the configuration

restore

void restore(InputStream input)
             throws ConfigurationException

Restores a full set of configuration beans

Parameters:

input - the input stream

Throws:

ConfigurationException - for an error in the configuration

save

void save(OutputStream output)
          throws ConfigurationException

Saves the fulls set of configuration beans

Parameters:

output - the output stream

Throws:

ConfigurationException - for an error in the configuration