XMBeanConstants


1   /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22  package org.jboss.mx.modelmbean;
23  
24  /**
25   * Constraint definitions for the {@link XMBean} implementation.
26   *
27   * @author  <a HREF="mailto:juha@jboss.org">Juha Lindfors</a>.
28   * @version $Revision: 37459 $
29   */
30  public interface XMBeanConstants extends ModelMBeanConstants
31  {
32  
33     // Resource Types ------------------------------------------------
34     
35     /**
36      * Resource type string identifying a resource object that implements
37      * an interface adhering to the Standard MBean naming conventions.
38      */
39     final static String   STANDARD_INTERFACE = "StandardInterface";   
40  
41  
42     final static String   STANDARD_MBEAN     = "StandardMBean";
43     
44     
45     /**
46      * Resource type string identifying a resource object that is part of
47      * a descriptor object.
48      */
49     final static String   DESCRIPTOR = "descriptor";
50  
51     
52     // Descriptor string prefixes ------------------------------------   
53     
54     /**
55      * Descriptor field naming prefix for {@link XMBean} configuration. Descriptor
56      * fields matching to this prefix follow the <tt>"xmbean.*"</tt> naming 
57      * convention in field names.
58      */
59     final static String   XMBEAN_DESCRIPTOR_PREFIX   = "xmbean.";
60  
61     /**
62      * Descriptor field naming prefix for {@link XMBean} configuration. Descriptor
63      * fields matching to this prefix follow the <tt>"xmbean.metadata.*"</tt> naming 
64      * convention in field names.
65      */
66     final static String   METADATA_DESCRIPTOR_PREFIX = XMBEAN_DESCRIPTOR_PREFIX + "metadata.";
67  
68     /**
69      * Descriptor field naming prefix for {@link XMBean} configuration. Descriptor
70      * fields matching to this prefix follow the <tt>"xmbean.resource.*"</tt> naming 
71      * convention in field names.
72      */
73     final static String   RESOURCE_DESCRIPTOR_PREFIX = XMBEAN_DESCRIPTOR_PREFIX + "resource.";
74     
75     
76     // Resource descriptor string ------------------------------------
77     
78     /**
79     * Mandatory descriptor field when {@link #DESCRIPTOR} resource type is used.
80     * The value of this field contains a reference to the resource
81     * object the Model MBean represents.   <p>
82     *
83     * This field matches to the {@link #RESOURCE_DESCRIPTOR_PREFIX} naming pattern.
84     *
85     * @see org.jboss.mx.modelmbean.XMBean
86     */
87     final static String   RESOURCE_REFERENCE         = RESOURCE_DESCRIPTOR_PREFIX + "reference";
88     
89     /**
90     * Mandatory descriptor field when {@link #DESCRIPTOR} resource type is used.
91     * The value of this field contains the actual resource type of the resource
92     * object defined by the {@link #RESOURCE_REFERENCE} field.   <p>
93     *
94     * This field matches to the {@link #RESOURCE_DESCRIPTOR_PREFIX} naming pattern.
95     *
96     * @see org.jboss.mx.modelmbean.XMBean
97     */
98     final static String   RESOURCE_TYPE              = RESOURCE_DESCRIPTOR_PREFIX + "type";
99     
100    
101    // Metadata configuration descriptor strings --------------------
102    
103    /**
104     * XML metadata descriptor field name. This descriptor field matches the
105     * {@link #METADATA_DESCRIPTOR_PREFIX} and is therefore passed as a 
106     * configuration property to all metadata builder implementations.   <p>
107     *
108     * This specific field is used in a {@link #DESCRIPTOR} resource type to
109     * configure <a HREF="http://www.jdom.org">JDOM</a> based metadata builders
110     * to override the default JAXP SAX parser settings. 
111     *
112     * @see  org.jboss.mx.modelmbean.XMBean
113     */
114    final static String   SAX_PARSER               = METADATA_DESCRIPTOR_PREFIX + "sax.parser";
115    
116    /**
117     * XML metadata descriptor field name. This descriptor field matches the
118     * {@link #METADATA_DESCRIPTOR_PREFIX} and is therefore passed as a 
119     * configuration property to all metadata builder implementations.   <p>
120     *
121     * This specific field can be used to indicate the XML based builder 
122     * implementations to validate the document instance before creating the
123     * metadata.
124     *
125     * @see  org.jboss.mx.modelmbean.XMBean
126     */    
127    final static String   XML_VALIDATION           = METADATA_DESCRIPTOR_PREFIX + "xml.validate";
128 
129    String   GET_METHOD_ATTRIBUTE     = "getMethod";
130    String   SET_METHOD_ATTRIBUTE     = "setMethod";
131 }
132
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags