javax.enterprise.deploy.spi
Interface DConfigBean
- 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[].
void | addPropertyChangeListener(PropertyChangeListener pcl) - Register a property listener for this bean.
|
DConfigBean | getDConfigBean(DDBean bean) - Return the JavaBean containing the server-specific deployment configuration
information based upon the XML data provided by the DDBean.
|
DDBean | getDDBean() - Return the JavaBean containing the deployment descriptor XML text associated with this DConfigBean.
|
String[] | getXpaths() - Return a list of XPaths designating the deployment descriptor information this
DConfigBean requires.
|
void | notifyDDChange(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(PropertyChangeListener pcl) - Unregister a property listener for this bean.
|
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener pcl)
Register a property listener for this bean.
pcl
- PropertyChangeListener to add
getDConfigBean
public DConfigBean getDConfigBean(DDBean bean)
throws ConfigurationException
Return the JavaBean containing the server-specific deployment configuration
information based upon the XML data provided by the DDBean.
bean
- The DDBean containing the XML data to be evaluated.
- The DConfigBean to display the server-specific properties for the standard bean.
ConfigurationException
- reports errors in generating a configuration bean.
This DDBean is considered undeployable to this server until this exception is
resolved. A suitably descriptive message is required so the user can diagnose
the error.
getDDBean
public DDBean getDDBean()
Return the JavaBean containing the deployment descriptor XML text associated with this DConfigBean.
- The bean class containing the XML text for this DConfigBean.
getXpaths
public 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.
- a list of XPath Strings representing XML data to be retrieved or
null
if there are none.
notifyDDChange
public void notifyDDChange(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.
event
- an event containing a reference to the DDBean which has changed.
removeDConfigBean
public void removeDConfigBean(DConfigBean bean)
throws BeanNotFoundException
Remove a child DConfigBean from this bean.
bean
- The child DConfigBean to be removed.
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener pcl)
Unregister a property listener for this bean.
pcl
- Listener to remove.