javax.enterprise.deploy.spi
Interface 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.
DConfigBeanRoot | getDConfigBeanRoot(DDBeanRoot bean) - Returns the top level configuration bean, DConfigBeanRoot, associated with
the deployment descriptor represented by the designated DDBeanRoot bean.
|
DeployableObject | getDeployableObject() - Returns an object that provides access to the deployment descriptor data
and classes of a J2EE module.
|
void | removeDConfigBean(DConfigBeanRoot bean) - Remove the root DConfigBean and all its children.
|
void | restore(InputStream inputArchive) - Restore from disk to a full set of configuration beans previously stored.
|
DConfigBeanRoot | restoreDConfigBean(InputStream inputArchive, DDBeanRoot bean) - Restore from disk to instantated objects all the DConfigBeans associated with a
specific deployment descriptor.
|
void | save(OutputStream outputArchive) - Save to disk the current set configuration beans created for this deployable
module.
|
void | saveDConfigBean(OutputStream outputArchive, DConfigBeanRoot bean) - Save to disk all the configuration beans associated with a particular deployment
descriptor file.
|
getDConfigBeanRoot
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.
bean
- The top level bean that represents the associated deployment descriptor.
- the DConfigBeanRoot for editing the server-specific properties required by the module.
getDeployableObject
public DeployableObject getDeployableObject()
Returns an object that provides access to the deployment descriptor data
and classes of a J2EE module.
removeDConfigBean
public void removeDConfigBean(DConfigBeanRoot bean)
throws BeanNotFoundException
Remove the root DConfigBean and all its children.
bean
- the top leve DConfigBean to remove.
restore
public void restore(InputStream inputArchive)
throws ConfigurationException
Restore from disk to a full set of configuration beans previously stored.
inputArchive
- The input stream from which to restore the Configuration.
restoreDConfigBean
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.
inputArchive
- The input stream for the file from which the DConfigBeans
should be restored.bean
- The DDBeanRoot bean associated with the deployment descriptor file.
- The top most parent configuration bean, DConfigBeanRoot
save
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.
outputArchive
- The output stream to which to save the Configuration.
saveDConfigBean
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.
outputArchive
- The output stream to which the DConfigBeans should be saved.bean
- The top level bean, DConfigBeanRoot, from which to be save.