org.jboss.deployment.spi
Class DeploymentConfigurationImpl

java.lang.Object
  extended byorg.jboss.deployment.spi.DeploymentConfigurationImpl
All Implemented Interfaces:
DeploymentConfiguration (src)

public class DeploymentConfigurationImpl
extends java.lang.Object
implements DeploymentConfiguration (src)

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.


Constructor Summary
DeploymentConfigurationImpl()
           
 
Method Summary
 DConfigBeanRoot (src) getDConfigBeanRoot(DDBeanRoot (src)  bean)
          Return the top level configuration for a deployment descriptor
 DeployableObject (src) getDeployableObject()
          Return an object that provides access to the deployment descriptor
 void removeDConfigBean(DConfigBeanRoot (src)  bean)
          Remove a root configuration and all its children
 void restore(java.io.InputStream input)
          Restores a full set of configuration beans
 DConfigBeanRoot (src) restoreDConfigBean(java.io.InputStream input, DDBeanRoot (src)  bean)
          Restore a configuration from an input stream
 void save(java.io.OutputStream output)
          Saves the fulls set of configuration beans
 void saveDConfigBean(java.io.OutputStream output, DConfigBeanRoot (src)  bean)
          Save a configuration to an output stream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DeploymentConfigurationImpl

public DeploymentConfigurationImpl()
Method Detail

getDeployableObject

public DeployableObject (src)  getDeployableObject()
Return an object that provides access to the deployment descriptor

Specified by:
getDeployableObject in interface DeploymentConfiguration (src)
Returns:
the deployable object

getDConfigBeanRoot

public DConfigBeanRoot (src)  getDConfigBeanRoot(DDBeanRoot (src)  bean)
                                   throws ConfigurationException (src) 
Return the top level configuration for a deployment descriptor

Specified by:
getDConfigBeanRoot in interface DeploymentConfiguration (src)
Parameters:
bean - the root of the deployment descriptor
Returns:
the configuration
Throws:
ConfigurationException (src) - for an error in the deployment descriptor

removeDConfigBean

public void removeDConfigBean(DConfigBeanRoot (src)  bean)
                       throws BeanNotFoundException (src) 
Remove a root configuration and all its children

Specified by:
removeDConfigBean in interface DeploymentConfiguration (src)
Parameters:
bean - the configuration
Throws:
BeanNotFoundException (src) - when the bean is not found

restoreDConfigBean

public DConfigBeanRoot (src)  restoreDConfigBean(java.io.InputStream input,
                                          DDBeanRoot (src)  bean)
                                   throws ConfigurationException (src) 
Restore a configuration from an input stream

Specified by:
restoreDConfigBean in interface DeploymentConfiguration (src)
Parameters:
input - the input stream
bean - the deployment descriptor
Returns:
the configuration
Throws:
ConfigurationException (src) - when there is an error in the configuration

saveDConfigBean

public void saveDConfigBean(java.io.OutputStream output,
                            DConfigBeanRoot (src)  bean)
                     throws ConfigurationException (src) 
Save a configuration to an output stream

Specified by:
saveDConfigBean in interface DeploymentConfiguration (src)
Parameters:
output - the output stream
bean - the configuration
Throws:
ConfigurationException (src) - when there is an error in the configuration

restore

public void restore(java.io.InputStream input)
             throws ConfigurationException (src) 
Restores a full set of configuration beans

Specified by:
restore in interface DeploymentConfiguration (src)
Parameters:
input - the input stream
Throws:
ConfigurationException (src) - for an error in the configuration

save

public void save(java.io.OutputStream output)
          throws ConfigurationException (src) 
Saves the fulls set of configuration beans

Specified by:
save in interface DeploymentConfiguration (src)
Parameters:
output - the output stream
Throws:
ConfigurationException (src) - for an error in the configuration