javax.enterprise.deploy.spi

Interface DConfigBean

Contents
  • All Known Subinterfaces:
    DConfigBeanRoot

    public interface DConfigBean
    The DConfigBean is a deployment configuration bean (DConfigBean) that is associated with one or more deployment descriptor beans, (DDBean). A DConfigBean represents a logical grouping of deployment configuration data to be presented to the Deployer. A DConfigBean provides zero or more XPaths that identifies the XML information it requires. A DConfigBean may contain other DConfigBeans and regular JavaBeans. The top most DConfigBean is a DConfigBeanRoot object which represents a single XML instance document.

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

    • Method Detail

      • getDDBean

        DDBean getDDBean()
        Return the JavaBean containing the deployment descriptor XML text associated with this DConfigBean.
        Returns:
        The bean class containing the XML text for this DConfigBean.

      • getXpaths

        String[] getXpaths()
        Return a list of XPaths designating the deployment descriptor information this DConfigBean requires. A given server vendor will need to specify some 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.
        Returns:
        a list of XPath Strings representing XML data to be retrieved or 'null' if there are none.

      • getDConfigBean

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

      • removeDConfigBean

        void removeDConfigBean(DConfigBean bean)
                throws BeanNotFoundException
        Remove a child DConfigBean from this bean.
        Parameters:
        bean - The child DConfigBean to be removed.
        Throws:
        BeanNotFoundException - the bean provided is not in the child list of this bean.

      • notifyDDChange

        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.
        Parameters:
        event - an event containing a reference to the DDBean which has changed.

      • addPropertyChangeListener

        void addPropertyChangeListener(PropertyChangeListener pcl)
        Register a property listener for this bean.
        Parameters:
        pcl - PropertyChangeListener to add

      • removePropertyChangeListener

        void removePropertyChangeListener(PropertyChangeListener pcl)
        Unregister a property listener for this bean.
        Parameters:
        pcl - Listener to remove.

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/enterprise/deploy/spi/DConfigBean.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, DConfigBean (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.