DeploymentConfiguration

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> javax >> enterprise >> deploy >> [ spi overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of javax.enterprise.deploy.spi.DeploymentConfiguration

SOURCE |

Download javax.enterprise.deploy.spi.DeploymentConfiguration

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.enterprise.deploy.spi
Interface DeploymentConfiguration

public interface DeploymentConfiguration

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.

Version:: $Rev: 46019 $ $Date: 2004-09-14 02:56:06 -0700 (Tue, 14 Sep 2004) $

Method Summary

DConfigBeanRoot getDConfigBeanRoot(javax.enterprise.deploy.model.DDBeanRoot bean)
          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.

void removeDConfigBean(DConfigBeanRoot bean)
          Remove the root DConfigBean and all its children.

void restore(java.io.InputStream inputArchive)
          Restore from disk to a full set of configuration beans previously stored.

DConfigBeanRoot restoreDConfigBean(java.io.InputStream inputArchive, javax.enterprise.deploy.model.DDBeanRoot bean)
          Restore from disk to instantated objects all the DConfigBeans associated with a specific deployment descriptor.

void save(java.io.OutputStream outputArchive)
          Save to disk the current set configuration beans created for this deployable module.

void saveDConfigBean(java.io.OutputStream outputArchive, DConfigBeanRoot bean)
          Save to disk all the configuration beans associated with a particular deployment descriptor file.

Method Detail

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.

getDConfigBeanRoot

public DConfigBeanRoot getDConfigBeanRoot(javax.enterprise.deploy.model.DDBeanRoot bean)
                                   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.

removeDConfigBean

public void removeDConfigBean(DConfigBeanRoot bean)
                       throws javax.enterprise.deploy.spi.exceptions.BeanNotFoundException

Remove the root DConfigBean and all its children.

restoreDConfigBean

public DConfigBeanRoot restoreDConfigBean(java.io.InputStream inputArchive,
                                          javax.enterprise.deploy.model.DDBeanRoot bean)
                                   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.

saveDConfigBean

public void saveDConfigBean(java.io.OutputStream outputArchive,
                            DConfigBeanRoot bean)
                     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.

restore

public void restore(java.io.InputStream inputArchive)
             throws javax.enterprise.deploy.spi.exceptions.ConfigurationException

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

save

public void save(java.io.OutputStream outputArchive)
          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.