DConfigBean

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.DConfigBean

SOURCE |

Download javax.enterprise.deploy.spi.DConfigBean

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.enterprise.deploy.spi
Interface DConfigBean

All Known Subinterfaces:: DConfigBeanRoot

public interface DConfigBean

The interface for configuring a server-specific deployment descriptor, or subset of same. A DConfigBean corresponds to a specific location in a standard deployment descriptor, typically where values (such as names and roles) are used.

There are three different ways that DConfigBeans are created:

DeploymentConfigurator.getDConfigBean(DDBeanRoot) is called by the deployment tool to create a DConfigBeanRoot for each deployment descriptor in the J2EE application.
DConfigBean.getDConfigBean(DDBean) is called by the deployment tool for each DDBean that corresponds to a relative XPath pattern given to the deployment tool by the method DConfigBean.getXpaths().
Each DConfigBean can structure its configurations as a tree-structure of DConfigBeans; a DConfigBean can have properties of type DConfigBean or DConfigBean[].

The properties of DConfigBeans are displayed and edited by the deployment tool by using the JavaBean Property classes.

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

Method Summary

void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
          Register a property listener for this bean.

DConfigBean getDConfigBean(javax.enterprise.deploy.model.DDBean bean)
          Return the JavaBean containing the server-specific deployment configuration information based upon the XML data provided by the DDBean.

javax.enterprise.deploy.model.DDBean getDDBean()
          Return the JavaBean containing the deployment descriptor XML text associated with this DConfigBean.

java.lang.String[] getXpaths()
          Return a list of XPaths designating the deployment descriptor information this DConfigBean requires.

void notifyDDChange(javax.enterprise.deploy.model.XpathEvent event)
          A notification that the DDBean provided in the event has changed and this bean or its child beans need to reevaluate themselves.

void removeDConfigBean(DConfigBean bean)
          Remove a child DConfigBean from this bean.

void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
          Unregister a property listener for this bean.

Method Detail

getDDBean

public javax.enterprise.deploy.model.DDBean getDDBean()

Return the JavaBean containing the deployment descriptor XML text associated with this DConfigBean.

getXpaths

public java.lang.String[] getXpaths()

Return a list of XPaths designating the deployment descriptor information this DConfigBean requires. Each server vendor may need to specify different server-specific information. Each String returned by this method is an XPath describing a certain portion of the standard deployment descriptor for which there is corresponding server-specific configuration.

getDConfigBean

public DConfigBean getDConfigBean(javax.enterprise.deploy.model.DDBean bean)
                           throws javax.enterprise.deploy.spi.exceptions.ConfigurationException

Return the JavaBean containing the server-specific deployment configuration information based upon the XML data provided by the DDBean.

removeDConfigBean

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

Remove a child DConfigBean from this bean.

notifyDDChange

public void notifyDDChange(javax.enterprise.deploy.model.XpathEvent event)

A notification that the DDBean provided in the event has changed and this bean or its child beans need to reevaluate themselves.

It is advisable, though not declared explicitly in the specification, for a DConfigBean to receive change events for itself, and add or remove events for its direct children. The DConfigBean implementation should not add or remove beans here if it will add or remove those beans again in response to a call to getDConfigBean or removeDConfigBean.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)

Unregister a property listener for this bean.