javax.enterprise.deploy.spi
public interface DConfigBean
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()
.The properties of DConfigBeans are displayed and edited by the deployment tool by using the JavaBean Property classes.
Method Summary | |
---|---|
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.
|
Parameters: pcl PropertyChangeListener to add
Parameters: bean The DDBean containing the XML data to be evaluated.
Returns: The DConfigBean to display the server-specific properties for the standard bean.
Throws: 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.
Returns: The bean class containing the XML text for this DConfigBean.
Returns: a list of XPath Strings representing XML data to be retrieved or
null
if there are none.
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.
Parameters: event an event containing a reference to the DDBean which has changed.
See Also: DConfigBean DConfigBean
Parameters: bean The child DConfigBean to be removed.
Throws: BeanNotFoundException the bean provided is not in the child list of this bean.
Parameters: pcl Listener to remove.