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

Version:

0.1

Author:

gfink

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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 Java EE 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.

DeploymentConfiguration (Java(TM) EE 7 Specification APIs) Home of API Java Contents Haut

- Method Detail
  - getDeployableObject
```
DeployableObject getDeployableObject()
```
    Returns an object that provides access to the deployment descriptor data and classes of a Java EE module.
    
    Returns:
    
    DeployableObject
  - getDConfigBeanRoot
```
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 - The top level bean that represents the associated deployment descriptor.
    
    Returns:
    
    the DConfigBeanRoot for editing the server-specific properties required by the module.
    
    Throws:
    
    ConfigurationException - reports errors in generating a configuration bean
  - removeDConfigBean
```
void removeDConfigBean(DConfigBeanRoot bean)
                throws BeanNotFoundException
```
    Remove the root DConfigBean and all its children.
    
    Parameters:
    
    bean - the top leve DConfigBean to remove.
    
    Throws:
    
    BeanNotFoundException - the bean provides is not in this beans child list.
  - restoreDConfigBean
```
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 - The input stream for the file from which the DConfigBeans should be restored.
    
    bean - The DDBeanRoot bean associated with the deployment descriptor file.
    
    Returns:
    
    The top most parent configuration bean, DConfigBeanRoot
    
    Throws:
    
    ConfigurationException - reports errors in generating a configuration bean
  - saveDConfigBean
```
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 - The output stream to which the DConfigBeans should be saved.
    
    bean - The top level bean, DConfigBeanRoot, from which to be save.
    
    Throws:
    
    ConfigurationException - reports errors in generating a configuration bean
  - restore
```
void restore(InputStream inputArchive)
      throws ConfigurationException
```
    Restore from disk to a full set of configuration beans previously stored.
    
    Parameters:
    
    inputArchive - The input stream from which to restore the Configuration.
    
    Throws:
    
    ConfigurationException - reports errors in generating a configuration bean
  - save
```
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 - The output stream to which to save the Configuration.
    
    Throws:
    
    ConfigurationException

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/enterprise/deploy/spi/DeploymentConfiguration.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : https://docs.oracle.com, DeploymentConfiguration (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Interface DeploymentConfiguration

Method Summary

Method Detail

getDeployableObject

getDConfigBeanRoot

removeDConfigBean

restoreDConfigBean

saveDConfigBean

restore

save

References