Top Description Methods
javax.enterprise.deploy.spi

public Interface DeploymentConfiguration

Imports
javax.enterprise.deploy.model.*, javax.enterprise.deploy.spi.exceptions.ConfigurationException, .BeanNotFoundException, java.io.InputStream, .OutputStream

An interface that defines a container for all the server-specific configuration information for a single top-level Jakarta EE 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

Method Summary

Modifier and TypeMethod and Description
public DConfigBeanRoot

Returns:

the DConfigBeanRoot for editing the server-specific properties required by the module.
getDConfigBeanRoot
(DDBeanRoot
The top level bean that represents the associated deployment descriptor.
bean
)

Returns the top level configuration bean, DConfigBeanRoot, associated with the deployment descriptor represented by the designated DDBeanRoot bean.

public DeployableObject

Returns:

DeployableObject
getDeployableObject
()

Returns an object that provides access to the deployment descriptor data and classes of a Java EE module.

public void
removeDConfigBean(DConfigBeanRoot
the top leve DConfigBean to remove.
bean
)

Remove the root DConfigBean and all its children.

public void
restore(InputStream
The input stream from which to restore the Configuration.
inputArchive
)

Restore from disk to a full set of configuration beans previously stored.

public DConfigBeanRoot

Returns:

The top most parent configuration bean, DConfigBeanRoot
restoreDConfigBean
(InputStream
The input stream for the file from which the DConfigBeans should be restored.
inputArchive
,
DDBeanRoot
The DDBeanRoot bean associated with the deployment descriptor file.
bean
)

Restore from disk to instantated objects all the DConfigBeans associated with a specific deployment descriptor.

public void
save(OutputStream
The output stream to which to save the Configuration.
outputArchive
)

Save to disk the current set configuration beans created for this deployable module.

public void
saveDConfigBean(OutputStream
The output stream to which the DConfigBeans should be saved.
outputArchive
,
DConfigBeanRoot
The top level bean, DConfigBeanRoot, from which to be save.
bean
)

Save to disk all the configuration beans associated with a particular deployment descriptor file.

Method Detail

getDConfigBeanRootback to summary
public DConfigBeanRoot getDConfigBeanRoot(DDBeanRoot bean) throws ConfigurationException

Returns the top level configuration bean, DConfigBeanRoot, associated with the deployment descriptor represented by the designated DDBeanRoot bean.

Parameters
bean:DDBeanRoot

The top level bean that represents the associated deployment descriptor.

Returns:DConfigBeanRoot

the DConfigBeanRoot for editing the server-specific properties required by the module.

Exceptions
ConfigurationException:
reports errors in generating a configuration bean
getDeployableObjectback to summary
public DeployableObject getDeployableObject()

Returns an object that provides access to the deployment descriptor data and classes of a Java EE module.

Returns:DeployableObject

DeployableObject

removeDConfigBeanback to summary
public void removeDConfigBean(DConfigBeanRoot bean) throws BeanNotFoundException

Remove the root DConfigBean and all its children.

Parameters
bean:DConfigBeanRoot

the top leve DConfigBean to remove.

Exceptions
BeanNotFoundException:
the bean provides is not in this beans child list.
restoreback to summary
public void restore(InputStream inputArchive) throws ConfigurationException

Restore from disk to a full set of configuration beans previously stored.

Parameters
inputArchive:InputStream

The input stream from which to restore the Configuration.

Exceptions
ConfigurationException:
reports errors in generating a configuration bean
restoreDConfigBeanback to summary
public DConfigBeanRoot restoreDConfigBean(InputStream inputArchive, DDBeanRoot bean) throws ConfigurationException

Restore from disk to instantated objects all the DConfigBeans associated with a specific deployment descriptor. The beans may be fully or partially configured.

Parameters
inputArchive:InputStream

The input stream for the file from which the DConfigBeans should be restored.

bean:DDBeanRoot

The DDBeanRoot bean associated with the deployment descriptor file.

Returns:DConfigBeanRoot

The top most parent configuration bean, DConfigBeanRoot

Exceptions
ConfigurationException:
reports errors in generating a configuration bean
saveback to summary
public void save(OutputStream outputArchive) throws ConfigurationException

Save to disk the current set configuration beans created for this deployable module. It is recommended the file format be XML.

Parameters
outputArchive:OutputStream

The output stream to which to save the Configuration.

saveDConfigBeanback to summary
public void saveDConfigBean(OutputStream outputArchive, DConfigBeanRoot bean) throws ConfigurationException

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.

Parameters
outputArchive:OutputStream

The output stream to which the DConfigBeans should be saved.

bean:DConfigBeanRoot

The top level bean, DConfigBeanRoot, from which to be save.

Exceptions
ConfigurationException:
reports errors in generating a configuration bean