public interface DConfigBean
A DConfigBean is created by calling DConfigBean.getDConfigBean(DDBean) method, where DConfigBean is the object that provided the XPath which the DDBean represents.
A DConfigBean is a JavaBean component that presents the dynamic deployment configuration information for a Jakarta EE plugin to the deployer. It is a JavaBean. The JavaBean architecture was chosen because of its versatility in providing both simple and complex components. JavaBeans also enable the development of property sheets and property editors, as well as sophisticated customization wizards.
It is expected that a plugin vendor will provide a Property Editor for any complex datatype in a DConfigBean that a deployer needs to edit through a property sheet. The Property Editor should be implemented and made available to a tool according to the guidelines defined in the JavaBeans API Specification version 1.01.
Modifier and Type | Method and Description |
---|---|
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.
|
DDBean getDDBean()
String[] getXpaths()
DConfigBean getDConfigBean(DDBean bean) throws ConfigurationException
bean
- The DDBean containing the XML data to be
evaluated.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.void removeDConfigBean(DConfigBean bean) throws BeanNotFoundException
bean
- The child DConfigBean to be removed.BeanNotFoundException
- the bean provided
is not in the child list of this bean.void notifyDDChange(XpathEvent event)
event
- an event containing a reference to the
DDBean which has changed.void addPropertyChangeListener(PropertyChangeListener pcl)
pcl
- PropertyChangeListener to addvoid removePropertyChangeListener(PropertyChangeListener pcl)
pcl
- Listener to remove.Copyright © 2019 Eclipse Foundation. All rights reserved.
Use is subject to license terms.