Added
Link Here
|
1 |
<?xml version='1.0' encoding='UTF-8' ?> |
2 |
|
3 |
<!-- A skeleton JBoss MBean service descriptor DTD. This cannot be used in |
4 |
general to validate a jboss-service.xml descriptor due to the fact that the |
5 |
'attribute' element allows ANY content. |
6 |
|
7 |
$Id: jboss-service_4_0.dtd,v 1.1.2.1 2007/03/26 09:55:00 lkotouc Exp $ |
8 |
|
9 |
DOCTYPE server |
10 |
PUBLIC "-//JBoss//DTD MBean Service 4.0//EN" |
11 |
"http://www.jboss.org/j2ee/dtd/jboss-service_4_0.dtd" |
12 |
--> |
13 |
<!-- The server element is the root element. |
14 |
--> |
15 |
<!ELEMENT server (loader-repository? , local-directory* , classpath* , mbean*)> |
16 |
|
17 |
<!-- The loader-repository specifies the name of the UnifiedLoaderRepository |
18 |
MBean to use for the ear to provide ear level scoping of classes deployed |
19 |
in the ear. It is a unique JMX ObjectName string. It may also specify |
20 |
an arbitrary configuration by including a loader-repository-config element. |
21 |
|
22 |
Examples: |
23 |
<loader-repository>jboss.test:loader=cts-cmp2v1-sar.ear</loader-repository> |
24 |
|
25 |
<loader-repository loaderRepositoryClass='dot.com.LoaderRepository'> |
26 |
dot.com:loader=unique-archive-name |
27 |
<loader-repository-config configParserClass='dot.com.LoaderParser'> |
28 |
java2ParentDelegaton=true |
29 |
</loader-repository-config> |
30 |
</loader-repository> |
31 |
--> |
32 |
<!ELEMENT loader-repository (#PCDATA | loader-repository-config)*> |
33 |
|
34 |
<!-- The loaderRepositoryClass attribute gives the classname of the |
35 |
org.jboss.mx.loading.LoaderRepository implementation. |
36 |
--> |
37 |
<!ATTLIST loader-repository loaderRepositoryClass CDATA #IMPLIED> |
38 |
|
39 |
<!-- The loader-repository-config element specifies any arbitrary configuration |
40 |
fragment for use in configuring the loader-repository instance. The actual |
41 |
content of this element is specific to the loaderRepositoryClass and the |
42 |
code parsing the element. |
43 |
--> |
44 |
<!ELEMENT loader-repository-config (#PCDATA)> |
45 |
|
46 |
<!-- The configParserClass attribute gives the classname of the |
47 |
org.jboss.mx.loading.LoaderRepositoryFactory.LoaderRepositoryConfigParser |
48 |
implementation to use to parse the loader-repository-config content. |
49 |
--> |
50 |
<!ATTLIST loader-repository-config configParserClass CDATA #IMPLIED> |
51 |
|
52 |
<!-- A local-directory element specifies that portions of the sar are to be unjard into the data |
53 |
directory of the server configuration. |
54 |
--> |
55 |
<!ELEMENT local-directory EMPTY> |
56 |
|
57 |
<!-- The optional path attribute gives the prefix of the sar entries that should be copied |
58 |
into the data directory. If it is not specified the entire sar contents will be placed into |
59 |
the data directory. |
60 |
--> |
61 |
<!ATTLIST local-directory path CDATA #IMPLIED> |
62 |
|
63 |
<!-- A classpath element specifies a location which will be included in the services |
64 |
deployment classpath. |
65 |
--> |
66 |
<!ELEMENT classpath EMPTY> |
67 |
|
68 |
<!-- The codebase attribute specifies the base URL from which the jars or classes |
69 |
are loaded from. If the codebase is '.' then it is equal to the mbean deployment URL. |
70 |
Otherwise, it is resolved as a path spec relative to the serverHomeURL (e.g., file:/jboss-3.2.0) |
71 |
using the URL ctor URL(serverHomeURL, codebase) |
72 |
|
73 |
Examples: |
74 |
|
75 |
<classpath codebase='.' archives='util.jar' /> |
76 |
<classpath codebase='http://classloader.dot.com' archives='*' /> |
77 |
<classpath codebase="lib" archives="*"/> |
78 |
--> |
79 |
<!ATTLIST classpath codebase CDATA #REQUIRED> |
80 |
|
81 |
<!-- The archives attribute specifies either the '*' wildcard to indicate all contents of the |
82 |
codebase should be included, or a comma seperated list of the jars to include. |
83 |
--> |
84 |
<!ATTLIST classpath archives CDATA #IMPLIED> |
85 |
|
86 |
<!-- The mbean element defines a JBoss MBean service. This includes the |
87 |
mbean class, attributes and dependencies. |
88 |
--> |
89 |
<!ELEMENT mbean (constructor? , xmbean? , attribute* , depends* , depends-list*)> |
90 |
|
91 |
<!-- The code attributes gives the fully qualified name of the MBean |
92 |
implementation class. |
93 |
--> |
94 |
<!ATTLIST mbean code CDATA #REQUIRED> |
95 |
|
96 |
<!-- The name attribute gives the JMX ObjectName string to use when registering |
97 |
the MBean. This must be a unique and valid JMX name. |
98 |
--> |
99 |
<!ATTLIST mbean name CDATA #REQUIRED> |
100 |
|
101 |
<!-- The optional interface attribute gives the full qualified name of the class |
102 |
uses to construct the management interface of the mbean. In absence of it an interface |
103 |
with the name ending by MBean will be looked in the implementation class. When used |
104 |
this interface is defined explicitely. |
105 |
--> |
106 |
<!ATTLIST mbean interface CDATA #IMPLIED> |
107 |
|
108 |
<!-- The xmbean-dd attribute defines the path to the JBoss XMBean descriptor. This |
109 |
is an xml document conforming to: |
110 |
|
111 |
<!DOCTYPE mbean PUBLIC |
112 |
"-//JBoss//DTD JBOSS XMBEAN 1.0//EN" |
113 |
"http://www.jboss.org/j2ee/dtd/jboss_xmbean_1_0.dtd"> |
114 |
|
115 |
If the descriptor is embedded via a nested xmbean element, the xmbean-dd attribute |
116 |
must be given as an empty string. |
117 |
|
118 |
Example: |
119 |
<mbean code="org.jboss.test.jmx.xmbean.User" |
120 |
name="jboss.test:service=xmbean-user" |
121 |
xmbean-dd="META-INF/org/jboss/test/jmx/xmbean/User.xml" /> |
122 |
--> |
123 |
<!ATTLIST mbean xmbean-dd CDATA #IMPLIED> |
124 |
|
125 |
<!-- The optional xmbean-code attribute specifies the ModelMBean implementation class |
126 |
to use. This defaults to org.jboss.mx.modelmbean.XMBean. |
127 |
--> |
128 |
<!ATTLIST mbean xmbean-code CDATA #IMPLIED> |
129 |
|
130 |
<!-- The xmbean element specifies a nested JBoss XMBean descriptor fragment. Its |
131 |
supported content model is the same as the mbean element of the jboss_xmbean_1_0.dtd |
132 |
|
133 |
Example: |
134 |
<mbean code="org.jboss.test.jmx.xmbean.User" |
135 |
name="jboss.test:service=xmbean-user" |
136 |
xmbean-dd=""> |
137 |
<xmbean> |
138 |
... |
139 |
</xmbean> |
140 |
</mbean> |
141 |
--> |
142 |
<!ELEMENT xmbean ANY> |
143 |
|
144 |
<!-- The constructor element defines a non-default constructor to use when |
145 |
instantiating the mbean. |
146 |
--> |
147 |
<!ELEMENT constructor (arg*)> |
148 |
|
149 |
<!-- The arg element specify the constructor arguments in the order of the |
150 |
ctor signature. Each arg has a type and value attribute. |
151 |
--> |
152 |
<!ELEMENT arg EMPTY> |
153 |
|
154 |
<!-- The type attribute gives the type of the argument as defined in the |
155 |
ctor signature. If not defined java.lang.String is assumed. |
156 |
--> |
157 |
<!ATTLIST arg type CDATA #IMPLIED> |
158 |
|
159 |
<!-- The value attribute provides the string representation of the ctor |
160 |
argument. It is converted from a string to type using Java PropertyEditor or a |
161 |
ctor taking a single string as its argument. |
162 |
--> |
163 |
<!ATTLIST arg value CDATA #REQUIRED> |
164 |
|
165 |
<!-- The attribute element specifies the initial value for a management attribute of |
166 |
the enclosing mbean. Typically the value of the attribute element is the string |
167 |
representation of the attribute, but it can be an arbitrary xml fragment that is |
168 |
parsed by the mbean. |
169 |
--> |
170 |
<!ELEMENT attribute ANY> |
171 |
|
172 |
<!-- The required name attribute gives the name of the attribute. This is the |
173 |
name exposed by the mbean to the MBeanServer for the attribute. |
174 |
--> |
175 |
<!ATTLIST attribute name CDATA #REQUIRED> |
176 |
|
177 |
<!-- The optional replace attribute indicates whether references of the form ${x} |
178 |
in the attribute element content should be replaced with the corresponding |
179 |
System.getProperty(x) value. |
180 |
--> |
181 |
<!ATTLIST attribute replace (true | false) 'true'> |
182 |
<!-- The optional trim attribute specifies whether the attribute element content should |
183 |
be trimmed of whitespace. |
184 |
--> |
185 |
<!ATTLIST attribute trim (true | false) 'true'> |
186 |
|
187 |
<!-- The attributeClass attribute specifies that type of object that |
188 |
should be created. This is needed for non-concreate attribute types |
189 |
like interfaces and abstract classes. |
190 |
--> |
191 |
<!ATTLIST attribute attributeClass CDATA #IMPLIED> |
192 |
|
193 |
<!-- The serialDataType defines the how the content of the attribute |
194 |
element is interpretted by the ServiceConfigurator. The possible values |
195 |
are: |
196 |
+ text: the content is treated as the string representation of the |
197 |
attribute value. It will be mapped to the attribute using the PropertyEditor |
198 |
registered for the attribute type. |
199 |
+ javaBean: the content is a collection of property elements. |
200 |
+ jbxb: the content is an xml element from a namespace with an associated |
201 |
xml schema that can be unmarshalled using the JBossXB framework. |
202 |
--> |
203 |
<!ATTLIST attribute serialDataType (text | javaBean | jbxb) 'text'> |
204 |
|
205 |
<!-- The property element is used to describe the JavaBean properties of |
206 |
an attribute when the attribute element serialDataType is javaBean. |
207 |
--> |
208 |
<!ELEMENT property (#PCDATA)> |
209 |
<!-- The required name attribute gives the name of the property. This is the |
210 |
name of a JavaBean property for the attribute type. |
211 |
--> |
212 |
<!ATTLIST property name CDATA #REQUIRED> |
213 |
|
214 |
<!-- The depends element specifies a JMX ObjectName string for an mbean |
215 |
on which the enclosing mbean depends. |
216 |
|
217 |
Example: |
218 |
<mbean code="myBean" name="domain:name=x"> |
219 |
<depends optional-attribute-name="yName">domain:name=y</depends> |
220 |
</mbean> |
221 |
|
222 |
<mbean code="myBean" name="domain:name=x"> |
223 |
<depends optional-attribute-name="anonName"> |
224 |
<mbean code="nestedBean" name="domain:name=x.y"> |
225 |
... |
226 |
</mbean> |
227 |
</depends> |
228 |
</mbean> |
229 |
--> |
230 |
<!ELEMENT depends (#PCDATA | mbean)*> |
231 |
|
232 |
<!-- The optional-attribute-name attribute specifies the attribute name |
233 |
which should be populated with the JMX ObjectName of the depends element. |
234 |
This allows an mbean to have access to the name of the mbean on which |
235 |
it depends. |
236 |
--> |
237 |
<!ATTLIST depends optional-attribute-name CDATA #IMPLIED> |
238 |
|
239 |
<!-- The proxy-type attribute specifies the interface name |
240 |
that should be exposed on an MBeanProxy pointing at the dependent |
241 |
MBean, specified by the JMX ObjectName. |
242 |
|
243 |
The special value proxy-type="attribute" will use the |
244 |
class declared in the MBeanAttributeInfo as the interface |
245 |
for the MBeanProxy. |
246 |
|
247 |
Example: |
248 |
<mbean code="org.jboss.example.Helper" name="domain:name=helper"/> |
249 |
|
250 |
<mbean code="myBean" name="domain:name=x"> |
251 |
<depends optional-attribute-name="Helper" |
252 |
proxy-type="org.jboss.example.HelperMBean" |
253 |
>domain:name=helper</depends> |
254 |
</mbean> |
255 |
|
256 |
<mbean code="myBean" name="domain:name=x"> |
257 |
<depends optional-attribute-name="Helper" |
258 |
proxy-type="attribute" |
259 |
>domain:name=helper</depends> |
260 |
</mbean> |
261 |
--> |
262 |
<!ATTLIST depends proxy-type CDATA #IMPLIED> |
263 |
|
264 |
<!-- The depends-list element specifies a series of JMX ObjectName |
265 |
strings of mbeans on which the enclosing mbean depends. |
266 |
|
267 |
Example: |
268 |
<mbean code="myBean" name="domain:name=x"> |
269 |
<depends-list optional-attribute-name="myObjectNameList"> |
270 |
<depends-list-element>domain:name=y</depends-list-element> |
271 |
<depends-list-element>domain:name=z</depends-list-element> |
272 |
</depends-list> |
273 |
</mbean> |
274 |
--> |
275 |
<!ELEMENT depends-list (depends-list-element)+> |
276 |
|
277 |
<!-- The optional-attribute-name attribute specifies the attribute name |
278 |
which should be populated with a java.util.List that contains the JMX |
279 |
ObjectName(s) of the depends-list elements. This allows an mbean to have |
280 |
access to the names of the mbeans on which it depends. |
281 |
--> |
282 |
<!ATTLIST depends-list optional-attribute-name CDATA #IMPLIED> |
283 |
|
284 |
<!-- The depends-list-element element specifies a JMX ObjectName string |
285 |
for an mbean on which the enclosing mbean depends. |
286 |
--> |
287 |
<!ELEMENT depends-list-element (#PCDATA | mbean)*> |