Interface DeploymentConfiguration

Method Detail

• getDeployableObject

  DeployableObject getDeployableObject()

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

  Returns:

  DeployableObject

• getDConfigBeanRoot

  DConfigBeanRoot getDConfigBeanRoot(DDBeanRoot bean)
                              throws ConfigurationException

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

  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

• removeDConfigBean

  void removeDConfigBean(DConfigBeanRoot bean)
                  throws BeanNotFoundException

  Remove the root DConfigBean and all its children.

  Parameters:

  bean - the top leve DConfigBean to remove.

  Throws:

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

• restoreDConfigBean

  DConfigBeanRoot restoreDConfigBean(InputStream inputArchive,
                                     DDBeanRoot bean)
                              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.

  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

• saveDConfigBean

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

  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

• restore

  void restore(InputStream inputArchive)
        throws ConfigurationException

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

  Parameters:

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

  Throws:

  ConfigurationException - reports errors in generating a configuration bean

• save

  void save(OutputStream outputArchive)
     throws ConfigurationException

  Save to disk the current set configuration beans created for this deployable module. It is recommended the file format be XML.

  Parameters:

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

  Throws:

  ConfigurationException