DConfigBeanRoot (Java EE 5)

Java EE API

previous page next page

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.enterprise.deploy.spi Interface DConfigBeanRoot

All Superinterfaces:: DConfigBean

public interface DConfigBeanRoot
extends DConfigBean

Implements: DConfigBean

一个 J2EE 组件模块，由一个或多个部署描述符文件，以及 0 个或多个非部署描述符 XML 实例文档组成。模块必须包含一个特定于组件的部署描述符文件（有关详细信息，请参阅组件规范）。它可能包含一个或多个次要的部署描述符文件（用于定义组件的额外功能），以及 0 个或多个非部署描述符 XML 实例文档（请参阅 Web 服务规范）。

DConfigBeanRoot 对象是一个部署配置 Bean (DConfigBean)，与组件部署描述符的根关联。它必须通过调用 DeploymentConfiguration.getDConfigBean(DDBeanRoot) 方法创建，其中 DDBeanRoot 表示组件的部署描述符。

DConfigBean 对象与扩展组件功能的部署描述符关联。它必须通过调用 DConfigBeanRoot.getDConfigBean(DDBeanRoot) 方法创建。此 DConfigBean 对象是组件 DConfigBeanRoot 对象的子对象。DDBeanRoot 参数表示次级部署描述符。webservice.xml 和 webserviceclient.xml 之类的部署描述符文件是次级部署描述文件的示例。

服务器插件必须向 DDBeanRoot 对象请求它所需要的任何非部署描述符 XML 实例文档数据。插件必须调用 DeployableObject.getDDBeanRoot(String) 方法，其中 String 是从模块的根到所表示文件的完整路径名。WSDL 文件是非部署描述符 XML 实例文档的一个示例。

英文文档：

A J2EE component module consists of one or more deployment descriptor files and zero or more non-deployment descriptor XML instance documents. A module must contain a component-specific deployment descriptor file (see the component specification for details). It may contain one or more secondary deployment descriptor files that define extra functionality on the component and zero or more non-deployment descriptor XML instance documents (see the Web Services specification).

The DConfigBeanRoot object is a deployment configuration bean (DConfigBean) that is associated with the root of the component's deployment descriptor. It must be created by calling the DeploymentConfiguration.getDConfigBean(DDBeanRoot) method, where DDBeanRoot represents the component's deployment descriptor.

A DConfigBean object is associated with a deployment descriptor that extends a component's functionality. It must be created by calling the DConfigBeanRoot.getDConfigBean(DDBeanRoot) method. This DConfigBean object is a child of the compontent's DConfigBeanRoot object. The DDBeanRoot argument represents the secondary deployment descriptor. Deployment descriptor files such as webservice.xml and webserviceclient.xml are examples of secondary deployment descriptor files.

The server plugin must request a DDBeanRoot object for any non-deployment descriptor XML instance document data it requires. The plugin must call method DeployableObject.getDDBeanRoot(String) where String is the full path name from the root of the module to the file to be represented. A WSDL file is an example of a non-deployment descriptor XML instance document.

Author:: gfink

Method Summary
`DConfigBean`	`getDConfigBean(DDBeanRoot ddBeanRoot)` Return a DConfigBean for a deployment descriptor that is not the module's primary deployment descriptor.

Methods inherited from interface javax.enterprise.deploy.spi.DConfigBean
`addPropertyChangeListener, getDConfigBean, getDDBean, getXpaths, notifyDDChange, removeDConfigBean, removePropertyChangeListener`

Method Detail

public DConfigBean getDConfigBean(DDBeanRoot ddBeanRoot)
返回部署描述符的 DConfigBean，此部署描述符不是模块的主部署描述符。除了模块的主部署描述符之外，Web 服务还提供其他部署描述符。只有这种次要部署描述符的 DDBeanRoot 才作为参数传递给此方法。 Web 服务有两个部署描述符文件：一个用于定义 Web 服务；另一个用于定义 Web 服务的客户端。有关详细信息，请参阅 Web 服务规范。

ddBeanRoot 表示部署描述符文件的根元素。

return 用于处理此部署描述符数据的 DConfigBean。如果此部署描述符不需要 DConfigBean，则返回 null。

英文文档：
getDConfigBean

DConfigBean getDConfigBean(DDBeanRoot ddBeanRoot)

Return a DConfigBean for a deployment descriptor that is not the module's primary deployment descriptor. Web services provides a deployment descriptor in addition to the module's primary deployment descriptor. Only the DDBeanRoot for this catagory of secondary deployment descriptors are to be passed as arguments through this method. Web service has two deployment descriptor files, one that defines the web service and one that defines a client of a web service. See the Web Service specificiation for the details.

Parameters:: ddBeanRoot - represents the root element of a deployment descriptor file.
Returns:: a DConfigBean to be used for processing this deployment descriptor data. Null may be returned if no DConfigBean is required for this deployment descriptor.