FileDocCategorySizeDatePackage
SunDeploymentConfiguration.javaAPI DocGlassfish v2 API7410Fri May 04 22:34:30 BST 2007com.sun.enterprise.deployapi.config

SunDeploymentConfiguration

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

Fields Summary
private final javax.enterprise.deploy.model.DeployableObject
deployObject
private javax.enterprise.deploy.spi.DeploymentManager
deploymentManager
protected static final com.sun.enterprise.util.LocalStringManagerImpl
localStrings
Constructors Summary
public SunDeploymentConfiguration(javax.enterprise.deploy.model.DeployableObject deployObject)
Creates a new instance of SunDeploymentConfiguration

    
           
         
        this.deployObject = deployObject;
    
Methods Summary
public javax.enterprise.deploy.spi.DConfigBeanRootgetDConfigBeanRoot(javax.enterprise.deploy.model.DDBeanRoot dDBeanRoot)
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

        
        return null;
    
public javax.enterprise.deploy.model.DeployableObjectgetDeployableObject()
Returns an object that provides access to the deployment descriptor data and classes of a J2EE module.

return
DeployableObject

        return deployObject;
    
public javax.enterprise.deploy.spi.DeploymentManagergetDeploymentManager()

return
the deployment manager

        return deploymentManager;
    
public voidremoveDConfigBean(javax.enterprise.deploy.spi.DConfigBeanRoot dConfigBeanRoot)
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 inputStream)
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 javax.enterprise.deploy.spi.DConfigBeanRootrestoreDConfigBean(java.io.InputStream inputStream, javax.enterprise.deploy.model.DDBeanRoot dDBeanRoot)
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

        return null;
    
public voidsave(java.io.OutputStream outputStream)
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 outputStream, javax.enterprise.deploy.spi.DConfigBeanRoot dConfigBeanRoot)
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

    
public voidsetDeploymentManager(javax.enterprise.deploy.spi.DeploymentManager deploymentManager)
sets the deployment manager

        this.deploymentManager = deploymentManager;