DeploymentConfiguration (Java EE 5)

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:

0.1

Author:

gfink

public DeployableObject getDeployableObject()
返回可以访问部署描述符数据和 J2EE 模块类的对象。

return

DeployableObject。

英文文档：

getDeployableObject

DeployableObject getDeployableObject()

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

Returns:

DeployableObject

public DConfigBeanRoot getDConfigBeanRoot(DDBeanRoot bean) throws ConfigurationException
返回顶层配置 Bean DConfigBeanRoot，它与指定 DDBeanRoot Bean 表示的部署描述符关联。

bean	表示关联部署描述符的顶级 Bean。
return	用于编辑模块所需的特定于服务器的属性的 DConfigBeanRoot。
Throws	ConfigurationException: 报告生成配置 Bean 时的错误

英文文档：

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

public void removeDConfigBean(DConfigBeanRoot bean) throws BeanNotFoundException
移除根 DConfigBean 及其所有子 Bean。

bean	要移除的顶级 DConfigBean。
Throws	BeanNotFoundException: 提供的 Bean 不在此 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.

public DConfigBeanRoot restoreDConfigBean(java.io.InputStream inputArchive, DDBeanRoot bean) throws ConfigurationException
从磁盘恢复初始化对象，即所有与特定部署描述符关联的 DConfigBean。这些 Bean 可能是完全或部分配置的。

inputArchive	应该从中恢复 DConfigBean 的文件的输入流。
bean	与部署描述符文件关联的 DDBeanRoot Bean。
return	最顶层的父配置 Bean DConfigBeanRoot。
Throws	ConfigurationException: 报告生成配置 Bean 时的错误

英文文档：

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

public void saveDConfigBean(java.io.OutputStream outputArchive, DConfigBeanRoot bean) throws ConfigurationException
将所有与特定部署描述符文件关联的配置 Bean 保存到磁盘。保存的数据可能是完全或部分配置的 DConfigBean。建议输出文件的格式为 XML。

outputArchive	要向其中保存 DConfigBean 的输出流。
bean	顶级 Bean DConfigBeanRoot，保存其中的 Bean。
Throws	ConfigurationException: 报告生成配置 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

public void restore(java.io.InputStream inputArchive) throws ConfigurationException
从磁盘恢复一个以前存储的完整配置 Bean 集合。

inputArchive	从中恢复配置的输入流。
Throws	ConfigurationException: 报告生成配置 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

public void save(java.io.OutputStream outputArchive) throws ConfigurationException
将为此可部署模块创建的当前配置 Bean 集合保存到磁盘。建议使用 XML 文件格式。

outputArchive	要向其中保存配置的输出流。
Throws	ConfigurationException:

英文文档：

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

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.