org.glassfish.deployapi.config
Class SunDeploymentConfiguration

java.lang.Object
  org.glassfish.deployapi.config.SunDeploymentConfiguration

All Implemented Interfaces:

DeploymentConfiguration

public class SunDeploymentConfiguration
extends Object
implements 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

protected static LocalStringManagerImpl

localStrings

Constructor Summary

SunDeploymentConfiguration(DeployableObject deployObject)
Creates a new instance of SunDeploymentConfiguration

Method Summary

DConfigBeanRoot	getDConfigBeanRoot(DDBeanRoot dDBeanRoot) 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.
DeploymentManager	getDeploymentManager()
void	removeDConfigBean(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.
DConfigBeanRoot	restoreDConfigBean(InputStream inputStream, 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, DConfigBeanRoot dConfigBeanRoot) Save to disk all the configuration beans associated with a particular deployment descriptor file.
void	setDeploymentManager(DeploymentManager deploymentManager) sets the deployment manager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

localStrings

protected static final LocalStringManagerImpl localStrings

Constructor Detail

SunDeploymentConfiguration

public SunDeploymentConfiguration(DeployableObject deployObject)
                           throws ConfigurationException

Creates a new instance of SunDeploymentConfiguration

Throws:

ConfigurationException

Method Detail

getDConfigBeanRoot

public DConfigBeanRoot getDConfigBeanRoot(DDBeanRoot dDBeanRoot)
                                   throws ConfigurationException

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

Specified by:

getDConfigBeanRoot in interface 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:

ConfigurationException - reports errors in generating a configuration bean

getDeployableObject

public DeployableObject getDeployableObject()

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

Specified by:

getDeployableObject in interface DeploymentConfiguration

Returns:

DeployableObject

removeDConfigBean

public void removeDConfigBean(DConfigBeanRoot dConfigBeanRoot)
                       throws BeanNotFoundException

Remove the root DConfigBean and all its children.

Specified by:

removeDConfigBean in interface DeploymentConfiguration

Parameters:

bean - the top leve DConfigBean to remove.

Throws:

BeanNotFoundException - the bean provides is not in this beans child list.

restore

public void restore(InputStream inputStream)
             throws ConfigurationException

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

Specified by:

restore in interface DeploymentConfiguration

Parameters:

inputArchive - The input stream from which to restore the Configuration.

Throws:

ConfigurationException - reports errors in generating a configuration bean

restoreDConfigBean

public DConfigBeanRoot restoreDConfigBean(InputStream inputStream,
                                          DDBeanRoot dDBeanRoot)
                                   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.

Specified by:

restoreDConfigBean in interface 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:

ConfigurationException - reports errors in generating a configuration bean

save

public void save(OutputStream outputStream)
          throws 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 interface DeploymentConfiguration

Parameters:

outputArchive - The output stream to which to save the Configuration.

Throws:

ConfigurationException

saveDConfigBean

public void saveDConfigBean(OutputStream outputStream,
                            DConfigBeanRoot dConfigBeanRoot)
                     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.

Specified by:

saveDConfigBean in interface 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:

ConfigurationException - reports errors in generating a configuration bean

setDeploymentManager

public void setDeploymentManager(DeploymentManager deploymentManager)

sets the deployment manager

getDeploymentManager

public DeploymentManager getDeploymentManager()

Returns:

the deployment manager