JBoss30DConfigBean


1   package org.jboss.enterprise.deploy.spi;
2   
3   import java.beans.PropertyChangeListener  ;
4   import javax.enterprise.deploy.model.*;
5   import javax.enterprise.deploy.spi.DConfigBean  ;
6   import javax.enterprise.deploy.spi.exceptions.BeanNotFoundException  ;
7   import javax.enterprise.deploy.spi.exceptions.ConfigurationException  ;
8   
9   /**
10   * The interface for configuring a server-specific deployment descriptor, or subset of same. A DConfigBean corresponds to a specific location in a standard
11   * deployment descriptor, typically where values (such as names and roles) are used. <p>
12   *
13   * There are three different ways that DConfigBeans are created:
14   * <ul>
15   *   <LI> <CODE>DeploymentConfigurator.getDConfigBean(DDBeanRoot)</CODE> is called by the deployment tool to create a DConfigBeanRoot for each deployment
16   *   descriptor in the J2EE application. </li>
17   *   <li> <CODE>DConfigBean.getDConfigBean(DDBean)</CODE> is called by the deployment tool for each DDBean that corresponds to a relative XPath pattern given to
18   *   the deployment tool by the method <CODE>DConfigBean.getXpaths().</CODE> </li>
19   *   <li> Each DConfigBean can structure its configurations as a tree-structure of DConfigBeans; a DConfigBean can have properties of type DConfigBean or
20   *   DConfigBean[]. </li>
21   * </ul>
22   * <p>
23   *
24   * The properties of DConfigBeans are displayed and edited by the deployment tool by using the JavaBean Property classes.
25   *
26   * @author    letiembl
27   * @created   15 avril 2002
28   */
29  public class JBoss30DConfigBean implements DConfigBean  
30  {
31  
32     /**
33      * Register a property listener for this bean.
34      *
35      * @param pcl  PropertyChangeListener to add
36      */
37     public void addPropertyChangeListener(PropertyChangeListener   pcl) { }
38  
39  
40     /**
41      * Return the JavaBean containing the server-specific deployment configuration information based upon the XML data provided by the DDBean.
42      *
43      * @param bean                     The DDBean containing the XML data to be evaluated.
44      * @return                         The DConfigBean to display the server-specific properties for the standard bean.
45      * @throws ConfigurationException  reports errors in generating a configuration bean. This DDBean is considered undeployable to this server until this
46      *      exception is resolved. A suitably descriptive message is required so the user can diagnose the error.
47      */
48     public DConfigBean   getDConfigBean(DDBean bean) throws ConfigurationException  
49     {
50        return null;
51     }
52  
53  
54     /**
55      * Return the JavaBean containing the deployment descriptor XML text associated with this DConfigBean.
56      *
57      * @return   The bean class containing the XML text for this DConfigBean.
58      */
59     public DDBean getDDBean()
60     {
61        return null;
62     }
63  
64  
65     /**
66      * Return a list of XPaths designating the deployment descriptor information this DConfigBean requires. A given server vendor will need to specify some
67      * server-specific information. Each String returned by this method is an XPath describing a certain portion of the standard deployment descriptor for which
68      * there is corresponding server-specific configuration.
69      *
70      * @return   a list of XPath Strings representing XML data to be retrieved or 'null' if there are none.
71      */
72     public String  [] getXpaths()
73     {
74        return null;
75     }
76  
77  
78     /**
79      * A notification that the DDBean provided in the event has changed and this bean or its child beans need to reevaluate themselves.
80      *
81      * @param event  an event containing a reference to the DDBean which has changed.
82      */
83     public void notifyDDChange(XpathEvent event) { }
84  
85  
86     /**
87      * Remove a child DConfigBean from this bean.
88      *
89      * @param bean                    The child DConfigBean to be removed.
90      * @throws BeanNotFoundException  the bean provided is not in the child list of this bean.
91      */
92     public void removeDConfigBean(DConfigBean   bean) throws BeanNotFoundException   { }
93  
94  
95     /**
96      * Unregister a property listener for this bean.
97      *
98      * @param pcl  Listener to remove.
99      */
100    public void removePropertyChangeListener(PropertyChangeListener   pcl) { }
101 }
102 
103
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags