Package org.glassfish.deployapi.config
Class SunDeploymentConfiguration
- java.lang.Object
-
- org.glassfish.deployapi.config.SunDeploymentConfiguration
-
- All Implemented Interfaces:
javax.enterprise.deploy.spi.DeploymentConfiguration
public class SunDeploymentConfiguration extends Object implements javax.enterprise.deploy.spi.DeploymentConfiguration
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:
- Jerome Dochez
-
-
Field Summary
Fields Modifier and Type Field Description protected static LocalStringManagerImpl
localStrings
-
Constructor Summary
Constructors Constructor Description SunDeploymentConfiguration(javax.enterprise.deploy.model.DeployableObject deployObject)
Creates a new instance of SunDeploymentConfiguration
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description javax.enterprise.deploy.spi.DConfigBeanRoot
getDConfigBeanRoot(javax.enterprise.deploy.model.DDBeanRoot dDBeanRoot)
Returns the top level configuration bean, DConfigBeanRoot, associated with the deployment descriptor represented by the designated DDBeanRoot bean.javax.enterprise.deploy.model.DeployableObject
getDeployableObject()
Returns an object that provides access to the deployment descriptor data and classes of a J2EE module.javax.enterprise.deploy.spi.DeploymentManager
getDeploymentManager()
void
removeDConfigBean(javax.enterprise.deploy.spi.DConfigBeanRoot dConfigBeanRoot)
Remove the root DConfigBean and all its children.void
restore(InputStream inputStream)
Restore from disk to a full set of configuration beans previously stored.javax.enterprise.deploy.spi.DConfigBeanRoot
restoreDConfigBean(InputStream inputStream, javax.enterprise.deploy.model.DDBeanRoot dDBeanRoot)
Restore from disk to instantated objects all the DConfigBeans associated with a specific deployment descriptor.void
save(OutputStream outputStream)
Save to disk the current set configuration beans created for this deployable module.void
saveDConfigBean(OutputStream outputStream, javax.enterprise.deploy.spi.DConfigBeanRoot dConfigBeanRoot)
Save to disk all the configuration beans associated with a particular deployment descriptor file.void
setDeploymentManager(javax.enterprise.deploy.spi.DeploymentManager deploymentManager)
sets the deployment manager
-
-
-
Field Detail
-
localStrings
protected static final LocalStringManagerImpl localStrings
-
-
Method Detail
-
getDConfigBeanRoot
public javax.enterprise.deploy.spi.DConfigBeanRoot getDConfigBeanRoot(javax.enterprise.deploy.model.DDBeanRoot dDBeanRoot) throws javax.enterprise.deploy.spi.exceptions.ConfigurationException
Returns the top level configuration bean, DConfigBeanRoot, associated with the deployment descriptor represented by the designated DDBeanRoot bean.- Specified by:
getDConfigBeanRoot
in interfacejavax.enterprise.deploy.spi.DeploymentConfiguration
- 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:
javax.enterprise.deploy.spi.exceptions.ConfigurationException
- reports errors in generating a configuration bean
-
getDeployableObject
public javax.enterprise.deploy.model.DeployableObject getDeployableObject()
Returns an object that provides access to the deployment descriptor data and classes of a J2EE module.- Specified by:
getDeployableObject
in interfacejavax.enterprise.deploy.spi.DeploymentConfiguration
- Returns:
- DeployableObject
-
removeDConfigBean
public void removeDConfigBean(javax.enterprise.deploy.spi.DConfigBeanRoot dConfigBeanRoot) throws javax.enterprise.deploy.spi.exceptions.BeanNotFoundException
Remove the root DConfigBean and all its children.- Specified by:
removeDConfigBean
in interfacejavax.enterprise.deploy.spi.DeploymentConfiguration
- Parameters:
bean
- the top leve DConfigBean to remove.- Throws:
javax.enterprise.deploy.spi.exceptions.BeanNotFoundException
- the bean provides is not in this beans child list.
-
restore
public void restore(InputStream inputStream) throws javax.enterprise.deploy.spi.exceptions.ConfigurationException
Restore from disk to a full set of configuration beans previously stored.- Specified by:
restore
in interfacejavax.enterprise.deploy.spi.DeploymentConfiguration
- Parameters:
inputArchive
- The input stream from which to restore the Configuration.- Throws:
javax.enterprise.deploy.spi.exceptions.ConfigurationException
- reports errors in generating a configuration bean
-
restoreDConfigBean
public javax.enterprise.deploy.spi.DConfigBeanRoot restoreDConfigBean(InputStream inputStream, javax.enterprise.deploy.model.DDBeanRoot dDBeanRoot) throws javax.enterprise.deploy.spi.exceptions.ConfigurationException
Restore from disk to instantated objects all the DConfigBeans associated with a specific deployment descriptor. The beans may be fully or partially configured.- Specified by:
restoreDConfigBean
in interfacejavax.enterprise.deploy.spi.DeploymentConfiguration
- 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:
javax.enterprise.deploy.spi.exceptions.ConfigurationException
- reports errors in generating a configuration bean
-
save
public void save(OutputStream outputStream) throws javax.enterprise.deploy.spi.exceptions.ConfigurationException
Save to disk the current set configuration beans created for this deployable module. It is recommended the file format be XML.- Specified by:
save
in interfacejavax.enterprise.deploy.spi.DeploymentConfiguration
- Parameters:
outputArchive
- The output stream to which to save the Configuration.- Throws:
javax.enterprise.deploy.spi.exceptions.ConfigurationException
-
saveDConfigBean
public void saveDConfigBean(OutputStream outputStream, javax.enterprise.deploy.spi.DConfigBeanRoot dConfigBeanRoot) throws javax.enterprise.deploy.spi.exceptions.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.- Specified by:
saveDConfigBean
in interfacejavax.enterprise.deploy.spi.DeploymentConfiguration
- Parameters:
outputArchive
- The output stream to which the DConfigBeans should be saved.bean
- The top level bean, DConfigBeanRoot, from which to be save.- Throws:
javax.enterprise.deploy.spi.exceptions.ConfigurationException
- reports errors in generating a configuration bean
-
setDeploymentManager
public void setDeploymentManager(javax.enterprise.deploy.spi.DeploymentManager deploymentManager)
sets the deployment manager
-
getDeploymentManager
public javax.enterprise.deploy.spi.DeploymentManager getDeploymentManager()
- Returns:
- the deployment manager
-
-