FileDocCategorySizeDatePackage
DeploymentConfiguration.javaAPI DocGlassfish v2 API6096Fri May 04 22:35:48 BST 2007javax.enterprise.deploy.spi

DeploymentConfiguration

public interface DeploymentConfiguration
An interface that defines a container for all the server-specific configuration information for a single top-level J2EE module. The DeploymentConfiguration object could represent a single stand alone module or an EAR file that contains several sub-modules.
author
gfink
version
0.1

Fields Summary
Constructors Summary
Methods Summary
public DConfigBeanRootgetDConfigBeanRoot(DDBeanRoot bean)
Returns the top level configuration bean, DConfigBeanRoot, associated with the deployment descriptor represented by the designated DDBeanRoot bean.

param
bean The top level bean that represents the associated deployment descriptor.
return
the DConfigBeanRoot for editing the server-specific properties required by the module.
throws
ConfigurationException reports errors in generating a configuration bean

public DeployableObjectgetDeployableObject()
Returns an object that provides access to the deployment descriptor data and classes of a J2EE module.

return
DeployableObject

public voidremoveDConfigBean(DConfigBeanRoot bean)
Remove the root DConfigBean and all its children.

param
bean the top leve DConfigBean to remove.
throws
BeanNotFoundException the bean provides is not in this beans child list.

public voidrestore(java.io.InputStream inputArchive)
Restore from disk to a full set of configuration beans previously stored.

param
inputArchive The input stream from which to restore the Configuration.
throws
ConfigurationException reports errors in generating a configuration bean

public DConfigBeanRootrestoreDConfigBean(java.io.InputStream inputArchive, DDBeanRoot bean)
Restore from disk to instantated objects all the DConfigBeans associated with a specific deployment descriptor. The beans may be fully or partially configured.

param
inputArchive The input stream for the file from which the DConfigBeans should be restored.
param
bean The DDBeanRoot bean associated with the deployment descriptor file.
return
The top most parent configuration bean, DConfigBeanRoot
throws
ConfigurationException reports errors in generating a configuration bean

public voidsave(java.io.OutputStream outputArchive)
Save to disk the current set configuration beans created for this deployable module. It is recommended the file format be XML.

param
outputArchive The output stream to which to save the Configuration.
throws
ConfigurationException

public voidsaveDConfigBean(java.io.OutputStream outputArchive, DConfigBeanRoot bean)
Save to disk all the configuration beans associated with a particular deployment descriptor file. The saved data may be fully or partially configured DConfigBeans. The output file format is recommended to be XML.

param
outputArchive The output stream to which the DConfigBeans should be saved.
param
bean The top level bean, DConfigBeanRoot, from which to be save.
throws
ConfigurationException reports errors in generating a configuration bean