glassfish 0.1.1-universal-java-1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (135) hide show
  1. data/COPYRIGHT +33 -0
  2. data/LICENSE.txt +263 -0
  3. data/README +12 -0
  4. data/bin/asadmin +7 -0
  5. data/bin/asadmin.bat +8 -0
  6. data/bin/glassfish_rails +40 -0
  7. data/config/asadminenv.conf +6 -0
  8. data/config/asenv.bat +28 -0
  9. data/config/asenv.conf +27 -0
  10. data/config/glassfish.container +4 -0
  11. data/domains/domain1/config/admin-keyfile +3 -0
  12. data/domains/domain1/config/cacerts.jks +0 -0
  13. data/domains/domain1/config/default-web.xml +906 -0
  14. data/domains/domain1/config/domain-passwords +0 -0
  15. data/domains/domain1/config/domain.xml +208 -0
  16. data/domains/domain1/config/keyfile +6 -0
  17. data/domains/domain1/config/keystore.jks +0 -0
  18. data/domains/domain1/config/logging.properties +82 -0
  19. data/domains/domain1/config/login.conf +18 -0
  20. data/domains/domain1/config/server.policy +160 -0
  21. data/domains/domain1/config/sun-acc.xml +40 -0
  22. data/domains/domain1/config/wss-server-config-1.0.xml +86 -0
  23. data/domains/domain1/config/wss-server-config-2.0.xml +94 -0
  24. data/domains/domain1/docroot/favicon.gif +0 -0
  25. data/domains/domain1/docroot/index.html +87 -0
  26. data/domains/domain1/master-password +0 -0
  27. data/lib/appclient/appclientlogin.conf +10 -0
  28. data/lib/appclient/client.policy +79 -0
  29. data/lib/appclient/wss-client-config-1.0.xml +84 -0
  30. data/lib/appclient/wss-client-config-2.0.xml +96 -0
  31. data/lib/dtds/application-client_1_2.dtd +292 -0
  32. data/lib/dtds/application-client_1_3.dtd +506 -0
  33. data/lib/dtds/application_1_2.dtd +197 -0
  34. data/lib/dtds/application_1_3.dtd +312 -0
  35. data/lib/dtds/connector_1_0.dtd +561 -0
  36. data/lib/dtds/ejb-jar_1_1.dtd +894 -0
  37. data/lib/dtds/ejb-jar_2_0.dtd +1671 -0
  38. data/lib/dtds/sun-application-client-container_1_0.dtd +123 -0
  39. data/lib/dtds/sun-application-client-container_1_1.dtd +264 -0
  40. data/lib/dtds/sun-application-client-container_1_2.dtd +267 -0
  41. data/lib/dtds/sun-application-client_1_3-0.dtd +57 -0
  42. data/lib/dtds/sun-application-client_1_4-0.dtd +182 -0
  43. data/lib/dtds/sun-application-client_1_4-1.dtd +431 -0
  44. data/lib/dtds/sun-application-client_5_0-0.dtd +495 -0
  45. data/lib/dtds/sun-application_1_3-0.dtd +30 -0
  46. data/lib/dtds/sun-application_1_4-0.dtd +44 -0
  47. data/lib/dtds/sun-application_5_0-0.dtd +51 -0
  48. data/lib/dtds/sun-cmp-mapping_1_0.dtd +100 -0
  49. data/lib/dtds/sun-cmp-mapping_1_1.dtd +99 -0
  50. data/lib/dtds/sun-cmp-mapping_1_2.dtd +106 -0
  51. data/lib/dtds/sun-connector_1_0-0.dtd +66 -0
  52. data/lib/dtds/sun-connector_1_5-0.dtd +62 -0
  53. data/lib/dtds/sun-domain_1_0.dtd +2007 -0
  54. data/lib/dtds/sun-domain_1_1.dtd +3080 -0
  55. data/lib/dtds/sun-domain_1_2.dtd +3697 -0
  56. data/lib/dtds/sun-domain_1_3.dtd +3867 -0
  57. data/lib/dtds/sun-ejb-jar_2_0-0.dtd +449 -0
  58. data/lib/dtds/sun-ejb-jar_2_0-1.dtd +454 -0
  59. data/lib/dtds/sun-ejb-jar_2_1-0.dtd +756 -0
  60. data/lib/dtds/sun-ejb-jar_2_1-1.dtd +1085 -0
  61. data/lib/dtds/sun-ejb-jar_3_0-0.dtd +1113 -0
  62. data/lib/dtds/sun-loadbalancer_1_0.dtd +156 -0
  63. data/lib/dtds/sun-loadbalancer_1_1.dtd +172 -0
  64. data/lib/dtds/sun-resources_1_0.dtd +650 -0
  65. data/lib/dtds/sun-resources_1_1.dtd +650 -0
  66. data/lib/dtds/sun-resources_1_2.dtd +662 -0
  67. data/lib/dtds/sun-resources_1_3.dtd +732 -0
  68. data/lib/dtds/sun-server_1_0.dtd +1056 -0
  69. data/lib/dtds/sun-web-app_2_3-0.dtd +230 -0
  70. data/lib/dtds/sun-web-app_2_3-1.dtd +230 -0
  71. data/lib/dtds/sun-web-app_2_4-0.dtd +466 -0
  72. data/lib/dtds/sun-web-app_2_4-1.dtd +742 -0
  73. data/lib/dtds/sun-web-app_2_5-0.dtd +789 -0
  74. data/lib/dtds/web-app_2_2.dtd +639 -0
  75. data/lib/dtds/web-app_2_3.dtd +1063 -0
  76. data/lib/dtds/web-jsptaglibrary_1_1.dtd +265 -0
  77. data/lib/dtds/web-jsptaglibrary_1_2.dtd +468 -0
  78. data/lib/package-appclient.xml +185 -0
  79. data/lib/processLauncher.properties +25 -0
  80. data/lib/processLauncher.xml +189 -0
  81. data/lib/schemas/XMLSchema.dtd +402 -0
  82. data/lib/schemas/application-client_1_4.xsd +267 -0
  83. data/lib/schemas/application-client_5.xsd +304 -0
  84. data/lib/schemas/application_1_4.xsd +315 -0
  85. data/lib/schemas/application_5.xsd +336 -0
  86. data/lib/schemas/connector_1_5.xsd +1036 -0
  87. data/lib/schemas/datatypes.dtd +203 -0
  88. data/lib/schemas/ejb-jar_2_1.xsd +2208 -0
  89. data/lib/schemas/ejb-jar_3_0.xsd +2706 -0
  90. data/lib/schemas/j2ee_1_4.xsd +1608 -0
  91. data/lib/schemas/j2ee_jaxrpc_mapping_1_1.xsd +886 -0
  92. data/lib/schemas/j2ee_web_services_1_1.xsd +491 -0
  93. data/lib/schemas/j2ee_web_services_client_1_1.xsd +345 -0
  94. data/lib/schemas/javaee_5.xsd +2096 -0
  95. data/lib/schemas/javaee_web_services_1_2.xsd +747 -0
  96. data/lib/schemas/javaee_web_services_client_1_2.xsd +578 -0
  97. data/lib/schemas/jax-rpc-ri-config.xsd +416 -0
  98. data/lib/schemas/jsp_2_0.xsd +308 -0
  99. data/lib/schemas/jsp_2_1.xsd +343 -0
  100. data/lib/schemas/orm_1_0.xsd +1516 -0
  101. data/lib/schemas/persistence_1_0.xsd +260 -0
  102. data/lib/schemas/web-app_2_4.xsd +1234 -0
  103. data/lib/schemas/web-app_2_5.xsd +1271 -0
  104. data/lib/schemas/web-jsptaglibrary_2_0.xsd +1010 -0
  105. data/lib/schemas/web-jsptaglibrary_2_1.xsd +1144 -0
  106. data/lib/schemas/xml.xsd +82 -0
  107. data/modules/admin-cli-10.0-SNAPSHOT.jar +0 -0
  108. data/modules/auto-depends-0.2-SNAPSHOT.jar +0 -0
  109. data/modules/cli-framework-10.0-SNAPSHOT.jar +0 -0
  110. data/modules/common-ee-util-10.0-SNAPSHOT.jar +0 -0
  111. data/modules/common-util-10.0-SNAPSHOT.jar +0 -0
  112. data/modules/config-0.2-SNAPSHOT.jar +0 -0
  113. data/modules/config-api-10.0-SNAPSHOT.jar +0 -0
  114. data/modules/gf-jruby-connector-10.0-SNAPSHOT.jar +0 -0
  115. data/modules/glassfish-10.0-SNAPSHOT.jar +0 -0
  116. data/modules/glassfish-api-10.0-SNAPSHOT.jar +0 -0
  117. data/modules/glassfish.rb +10 -0
  118. data/modules/grizzly-framework-1.7.1.jar +0 -0
  119. data/modules/grizzly-http-1.7.1.jar +0 -0
  120. data/modules/grizzly-http-utils-1.7.1.jar +0 -0
  121. data/modules/grizzly-jruby-1.7.0.jar +0 -0
  122. data/modules/grizzly-jruby-module-1.7.0.jar +0 -0
  123. data/modules/grizzly-module-1.7.1.jar +0 -0
  124. data/modules/grizzly-portunif-1.7.1.jar +0 -0
  125. data/modules/grizzly-rcm-1.7.1.jar +0 -0
  126. data/modules/hk2-0.2-SNAPSHOT.jar +0 -0
  127. data/modules/hk2-core-0.2-SNAPSHOT.jar +0 -0
  128. data/modules/junit-4.3.1.jar +0 -0
  129. data/modules/kernel-10.0-SNAPSHOT.jar +0 -0
  130. data/modules/persistence-api-1.0b.jar +0 -0
  131. data/modules/servlet-api-2.5.jar +0 -0
  132. data/modules/sjsxp-1.0.jar +0 -0
  133. data/modules/stax-api-1.0-2.jar +0 -0
  134. data/modules/tiger-types-1.0.jar +0 -0
  135. metadata +206 -0
@@ -0,0 +1,3697 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <!--
3
+ The contents of this file are subject to the terms
4
+ of the Common Development and Distribution License
5
+ (the License). You may not use this file except in
6
+ compliance with the License.
7
+
8
+ You can obtain a copy of the license at
9
+ https://glassfish.dev.java.net/public/CDDLv1.0.html or
10
+ glassfish/bootstrap/legal/CDDLv1.0.txt.
11
+ See the License for the specific language governing
12
+ permissions and limitations under the License.
13
+
14
+ When distributing Covered Code, include this CDDL
15
+ Header Notice in each file and include the License file
16
+ at glassfish/bootstrap/legal/CDDLv1.0.txt.
17
+ If applicable, add the following below the CDDL Header,
18
+ with the fields enclosed by brackets [] replaced by
19
+ you own identifying information:
20
+ "Portions Copyrighted [year] [name of copyright owner]"
21
+
22
+ Copyright 2006 Sun Microsystems, Inc. All rights reserved.
23
+ -->
24
+ <!-- ENTITIES -->
25
+ <!-- boolean
26
+
27
+ Used in:
28
+ access-log, admin-object-resource, appclient-module,
29
+ application-ref, availability-service, cluster, config,
30
+ connector-connection-pool, connector-module, connector-resource,
31
+ custom-resource, das-config, diagnostic-service,
32
+ ejb-container-availability, ejb-module, event,
33
+ external-jndi-resource, http-access-log, http-file-cache,
34
+ http-listener, http-protocol, iiop-listener, iiop-service,
35
+ j2ee-application, java-config, jdbc-connection-pool,
36
+ jdbc-resource, jms-availability, jms-service, jmx-connector,
37
+ lb-config, lifecycle-module, load-balancer, log-service,
38
+ mail-resource, management-rule, management-rules, mbean,
39
+ node-agent, persistence-manager-factory-resource, profiler,
40
+ resource-ref, security-service, server-ref, ssl,
41
+ transaction-service, transformation-rule,
42
+ web-container-availability, web-module, web-service-endpoint
43
+ -->
44
+ <!ENTITY % boolean "(yes | no | on | off | 1 | 0 | true | false)">
45
+
46
+ <!-- isolation
47
+
48
+ Used in:
49
+ jdbc-connection-pool
50
+ -->
51
+ <!ENTITY % isolation
52
+ "(read-uncommitted | read-committed | repeatable-read | serializable)">
53
+
54
+
55
+ <!-- validation-level
56
+
57
+ Used in:
58
+ das-config
59
+ -->
60
+ <!ENTITY % validation-level "(full | parsing | none)">
61
+
62
+ <!-- object-type
63
+ defines the type of the resource. It can be:
64
+ system-all
65
+ These are system resources for all instances and DAS
66
+ system-admin
67
+ These are system resources only in DAS
68
+ system-instance
69
+ These are system resources only in instances (and not DAS)
70
+ user
71
+ User resources (This is the default for all elements)
72
+
73
+ Used in:
74
+ admin-object-resource, connector-module, connector-resource,
75
+ custom-resource, ejb-module, external-jndi-resource,
76
+ j2ee-application, jdbc-resource, mail-resource, mbean,
77
+ persistence-manager-factory-resource, resource-adapter-config,
78
+ web-module
79
+ -->
80
+ <!ENTITY % object-type "(system-all | system-admin | system-instance | user)">
81
+
82
+ <!-- rjmx-protocol
83
+ SE/EE related ENTITIES: This will define the available JSR 160
84
+ connector transport protocols.
85
+
86
+ Used in:
87
+ jmx-connector
88
+ -->
89
+ <!ENTITY % rjmx-protocol "(rmi_jrmp | rmi_iiop | jmxmp)">
90
+
91
+ <!-- monitoring-level
92
+ monitoring-level controls the amount of monitoring data collected
93
+ and exposed to clients
94
+ OFF
95
+ no monitoring/statistical data is exposed to the clients.
96
+ LOW
97
+ SE/EE only
98
+ HIGH
99
+ maximum data is gathered and released.
100
+
101
+ Used in:
102
+ module-monitoring-levels, web-service-endpoint
103
+ -->
104
+ <!ENTITY % monitoring-level "(OFF | LOW | HIGH)">
105
+
106
+ <!-- persistence-type
107
+ SE/EE related ENTITIES
108
+
109
+ Used in:
110
+ web-container-availability
111
+ -->
112
+ <!ENTITY % persistence-type "(memory | file | ha)">
113
+
114
+ <!-- session-save-frequency
115
+
116
+ Used in:
117
+ web-container-availability
118
+ -->
119
+ <!ENTITY % session-save-frequency "(web-method | time-based | on-demand)">
120
+
121
+ <!-- session-save-scope
122
+
123
+ Used in:
124
+ web-container-availability
125
+ -->
126
+ <!ENTITY % session-save-scope
127
+ "(session | modified-session | modified-attribute)">
128
+
129
+
130
+ <!-- sfsb-persistence-type
131
+
132
+ Used in:
133
+ ejb-container-availability
134
+ -->
135
+ <!ENTITY % sfsb-persistence-type "(file | ha)">
136
+
137
+ <!-- apply-to-type
138
+
139
+ Used in:
140
+ transformation-rule
141
+ -->
142
+ <!ENTITY % apply-to-type "(request | response | both)">
143
+
144
+ <!-- lb-policy-type
145
+
146
+ Used in:
147
+ cluster-ref
148
+ -->
149
+ <!ENTITY % lb-policy-type
150
+ "(round-robin | weighted-round-robin | user-defined)">
151
+
152
+
153
+ <!-- event-type
154
+
155
+ Used in:
156
+ event
157
+ -->
158
+ <!ENTITY % event-type
159
+ "(log | timer | trace | monitor | cluster | lifecycle | notification)">
160
+
161
+
162
+ <!-- message-layer
163
+
164
+ Used in:
165
+ message-security-config
166
+ -->
167
+ <!ENTITY % message-layer "(SOAP | HttpServlet)">
168
+
169
+ <!-- log-level
170
+ Configure the Log Levels for Various Loggers in the SUN ONE
171
+ Modules. The Default level is set to INFO, The log levels can be
172
+ changed using one of the seven levels. Please refer JSR 047 to
173
+ understand the Log Levels.
174
+
175
+ The Logs can be completely turned off by using 'OFF' value. The names of
176
+ the module loggers are self-explanatory
177
+
178
+
179
+ Used in:
180
+ diagnostic-service, event, module-log-levels
181
+ -->
182
+ <!ENTITY % log-level
183
+ "(FINEST | FINER | FINE | CONFIG | INFO | WARNING | SEVERE | OFF)">
184
+
185
+
186
+ <!-- ELEMENTS -->
187
+
188
+ <!-- domain
189
+ Top level Domain Element that includes applications, resources,
190
+ configs, servers, clusters and node-agents, load balancer
191
+ configurations and load balancers. node-agents and load balancers
192
+ are SE/EE related entities only.
193
+
194
+ attributes
195
+ application-root
196
+ for PE this defines the location where applications are
197
+ deployed
198
+ locale
199
+ If present, overrides OS locale setting.
200
+ log-root
201
+ specifies where the server instance's log files are kept,
202
+ including HTTP access logs, server logs, and transaction
203
+ logs. Default is $INSTANCE-ROOT/logs
204
+ -->
205
+ <!ELEMENT domain
206
+ (applications?, resources?, configs, servers, clusters?, node-agents?,
207
+ lb-configs?, load-balancers?, system-property*, property*)>
208
+
209
+
210
+ <!ATTLIST domain
211
+ application-root CDATA #IMPLIED
212
+ log-root CDATA #IMPLIED
213
+ locale CDATA #IMPLIED>
214
+
215
+
216
+ <!-- configs
217
+
218
+ Used in:
219
+ domain
220
+ -->
221
+ <!ELEMENT configs (config+)>
222
+
223
+
224
+ <!-- servers
225
+
226
+ Used in:
227
+ domain
228
+ -->
229
+ <!ELEMENT servers (server*)>
230
+
231
+
232
+ <!-- clusters
233
+
234
+ Used in:
235
+ domain
236
+ -->
237
+ <!ELEMENT clusters (cluster*)>
238
+
239
+
240
+ <!-- node-agents
241
+
242
+ Used in:
243
+ domain
244
+ -->
245
+ <!ELEMENT node-agents (node-agent*)>
246
+
247
+
248
+ <!-- lb-configs
249
+
250
+ Used in:
251
+ domain
252
+ -->
253
+ <!ELEMENT lb-configs (lb-config*)>
254
+
255
+
256
+ <!-- applications
257
+ Various types of applications that can be deployed on Sun ONE
258
+ Application Server instance
259
+
260
+ Used in:
261
+ domain
262
+ -->
263
+ <!ELEMENT applications
264
+ ((lifecycle-module | j2ee-application | ejb-module | web-module |
265
+ connector-module | appclient-module | mbean)*)>
266
+
267
+
268
+
269
+ <!-- lifecycle-module
270
+
271
+ attributes
272
+ class-name
273
+ fully qualified name of the startup class.
274
+ classpath
275
+ where this module is actually located, if it is not under
276
+ applications-root
277
+ enabled
278
+ boolean attribute. If set to "false" this module will not be
279
+ loaded at server start up.
280
+ is-failure-fatal
281
+ if true, aborts server start up if this module does not load
282
+ properly.
283
+ load-order
284
+ integer value that can be used to force the order in which
285
+ deployed lifecycle modules are loaded at server start up.
286
+ Smaller numbered modules get loaded sooner. Order is
287
+ unspecified if two or more lifecycle modules have the same
288
+ load-order value.
289
+ name
290
+ unqiue identifier for the deployed server lifecycle event
291
+ listener module.
292
+
293
+ Used in:
294
+ applications
295
+ -->
296
+ <!ELEMENT lifecycle-module (description?, property*)>
297
+
298
+ <!ATTLIST lifecycle-module
299
+ name CDATA #REQUIRED
300
+ class-name CDATA #REQUIRED
301
+ classpath CDATA #IMPLIED
302
+ load-order CDATA #IMPLIED
303
+ is-failure-fatal %boolean; "false"
304
+ enabled %boolean; "true">
305
+
306
+
307
+ <!-- j2ee-application
308
+
309
+ attributes
310
+ availability-enabled
311
+ This boolean flag controls whether availability is enabled
312
+ for SFSB checkpointing (and potentially passivation). If this
313
+ is "false", then all SFSB checkpointing is disabled for
314
+ either the given j2ee app or the given ejb module. If it is
315
+ "true" (and providing that all the availability-enabled
316
+ attributes above in precedence are also "true", then the j2ee
317
+ app or stand-alone ejb modules may be ha enabled.
318
+ Finer-grained control exists at lower level inside each bean.
319
+ If this attribute is missing, it defaults to "false".
320
+ directory-deployed
321
+ This attribute indicates whether the application has been
322
+ deployed to a directory or not
323
+ java-web-start-enabled
324
+ This attribute indicates whether Java Web Start access is
325
+ permitted to eligible application client(s) in this module
326
+ libraries
327
+ System dependent path separator [: for Unix/Solaris/Linux and
328
+ ; for Windows] separated list of jar paths. These paths could
329
+ be either relative [relative to
330
+ {com.sun.aas.instanceRoot}/lib/applibs] or absolute paths.
331
+ These dependencies appears *after* the libraries defined in
332
+ classpath-prefix in the java-config and *before* the
333
+ application server provided over-rideable jar set. The
334
+ libraries would be made available to the application in the
335
+ order in which they were specified.
336
+
337
+ Used in:
338
+ applications
339
+ -->
340
+ <!ELEMENT j2ee-application (description?, web-service-endpoint*, property*)>
341
+
342
+ <!ATTLIST j2ee-application
343
+ name CDATA #REQUIRED
344
+ location CDATA #REQUIRED
345
+ object-type %object-type; "user"
346
+ enabled %boolean; "true"
347
+ libraries CDATA #IMPLIED
348
+ availability-enabled %boolean; "false"
349
+ directory-deployed %boolean; "false"
350
+ java-web-start-enabled %boolean; "true">
351
+
352
+
353
+ <!-- ejb-module
354
+
355
+ attributes
356
+ availability-enabled
357
+ This boolean flag controls whether availability is enabled
358
+ for SFSB checkpointing (and potentially passivation). If this
359
+ is "false", then all SFSB checkpointing is disabled for
360
+ either the given j2ee app or the given ejb module. If it is
361
+ "true" (and providing that all the availability-enabled
362
+ attributes above in precedence are also "true", then the j2ee
363
+ app or stand-alone ejb modules may be ha enabled.
364
+ Finer-grained control exists at lower level inside each bean.
365
+ If this attribute is missing, it defaults to "false".
366
+ directory-deployed
367
+ This attribute indicates whether the application has been
368
+ deployed to a directory or not
369
+ libraries
370
+ System dependent path separator [: for Unix/Solaris/Linux and
371
+ ; for Windows] separated list of jar paths. These paths could
372
+ be either relative [relative to
373
+ {com.sun.aas.instanceRoot}/lib/applibs] or absolute paths.
374
+ These dependencies appears *after* the libraries defined in
375
+ classpath-prefix in the java-config and *before* the
376
+ application server provided over-rideable jar set. The
377
+ libraries would be made available to the application in the
378
+ order in which they were specified.
379
+
380
+ Used in:
381
+ applications
382
+ -->
383
+ <!ELEMENT ejb-module (description?, web-service-endpoint*, property*)>
384
+
385
+ <!ATTLIST ejb-module
386
+ name CDATA #REQUIRED
387
+ location CDATA #REQUIRED
388
+ object-type %object-type; "user"
389
+ enabled %boolean; "true"
390
+ libraries CDATA #IMPLIED
391
+ availability-enabled %boolean; "false"
392
+ directory-deployed %boolean; "false">
393
+
394
+
395
+ <!-- web-module
396
+
397
+ attributes
398
+ availability-enabled
399
+ This boolean flag controls whether availability is enabled
400
+ for HTTP Session Persistence. If this is "false", then all
401
+ session persistence is disabled for the given web module. If
402
+ it is "true" (and providing that all the availability-enabled
403
+ attributes above in precedence are also "true", then the web
404
+ module may be ha enabled. Finer-grained control exists at
405
+ lower level (see sun-web.xml). If this attribute is missing,
406
+ it defaults to "false".
407
+ context-root
408
+ context-root must match the pattern for the hpath production
409
+ in RFC 1738 which can be found at:
410
+ http://www.w3.org/Addressing/rfc1738.txt. This is flattened
411
+ to the following regular expression in XML Schema's pattern
412
+ language:
413
+ ([a-zA-Z0-9$\-_.+!*'(),]|%[0-9A-Fa-f][0-9A-Fa-f]|;|:|&|=)*(/([
414
+ -zA-Z0-9$\-_.+!*'(),]|%[0-9A-Fa-f][0-9A-Fa-f]|;|:|&|=)*)*
415
+ Note that this includes the null or empty context root and
416
+ permits but does not require a context root to start with the
417
+ '/' character (including a context root which is simply the
418
+ '/' character).
419
+ directory-deployed
420
+ This attribute indicates whether the application has been
421
+ deployed to a directory or not
422
+ libraries
423
+ System dependent path separator [: for Unix/Solaris/Linux and
424
+ ; for Windows] separated list of jar paths. These paths could
425
+ be either relative [relative to
426
+ {com.sun.aas.instanceRoot}/lib/applibs] or absolute paths.
427
+ These dependencies appears *after* the libraries defined in
428
+ classpath-prefix in the java-config and *before* the
429
+ application server provided over-rideable jar set. The
430
+ libraries would be made available to the application in the
431
+ order in which they were specified.
432
+
433
+ Used in:
434
+ applications
435
+ -->
436
+ <!ELEMENT web-module (description?, web-service-endpoint*, property*)>
437
+
438
+ <!ATTLIST web-module
439
+ name CDATA #REQUIRED
440
+ context-root CDATA #REQUIRED
441
+ location CDATA #REQUIRED
442
+ object-type %object-type; "user"
443
+ enabled %boolean; "true"
444
+ libraries CDATA #IMPLIED
445
+ availability-enabled %boolean; "false"
446
+ directory-deployed %boolean; "false">
447
+
448
+
449
+ <!-- connector-module
450
+
451
+ Used in:
452
+ applications
453
+ -->
454
+ <!ELEMENT connector-module (description?, property*)>
455
+
456
+ <!ATTLIST connector-module
457
+ name CDATA #REQUIRED
458
+ location CDATA #REQUIRED
459
+ object-type %object-type; "user"
460
+ enabled %boolean; "true"
461
+ directory-deployed %boolean; "false">
462
+
463
+
464
+ <!-- appclient-module
465
+
466
+ attributes
467
+ java-web-start-enabled
468
+ This attribute indicates whether Java Web Start access is
469
+ permitted to eligible application client(s) in this module
470
+
471
+ Used in:
472
+ applications
473
+ -->
474
+ <!ELEMENT appclient-module (description?, property*)>
475
+
476
+ <!ATTLIST appclient-module
477
+ name CDATA #REQUIRED
478
+ location CDATA #REQUIRED
479
+ directory-deployed %boolean; "false"
480
+ java-web-start-enabled %boolean; "true">
481
+
482
+
483
+ <!-- resources
484
+ J2EE Applications look up resources registered with the
485
+ Application server, using portable JNDI names.
486
+
487
+ Used in:
488
+ domain
489
+ -->
490
+ <!ELEMENT resources
491
+ ((custom-resource | external-jndi-resource | jdbc-resource | mail-resource
492
+ | persistence-manager-factory-resource | admin-object-resource |
493
+ connector-resource | resource-adapter-config | jdbc-connection-pool |
494
+ connector-connection-pool)*)>
495
+
496
+
497
+
498
+ <!-- description
499
+ Textual description of a configured entity
500
+
501
+ Used in:
502
+ admin-object-resource, appclient-module,
503
+ connector-connection-pool, connector-module, connector-resource,
504
+ custom-resource, ejb-module, event, external-jndi-resource,
505
+ j2ee-application, jdbc-connection-pool, jdbc-resource,
506
+ lifecycle-module, mail-resource, management-rule, mbean,
507
+ persistence-manager-factory-resource, property, system-property,
508
+ web-module
509
+ -->
510
+ <!ELEMENT description (#PCDATA)>
511
+
512
+
513
+ <!-- custom-resource
514
+ custom (or generic) resource managed by a user-written factory
515
+ class.
516
+
517
+ attributes
518
+ jndi-name
519
+ JNDI name for generic resource, the fully qualified type of
520
+ the resource and whether it is enabled at runtime
521
+
522
+ Used in:
523
+ resources
524
+ -->
525
+ <!ELEMENT custom-resource (description?, property*)>
526
+
527
+ <!ATTLIST custom-resource
528
+ jndi-name CDATA #REQUIRED
529
+ res-type CDATA #REQUIRED
530
+ factory-class CDATA #REQUIRED
531
+ object-type %object-type; "user"
532
+ enabled %boolean; "true">
533
+
534
+
535
+ <!-- external-jndi-resource
536
+ resource residing in an external JNDI repository
537
+
538
+ Used in:
539
+ resources
540
+ -->
541
+ <!ELEMENT external-jndi-resource (description?, property*)>
542
+
543
+ <!ATTLIST external-jndi-resource
544
+ jndi-name CDATA #REQUIRED
545
+ jndi-lookup-name CDATA #REQUIRED
546
+ res-type CDATA #REQUIRED
547
+ factory-class CDATA #REQUIRED
548
+ object-type %object-type; "user"
549
+ enabled %boolean; "true">
550
+
551
+
552
+ <!-- jdbc-resource
553
+ JDBC javax.sql.(XA)DataSource resource definition
554
+
555
+ Used in:
556
+ resources
557
+ -->
558
+ <!ELEMENT jdbc-resource (description?, property*)>
559
+
560
+ <!ATTLIST jdbc-resource
561
+ jndi-name CDATA #REQUIRED
562
+ pool-name CDATA #REQUIRED
563
+ object-type %object-type; "user"
564
+ enabled %boolean; "true">
565
+
566
+
567
+ <!-- mail-resource
568
+ The mail-resource element describes a javax.mail.Session resource
569
+
570
+ attributes
571
+ host
572
+ ip V6 or V4 address or hostname.
573
+
574
+ Used in:
575
+ resources
576
+ -->
577
+ <!ELEMENT mail-resource (description?, property*)>
578
+
579
+ <!ATTLIST mail-resource
580
+ jndi-name CDATA #REQUIRED
581
+ store-protocol CDATA "imap"
582
+ store-protocol-class CDATA "com.sun.mail.imap.IMAPStore"
583
+ transport-protocol CDATA "smtp"
584
+ transport-protocol-class CDATA "com.sun.mail.smtp.SMTPTransport"
585
+ host CDATA #REQUIRED
586
+ user CDATA #REQUIRED
587
+ from CDATA #REQUIRED
588
+ debug %boolean; "false"
589
+ object-type %object-type; "user"
590
+ enabled %boolean; "true">
591
+
592
+
593
+ <!-- persistence-manager-factory-resource
594
+ Persistence Manager runtime configuration.
595
+
596
+ attributes
597
+ factory-class
598
+ Class that creates persistence manager instance.
599
+ jdbc-resource-jndi-name
600
+ jdbc resource with which database connections are obtained.
601
+ jndi-name
602
+ JNDI name for this resource
603
+
604
+ Used in:
605
+ resources
606
+ -->
607
+ <!ELEMENT persistence-manager-factory-resource (description?, property*)>
608
+
609
+ <!ATTLIST persistence-manager-factory-resource
610
+ jndi-name CDATA #REQUIRED
611
+ factory-class CDATA "com.sun.jdo.spi.persistence.support.sqlstore.impl.PersistenceManagerFactoryImpl"
612
+ jdbc-resource-jndi-name CDATA #IMPLIED
613
+ object-type %object-type; "user"
614
+ enabled %boolean; "true">
615
+
616
+
617
+ <!-- admin-object-resource
618
+ The admin-object-resource element describes a administered object
619
+ for a inbound resource adapter.
620
+
621
+ attributes
622
+ jndi-name
623
+ JNDI name for this resource
624
+ res-adapter
625
+ Name of the inbound resource adapter.
626
+ res-type
627
+ Interface definition for the administered object
628
+
629
+ Used in:
630
+ resources
631
+ -->
632
+ <!ELEMENT admin-object-resource (description?, property*)>
633
+
634
+ <!ATTLIST admin-object-resource
635
+ jndi-name CDATA #REQUIRED
636
+ res-type CDATA #REQUIRED
637
+ res-adapter CDATA #REQUIRED
638
+ object-type %object-type; "user"
639
+ enabled %boolean; "true">
640
+
641
+
642
+ <!-- connector-resource
643
+
644
+ Used in:
645
+ resources
646
+ -->
647
+ <!ELEMENT connector-resource (description?, property*)>
648
+
649
+ <!ATTLIST connector-resource
650
+ jndi-name CDATA #REQUIRED
651
+ pool-name CDATA #REQUIRED
652
+ object-type %object-type; "user"
653
+ enabled %boolean; "true">
654
+
655
+
656
+ <!-- resource-adapter-config
657
+ This element is for configuring the resource adapter. These
658
+ values (properties) over-rides the default values present in
659
+ ra.xml. The name attribute has to be unique . It is optional for
660
+ PE. It is used mainly for EE.
661
+
662
+ Used in:
663
+ resources
664
+ -->
665
+ <!ELEMENT resource-adapter-config (property*)>
666
+
667
+ <!ATTLIST resource-adapter-config
668
+ name CDATA #IMPLIED
669
+ thread-pool-ids CDATA #IMPLIED
670
+ object-type %object-type; "user"
671
+ resource-adapter-name CDATA #REQUIRED>
672
+
673
+
674
+ <!-- config
675
+ The configuration defines the configuration of a server instance
676
+ that can be shared by other server instances. The
677
+ availability-service and are SE/EE only.
678
+
679
+ attributes
680
+ dynamic-reconfiguration-enabled
681
+ When set to "true" then any changes to the system (e.g.
682
+ applications deployed, resources created) will be
683
+ automatically applied to the affected servers without a
684
+ restart being required. When set to "false" such changes will
685
+ only be picked up by the affected servers when each server
686
+ restarts.
687
+
688
+ Used in:
689
+ configs
690
+ -->
691
+ <!ELEMENT config
692
+ (http-service, iiop-service, admin-service, connector-service?,
693
+ web-container, ejb-container, mdb-container, jms-service?, log-service,
694
+ security-service, transaction-service, monitoring-service,
695
+ diagnostic-service?, java-config, availability-service?, thread-pools,
696
+ alert-service?, group-management-service?, management-rules?,
697
+ system-property*, property*)>
698
+
699
+
700
+ <!ATTLIST config
701
+ name CDATA #REQUIRED
702
+ dynamic-reconfiguration-enabled %boolean; "true">
703
+
704
+
705
+ <!-- alert-service
706
+ The Alert service provides a mechanism for users to register for
707
+ and receive alerts. The alert service collects together a set of
708
+ alert subscriptions
709
+
710
+ Used in:
711
+ config
712
+ -->
713
+ <!ELEMENT alert-service (alert-subscription*, property*)>
714
+
715
+
716
+ <!-- alert-subscription
717
+ alert subscription details a specific subscription. The
718
+ subscription comprises the configuration of a specific listener,
719
+ and a filter to be applied.
720
+
721
+ attributes
722
+ name
723
+ The unique name identifying a particular alert service.
724
+
725
+ Used in:
726
+ alert-service
727
+ -->
728
+ <!ELEMENT alert-subscription (listener-config, filter-config?)>
729
+
730
+ <!ATTLIST alert-subscription
731
+ name CDATA #REQUIRED>
732
+
733
+
734
+ <!-- listener-config
735
+ connects a specific listener class with specific managed objects
736
+
737
+ attributes
738
+ listener-class-name
739
+ The name of a class that can act as a listener for alerts.
740
+ Non-empty string containing a Java class name.
741
+ subscribe-listener-with
742
+ A list of managed object names that the listener should be
743
+ subscribed to. A non-empty, comma separated list.
744
+
745
+ Used in:
746
+ alert-subscription
747
+ -->
748
+ <!ELEMENT listener-config (property*)>
749
+
750
+ <!ATTLIST listener-config
751
+ listener-class-name CDATA #REQUIRED
752
+ subscribe-listener-with CDATA #REQUIRED>
753
+
754
+
755
+ <!-- filter-config
756
+ filter-config provides the means of specifying a filter to be
757
+ applied to alerts
758
+
759
+ attributes
760
+ filter-class-name
761
+ The name of a class that can act as a filter. Non-empty
762
+ string containing a Java class name.
763
+
764
+ Used in:
765
+ alert-subscription
766
+ -->
767
+ <!ELEMENT filter-config (property*)>
768
+
769
+ <!ATTLIST filter-config
770
+ filter-class-name CDATA #REQUIRED>
771
+
772
+
773
+ <!-- http-service
774
+
775
+ Used in:
776
+ config
777
+ -->
778
+ <!ELEMENT http-service
779
+ (access-log?, http-listener+, virtual-server+, request-processing?,
780
+ keep-alive?, connection-pool?, http-protocol?, http-file-cache?,
781
+ property*)>
782
+
783
+
784
+
785
+ <!-- access-log
786
+
787
+ attributes
788
+ format
789
+ The global format for the access log rotation-policy The
790
+ policy based on which the log rotation would be done . At
791
+ this time only time based rotation is enabled.
792
+ rotation-enabled
793
+ The flag for enabling the access-log rotation
794
+ rotation-interval-in-minutes
795
+ The time interval in minutes between two successive rotations
796
+ of the access logs.
797
+ rotation-suffix
798
+ The suffix to be added to the access-log name after rotation.
799
+ Acceptable values include those supported by
800
+ java.text.SimpleDateFormat and
801
+ "%YYYY;%MM;%DD;-%hh;h%mm;m%ss;s".
802
+
803
+ Used in:
804
+ http-service
805
+ -->
806
+ <!ELEMENT access-log EMPTY>
807
+
808
+ <!ATTLIST access-log
809
+ format CDATA "%client.name% %auth-user-name% %datetime% %request% %status% %response.length%"
810
+ rotation-policy (time) "time"
811
+ rotation-interval-in-minutes CDATA "1440"
812
+ rotation-suffix CDATA "yyyyMMdd-HH'h'mm'm'ss's'"
813
+ rotation-enabled %boolean; "true">
814
+
815
+
816
+ <!-- http-listener
817
+
818
+ attributes
819
+ acceptor-threads
820
+ Number of acceptor threads for the listen socket. The
821
+ recommended value is the number of processors in the machine.
822
+ address
823
+ IP address of the listen socket. Can be in dotted-pair or
824
+ IPv6 notation. Can also be any for INADDR-ANY. Configuring a
825
+ listen socket to listen on any is required if more than one
826
+ http-listener is configured to it.
827
+ blocking-enabled
828
+ Enables blocking for the listen and external ports.
829
+ default-virtual-server
830
+ The id attribute of the default virtual server for this
831
+ particular connection group.
832
+ external-port
833
+ The port at which the user makes a request , typically a
834
+ proxy server port.
835
+ family
836
+ Specified the family of addresses either inet or ncsa
837
+ id
838
+ Unique identifier for http listener.
839
+ port
840
+ Port number to create the listen socket on. Legal values are
841
+ 1 - 65535. On Unix, creating sockets that listen on ports 1 -
842
+ 1024 requires superuser privileges. Configuring an SSL listen
843
+ socket to listen on port 443 is recommended.
844
+ redirect-port
845
+ if the connector is supporting non-SSL requests and a request
846
+ is received for which a matching security-constraint requires
847
+ SSL transport catalina will automatically redirect the
848
+ request to the port number specified here
849
+ security-enabled
850
+ Determines whether the http listener runs SSL. You can turn
851
+ SSL2 or SSL3 on or off and set ciphers using an ssl element.
852
+ The enable-ssl in the protocol element should be set to true
853
+ for this setting to work.
854
+ server-name
855
+ Tells the server what to put in the host name section of any
856
+ URLs it sends to the client. This affects URLs the server
857
+ automatically generates; it doesnt affect the URLs for
858
+ directories and files stored in the server. This name should
859
+ be the alias name if your server uses an alias. If you append
860
+ a colon and port number, that port will be used in URLs the
861
+ server sends to the client.
862
+ xpowered-by
863
+ The Servlet 2.4 spec defines a special X-Powered-By:
864
+ Servlet/2.4 header, which containers may add to
865
+ servlet-generated responses. This is complemented by the JSP
866
+ 2.0 spec, which defines a X-Powered-By: JSP/2.0 header to be
867
+ added (on an optional basis) to responses utilizing JSP
868
+ technology. The goal of these headers is to aid in gathering
869
+ statistical data about the use of Servlet and JSP technology.
870
+ If true, these headers will be added.
871
+
872
+ Used in:
873
+ http-service
874
+ -->
875
+ <!ELEMENT http-listener (ssl?, property*)>
876
+
877
+ <!ATTLIST http-listener
878
+ id CDATA #REQUIRED
879
+ address CDATA #REQUIRED
880
+ port CDATA #REQUIRED
881
+ external-port CDATA #IMPLIED
882
+ family (inet | ncsa) "inet"
883
+ blocking-enabled %boolean; "false"
884
+ acceptor-threads CDATA "1"
885
+ security-enabled %boolean; "false"
886
+ default-virtual-server CDATA #REQUIRED
887
+ server-name CDATA #REQUIRED
888
+ redirect-port CDATA #IMPLIED
889
+ xpowered-by %boolean; "true"
890
+ enabled %boolean; "true">
891
+
892
+
893
+ <!-- ssl
894
+ Define SSL processing parameters
895
+
896
+ attributes
897
+ cert-nickname
898
+ nickname of the server certificate in the certificate
899
+ database or the PKCS#11 token. In the certificate, the name
900
+ format is tokenname:nickname. Including the tokenname: part
901
+ of the name in this attribute is optional.
902
+ client-auth-enabled
903
+ Determines whether SSL3 client authentication is performed on
904
+ every request, independent of ACL-based access control.
905
+ ssl2-ciphers
906
+ A comma-separated list of the SSL2 ciphers used, with the
907
+ prefix + to enable or - to disable, for example +rc4. Allowed
908
+ values are rc4, rc4export, rc2, rc2export, idea, des,
909
+ desede3. If no value is specified, all supported ciphers are
910
+ assumed to be enabled. NOT Used in PE
911
+ ssl2-enabled
912
+ Determines whether SSL2 is enabled. NOT Used in PE. SSL2 is
913
+ not supported by either iiop or web-services. When this
914
+ element is used as a child of the iiop-listener element then
915
+ the only allowed value for this attribute is "false".
916
+ ssl3-enabled
917
+ Determines whether SSL3 is enabled.
918
+
919
+ If both SSL2 and SSL3 are enabled for a virtual server, the server
920
+ tries SSL3 encryption first. If that fails, the server tries SSL2
921
+ encryption.
922
+
923
+ ssl3-tls-ciphers
924
+ A comma-separated list of the SSL3 ciphers used, with the
925
+ prefix + to enable or - to disable, for example
926
+ +SSL_RSA_WITH_RC4_128_MD5. Allowed SSL3/TLS values are
927
+ SSL_RSA_WITH_RC4_128_MD5, SSL_RSA_WITH_3DES_EDE_CBC_SHA,
928
+ SSL_RSA_WITH_DES_CBC_SHA, SSL_RSA_EXPORT_WITH_RC4_40_MD5,
929
+ SSL_RSA_WITH_NULL_MD5, SSL_RSA_WITH_RC4_128_SHA,
930
+ SSL_RSA_WITH_NULL_SHA. If no value is specified, all
931
+ supported ciphers are assumed to be enabled.
932
+ tls-enabled
933
+ Determines whether TLS is enabled.
934
+ tls-rollback-enabled
935
+ Determines whether TLS rollback is enabled. TLS rollback
936
+ should be enabled for Microsoft Internet Explorer 5.0 and
937
+ 5.5. NOT Used in PE
938
+
939
+ Used in:
940
+ http-listener, iiop-listener, jmx-connector, ssl-client-config
941
+ -->
942
+ <!ELEMENT ssl EMPTY>
943
+
944
+ <!ATTLIST ssl
945
+ cert-nickname CDATA #REQUIRED
946
+ ssl2-enabled %boolean; "false"
947
+ ssl2-ciphers CDATA #IMPLIED
948
+ ssl3-enabled %boolean; "true"
949
+ ssl3-tls-ciphers CDATA #IMPLIED
950
+ tls-enabled %boolean; "true"
951
+ tls-rollback-enabled %boolean; "true"
952
+ client-auth-enabled %boolean; "false">
953
+
954
+
955
+ <!-- virtual-server
956
+ Configuration of Virtual Server
957
+
958
+ Virtualization in Application Server allows multiple URL domains to be
959
+ served by the same HTTP server process, which is listening on multiple
960
+ host addresses If an application is available at two virtual servers, they
961
+ still share same physical resource pools, such as JDBC connection pools.
962
+
963
+ Sun ONE Application Server allows a list of virtual servers, to be
964
+ specified along with web-module and j2ee-application elements. This
965
+ establishes an association between URL domains, represented by the virtual
966
+ server and the web modules (standalone web modules or web modules inside
967
+ the ear file)
968
+
969
+
970
+ attributes
971
+ default-web-module
972
+ stand alone web module associated with this virtual server by
973
+ default.
974
+ docroot
975
+ The location on the filesystem where the files related to the
976
+ content to be served by this virtual server is stored.
977
+ hosts
978
+ A comma-separated list of values allowed in the Host request
979
+ header to select the current virtual server. Each Virtual
980
+ Server that is configured to the same Connection Group must
981
+ have a unique hosts value for that group.
982
+ http-listeners
983
+ A comma-separated list of http-listener id(s), Required only
984
+ for a Virtual Server that is not the default virtual server.
985
+ id
986
+ Virtual server ID. This is a unique ID that allows lookup of
987
+ a specific virtual server. A virtual server ID cannot begin
988
+ with a number.
989
+ log-file
990
+ Specifies a log file for virtual-server-specific log
991
+ messages. Default value is
992
+ ${com.sun.aas.instanceRoot}/logs/server.log
993
+ state
994
+ Determines whether a Virtual Server is active (on) or
995
+ inactive (off, disable). The default is on (active). When
996
+ inactive, a Virtual Server does not service requests.
997
+ off
998
+ returns a 404: Status code (404) indicating that the
999
+ requested resource is not available
1000
+ disabled
1001
+ returns a 403: Status code (403) indicating the server
1002
+ understood the request but refused to fulfill it.
1003
+
1004
+ Used in:
1005
+ http-service
1006
+ -->
1007
+ <!ELEMENT virtual-server (http-access-log?, property*)>
1008
+
1009
+ <!ATTLIST virtual-server
1010
+ id CDATA #REQUIRED
1011
+ http-listeners CDATA #IMPLIED
1012
+ default-web-module CDATA #IMPLIED
1013
+ hosts CDATA #REQUIRED
1014
+ state (on | off | disabled) "on"
1015
+ docroot CDATA #IMPLIED
1016
+ log-file CDATA "${com.sun.aas.instanceRoot}/logs/server.log">
1017
+
1018
+
1019
+ <!-- http-access-log
1020
+
1021
+ attributes
1022
+ iponly
1023
+ if the IP address of the user agent should be specified or a
1024
+ DNL lookup should be done
1025
+ log-directory
1026
+ location of the access logs specified as a directory.This
1027
+ defaults to the domain.log-root, which by default is
1028
+ ${INSTANCE_ROOT}/logs. Hence the default value for this
1029
+ attribute is ${INSTANCE_ROOT}/logs/access
1030
+
1031
+ Used in:
1032
+ virtual-server
1033
+ -->
1034
+ <!ELEMENT http-access-log EMPTY>
1035
+
1036
+ <!ATTLIST http-access-log
1037
+ log-directory CDATA "${com.sun.aas.instanceRoot}/logs/access"
1038
+ iponly %boolean; "true">
1039
+
1040
+
1041
+ <!-- request-processing
1042
+ This element provides attributes to configure the request
1043
+ processing subsystem in the HTTP service.
1044
+
1045
+ attributes
1046
+ header-buffer-length-in-bytes
1047
+ The size of the buffer used by the request processing threads
1048
+ for reading the request data
1049
+ initial-thread-count
1050
+ The no of request processing threads when the http service is
1051
+ initialized
1052
+ request-timeout-in-seconds
1053
+ Time after which the request times out
1054
+ thread-count
1055
+ Max no of request processing threads.
1056
+ thread-increment
1057
+ The increment in the no of request processing threads when
1058
+ the no. of requests reaches the number specified by
1059
+ request-threads-init
1060
+
1061
+ Used in:
1062
+ http-service
1063
+ -->
1064
+ <!ELEMENT request-processing EMPTY>
1065
+
1066
+ <!ATTLIST request-processing
1067
+ thread-count CDATA "128"
1068
+ initial-thread-count CDATA "48"
1069
+ thread-increment CDATA "10"
1070
+ request-timeout-in-seconds CDATA "30"
1071
+ header-buffer-length-in-bytes CDATA "4096">
1072
+
1073
+
1074
+ <!-- keep-alive
1075
+ Keep-alive subsystem configuration
1076
+
1077
+ attributes
1078
+ max-connections
1079
+ Max no of connection in the Keep Alive mode
1080
+ thread-count
1081
+ no of Keep Alive threads in the system
1082
+ timeout-in-seconds
1083
+ Keep Alive timeout , max time a connection can be deemed as
1084
+ idle and kept in the keep-alive state
1085
+
1086
+ Used in:
1087
+ http-service
1088
+ -->
1089
+ <!ELEMENT keep-alive EMPTY>
1090
+
1091
+ <!ATTLIST keep-alive
1092
+ thread-count CDATA "1"
1093
+ max-connections CDATA "256"
1094
+ timeout-in-seconds CDATA "30">
1095
+
1096
+
1097
+ <!-- connection-pool
1098
+
1099
+ attributes
1100
+ max-pending-count
1101
+ Max no of pending connections on the listen socket
1102
+ queue-size-in-bytes
1103
+ Size in bytes of the Connection queue
1104
+ receive-buffer-size-in-bytes
1105
+ The buffer size of the receive buffer used by sockets.
1106
+ send-buffer-size-in-bytes
1107
+ The buffer size of the send buffer used by sockets.
1108
+
1109
+ Used in:
1110
+ http-service
1111
+ -->
1112
+ <!ELEMENT connection-pool EMPTY>
1113
+
1114
+ <!ATTLIST connection-pool
1115
+ queue-size-in-bytes CDATA "4096"
1116
+ max-pending-count CDATA "4096"
1117
+ receive-buffer-size-in-bytes CDATA "4096"
1118
+ send-buffer-size-in-bytes CDATA "8192">
1119
+
1120
+
1121
+ <!-- http-protocol
1122
+ HTTP Protocol related settings
1123
+
1124
+ attributes
1125
+ default-response-type
1126
+ Setting the default response-type. Specified as a semi-colon
1127
+ delimited string consisting of content-type, encoding,
1128
+ language, charset
1129
+ dns-lookup-enabled
1130
+ If the DNS name for a particular ip address from which the
1131
+ request originates needs to be looked up.
1132
+ forced-response-type
1133
+ The response type to be forced if the content served cannot
1134
+ be matched by any of the MIME mappings for extensions.
1135
+ Specified as a semi-colon delimited string consisting of
1136
+ content-type, encoding, language, charset
1137
+ ssl-enabled
1138
+ Globally enables SSL across the server
1139
+ version
1140
+ The version of the HTTP protocol used by the HTTP Service
1141
+
1142
+ Used in:
1143
+ http-service
1144
+ -->
1145
+ <!ELEMENT http-protocol EMPTY>
1146
+
1147
+ <!ATTLIST http-protocol
1148
+ version CDATA "HTTP/1.1"
1149
+ dns-lookup-enabled %boolean; "false"
1150
+ forced-response-type CDATA "text/html; charset=iso-8859-1"
1151
+ default-response-type CDATA "text/html; charset=iso-8859-1"
1152
+ ssl-enabled %boolean; "true">
1153
+
1154
+
1155
+ <!-- http-file-cache
1156
+
1157
+ attributes
1158
+ file-caching-enabled
1159
+ Enables the caching of file content if the file size is less
1160
+ than the one specified ny med-file-size-limit
1161
+ file-transmission-enabled
1162
+ This is valid on Windows only. Enables the TransmitFileSystem
1163
+ call.
1164
+ globally-enabled
1165
+ globally enables the file cache
1166
+ hash-init-size
1167
+ Initial no. of hash buckets.
1168
+ max-age-in-seconds
1169
+ Maximum age of a valid cache entry
1170
+ max-files-count
1171
+ Maximum no. of files in the file cache.
1172
+ medium-file-size-limit-in-bytes
1173
+ Maximum size of a cached file that can be stored as a memory
1174
+ mapped file.
1175
+ medium-file-space-in-bytes
1176
+ Total size of all files that are cached as memory mapped
1177
+ files.
1178
+ small-file-size-limit-in-bytes
1179
+ Maximum size of a file that can be read into memory.
1180
+ small-file-space-in-bytes
1181
+ Total size of the files that are read into memory.
1182
+
1183
+ Used in:
1184
+ http-service
1185
+ -->
1186
+ <!ELEMENT http-file-cache EMPTY>
1187
+
1188
+ <!ATTLIST http-file-cache
1189
+ globally-enabled %boolean; "true"
1190
+ file-caching-enabled %boolean; "on"
1191
+ max-age-in-seconds CDATA "30"
1192
+ medium-file-size-limit-in-bytes CDATA "537600"
1193
+ medium-file-space-in-bytes CDATA "10485760"
1194
+ small-file-size-limit-in-bytes CDATA "2048"
1195
+ small-file-space-in-bytes CDATA "1048576"
1196
+ file-transmission-enabled %boolean; "false"
1197
+ max-files-count CDATA "1024"
1198
+ hash-init-size CDATA "0">
1199
+
1200
+
1201
+ <!-- iiop-service
1202
+
1203
+ Used in:
1204
+ config
1205
+ -->
1206
+ <!ELEMENT iiop-service (orb, ssl-client-config?, iiop-listener*)>
1207
+
1208
+ <!ATTLIST iiop-service
1209
+ client-authentication-required %boolean; "false">
1210
+
1211
+
1212
+ <!-- orb
1213
+ Orb Configuration properties
1214
+
1215
+ attributes
1216
+ max-connections
1217
+ maximum number of incoming connections, on all listeners
1218
+ message-fragment-size
1219
+ GIOPv1.2 messages larger than this will get fragmented.
1220
+ Minimum value is 128.
1221
+ use-thread-pool-ids
1222
+ This would refer to the thread-pool-id(s) defined in the
1223
+ thread-pool sub-element of thread-pool-config element in
1224
+ server.xml. These would be the threadpool(s) used by the ORB.
1225
+ More than one thread-pool-id(s) could be specified by using
1226
+ commas to separate the names e.g. orb-thread-pool-1,
1227
+ orb-thread-pool-2
1228
+
1229
+ Used in:
1230
+ iiop-service
1231
+ -->
1232
+ <!ELEMENT orb (property*)>
1233
+
1234
+ <!ATTLIST orb
1235
+ use-thread-pool-ids CDATA #REQUIRED
1236
+ message-fragment-size CDATA "1024"
1237
+ max-connections CDATA "1024">
1238
+
1239
+
1240
+ <!-- ssl-client-config
1241
+ ssl-client-config element specifies the SSL configuration when
1242
+ the Application Server is making outbound IIOP/SSL connections.
1243
+
1244
+ Used in:
1245
+ iiop-service
1246
+ -->
1247
+ <!ELEMENT ssl-client-config (ssl)>
1248
+
1249
+
1250
+ <!-- iiop-listener
1251
+
1252
+ children
1253
+ ssl
1254
+ element specifies optional SSL configuration. Note that the
1255
+ ssl2 ciphers are not supported for iiop, and therefore must
1256
+ be disabled.
1257
+
1258
+ attributes
1259
+ address
1260
+ ip V6 or V4 address or hostname.
1261
+ enabled
1262
+ if false, a configured listener, is disabled
1263
+ id
1264
+ unique identifier for this listener.
1265
+ port
1266
+ port number
1267
+ security-enabled
1268
+ Determines whether the iiop listener runs SSL. You can turn
1269
+ SSL2 or SSL3 on or off and set ciphers using an ssl element
1270
+
1271
+ Used in:
1272
+ iiop-service
1273
+ -->
1274
+ <!ELEMENT iiop-listener (ssl?, property*)>
1275
+
1276
+ <!ATTLIST iiop-listener
1277
+ id CDATA #REQUIRED
1278
+ address CDATA #REQUIRED
1279
+ port CDATA "1072"
1280
+ security-enabled %boolean; "false"
1281
+ enabled %boolean; "true">
1282
+
1283
+
1284
+ <!-- admin-service
1285
+ Admin Service exists in every instance. It is the configuration
1286
+ for either a normal server, DAS or PE instance.
1287
+
1288
+ attributes
1289
+ type
1290
+ an instance can either be of type
1291
+ das
1292
+ Domain Administration Server in SE/EE or the PE instance
1293
+ das-and-server
1294
+ same as das
1295
+ server
1296
+ Any non-DAS instance in SE/EE. Not valid for PE.
1297
+
1298
+ Used in:
1299
+ config
1300
+ -->
1301
+ <!ELEMENT admin-service (jmx-connector*, das-config?, property*)>
1302
+
1303
+ <!ATTLIST admin-service
1304
+ type (das | das-and-server | server) "server"
1305
+ system-jmx-connector-name CDATA #IMPLIED>
1306
+
1307
+
1308
+ <!-- connector-service
1309
+ Configuration of the Connector Container. The attributes
1310
+ specified in the connector container would apply to all resource
1311
+ adapters deployed in this cluster/server-instance
1312
+
1313
+ attributes
1314
+ shutdown-timeout-in-seconds
1315
+ integer value (default 30 seconds). Represents the time-out,
1316
+ in seconds, that would be allowed by the application server,
1317
+ during shutdown, to call the ResourceAdapter.stop() method of
1318
+ this connector module's instance to complete.
1319
+
1320
+ Resource Adapters that take longer than the specified
1321
+ shutdown-timeout-in-seconds time interval would be ignored and the
1322
+ application server shutdown procedure would continue.
1323
+
1324
+
1325
+ Used in:
1326
+ config
1327
+ -->
1328
+ <!ELEMENT connector-service EMPTY>
1329
+
1330
+ <!ATTLIST connector-service
1331
+ shutdown-timeout-in-seconds CDATA "30">
1332
+
1333
+
1334
+ <!-- jmx-connector
1335
+ The jmx-connector element defines the configuration of a JSR 160
1336
+ compliant remote JMX Connector.
1337
+
1338
+ attributes
1339
+ accept-all
1340
+ Determines whether the connection can be made on all the
1341
+ network interfaces. A value of false implies that the
1342
+ connections only for this specific address will be selected.
1343
+ This attribute is ignored for SJS AS 8.1.
1344
+ address
1345
+ Specifies the IP address or host-name. Ignored for SJS AS 8.1.
1346
+ auth-realm-name
1347
+ The name of the auth-realm in this config element that
1348
+ represents the special administrative realm. All
1349
+ authentication (from administraive GUI and CLI) will be
1350
+ handled by this realm.
1351
+ enabled
1352
+ Defines if this connector is enabled. For EE this must be
1353
+ enabled.
1354
+ name
1355
+ name of jmx connector used for identification
1356
+ port
1357
+ Specifies the port of the jmx-connector-server. Note that
1358
+ jmx-service-uRL is a function of protocol, port and address
1359
+ as defined by the JSR 160 1.0 Specification.
1360
+ protocol
1361
+ Defines the protocol that this jmx-connector should support.
1362
+ Supported protocols are defined by Entity rjmx-protocol. SJS
1363
+ AS 8.1 PE/SE/EE supports "rmi_jrmp" protocol only. Other
1364
+ protocols can be used by user applications independently. For
1365
+ other protocols supported refer to documentation.
1366
+ security-enabled
1367
+ Decides whether the transport layer security be used in
1368
+ jmx-connector. If true, configure the ssl element.
1369
+
1370
+ Used in:
1371
+ admin-service, node-agent
1372
+ -->
1373
+ <!ELEMENT jmx-connector (ssl?, property*)>
1374
+
1375
+ <!ATTLIST jmx-connector
1376
+ name CDATA #REQUIRED
1377
+ enabled %boolean; "true"
1378
+ protocol %rjmx-protocol; "rmi_jrmp"
1379
+ address CDATA #REQUIRED
1380
+ port CDATA #REQUIRED
1381
+ accept-all %boolean; "false"
1382
+ auth-realm-name CDATA #REQUIRED
1383
+ security-enabled %boolean; "true">
1384
+
1385
+
1386
+ <!-- das-config
1387
+
1388
+ attributes
1389
+ admin-session-timeout-in-minutes
1390
+ timeout in minutes indicating the administration gui session
1391
+ timeout.
1392
+ autodeploy-dir
1393
+ The source directory (relative to instance root) from which
1394
+ autodeploy service will pick deployable components. You can
1395
+ also specify an absolute directory.
1396
+ autodeploy-enabled
1397
+ This will enable the autodeployment service. If true, the
1398
+ service will automatically starts with the admin-server. Auto
1399
+ Deployment is a feature that enables developers to quickly
1400
+ deploy applications and modules to a running application
1401
+ server withoutrequiring the developer to perform an explicit
1402
+ application server restart or separate deployment operation.
1403
+ autodeploy-jsp-precompilation-enabled
1404
+ If true, JSPs will be pre compiled during deployment of the
1405
+ war module(s).
1406
+ autodeploy-polling-interval-in-seconds
1407
+ The polling interval (in seconds), at the end of which
1408
+ autodeployment service will scan the source directory
1409
+ (specified by "autodeploy-dir" tag) for any new deployable
1410
+ component.
1411
+ autodeploy-verifier-enabled
1412
+ To enable/disable verifier, during auto-deployment. If true,
1413
+ verification will be done before any deployment activity. In
1414
+ the event of any verifier test failure, deployment is not
1415
+ performed.
1416
+ deploy-xml-validation
1417
+ specifies if descriptor validation is required or not.
1418
+
1419
+ full
1420
+ xml will be validated and in case of xml validation
1421
+ errors, deployment will fail.
1422
+ parsing
1423
+ xml errors will be reported but deployment process will
1424
+ continue.
1425
+ none
1426
+ no xml validation will be perfomed on the standard or
1427
+ runtime deployment descriptors.
1428
+
1429
+ dynamic-reload-enabled
1430
+ when true, server checks timestamp on a .reload file at every
1431
+ module and application directory level to trigger reload.
1432
+ polling frequency is controlled by
1433
+ reload-poll-interval-in-seconds
1434
+
1435
+ Used in:
1436
+ admin-service
1437
+ -->
1438
+ <!ELEMENT das-config (property*)>
1439
+
1440
+ <!ATTLIST das-config
1441
+ dynamic-reload-enabled %boolean; "false"
1442
+ dynamic-reload-poll-interval-in-seconds CDATA "2"
1443
+ autodeploy-enabled %boolean; "false"
1444
+ autodeploy-polling-interval-in-seconds CDATA "2"
1445
+ autodeploy-dir CDATA "autodeploy"
1446
+ autodeploy-verifier-enabled %boolean; "false"
1447
+ autodeploy-jsp-precompilation-enabled %boolean; "false"
1448
+ deploy-xml-validation %validation-level; "full"
1449
+ admin-session-timeout-in-minutes CDATA "60">
1450
+
1451
+
1452
+ <!-- web-container
1453
+
1454
+ Used in:
1455
+ config
1456
+ -->
1457
+ <!ELEMENT web-container (session-config?, property*)>
1458
+
1459
+
1460
+ <!-- session-config
1461
+
1462
+ Used in:
1463
+ web-container
1464
+ -->
1465
+ <!ELEMENT session-config (session-manager?, session-properties?)>
1466
+
1467
+
1468
+ <!-- session-manager
1469
+
1470
+ Used in:
1471
+ session-config
1472
+ -->
1473
+ <!ELEMENT session-manager (manager-properties?, store-properties?)>
1474
+
1475
+
1476
+ <!-- manager-properties
1477
+
1478
+ Used in:
1479
+ session-manager
1480
+ -->
1481
+ <!ELEMENT manager-properties (property*)>
1482
+
1483
+ <!ATTLIST manager-properties
1484
+ session-file-name CDATA #IMPLIED
1485
+ reap-interval-in-seconds CDATA #IMPLIED
1486
+ max-sessions CDATA #IMPLIED
1487
+ session-id-generator-classname CDATA #IMPLIED>
1488
+
1489
+
1490
+ <!-- store-properties
1491
+
1492
+ Used in:
1493
+ session-manager
1494
+ -->
1495
+ <!ELEMENT store-properties (property*)>
1496
+
1497
+ <!ATTLIST store-properties
1498
+ directory CDATA #IMPLIED
1499
+ reap-interval-in-seconds CDATA #IMPLIED>
1500
+
1501
+
1502
+ <!-- session-properties
1503
+
1504
+ Used in:
1505
+ session-config
1506
+ -->
1507
+ <!ELEMENT session-properties (property*)>
1508
+
1509
+ <!ATTLIST session-properties
1510
+ timeout-in-seconds CDATA #IMPLIED>
1511
+
1512
+
1513
+ <!-- ejb-container
1514
+ Configuration of EJB Container.
1515
+
1516
+ children
1517
+ ejb-timer-service
1518
+ The ejb-timer-service element contains the configuration for
1519
+ the ejb timer service. There is at most one ejb timer service
1520
+ per server instance.
1521
+
1522
+ attributes
1523
+ cache-idle-timeout-in-seconds
1524
+ (eb, sfsb) specifies the rate at which the cache cleaner
1525
+ thread is scheduled. All idle instances are passivated at
1526
+ once.
1527
+ cache-resize-quantity
1528
+ (eb,sfsb) Cache elements have identity, hence growth is in
1529
+ unit steps and created on demand. Shrinking of cache happens
1530
+
1531
+ when cache-idle-timeout-in-seconds timer expires and a cleaner thread
1532
+ passivates beans which have been idle for longer than
1533
+ cache-idle-timeout-in-seconds. All idle instances are passivated at
1534
+ once. cache-resize-quantity does not apply in this case.
1535
+
1536
+ when max cache size is reached, an asynchronous task is created to
1537
+ bring the size back under the max-cache-size limit. This task removes
1538
+ cache-resize-quantity elements, consulting the victim-selection-policy.
1539
+
1540
+ Must be greater than 1 and less than max-cache-size.
1541
+
1542
+ commit-option
1543
+ (eb) Entity Beans caching is controlled by this setting.
1544
+ Commit Option C implies that no caching is performed in the
1545
+ container.
1546
+ max-cache-size
1547
+ (sfsb,eb) specifies the maximum number of instances that can
1548
+ be cached. For entity beans, internally two caches are
1549
+ maintained for higher concurrency: (i) Ready (R$) (ii) Active
1550
+ in an Incomplete Transaction (TX$). The TX$ is populated with
1551
+ instances from R$ or from the Pool directly. When an instance
1552
+ in TX$ completes the transaction, it is placed back in the R$
1553
+ (or in pool, in case an instance with same identity already
1554
+ is in R$). max-cache-size only specifies the upper limit for
1555
+ R$. The container computes an appropriate size for TX$. For
1556
+ SFSBs, after the max-cache-size is reached, beans (as
1557
+ determined by the victim-selection-policy) get passivated.
1558
+ max-pool-size
1559
+ (slsb,eb) maximum size, a pool can grow to. A value of 0
1560
+ implies an unbounded pool. Unbounded pools eventually shrink
1561
+ to the steady-pool-size, in steps defined by
1562
+ pool-resize-quantity.
1563
+ pool-idle-timeout-in-seconds
1564
+ (slsb,eb) defines the rate at which the pool cleaning thread
1565
+ is executed. this thread checks if current size is greater
1566
+ than steady pool size, it removes pool-resize-quantity
1567
+ elements. If the current size is less than steady-pool-size
1568
+ it is increased by pool-resize-quantity, with a ceiling of
1569
+ min (current-pool-size + pool-resize-quantity, max-pool-size)
1570
+ Only objects that have not been accessed for more than
1571
+ pool-idle-timeout-in-seconds are candidates for removal.
1572
+ pool-resize-quantity
1573
+ (slsb,eb) size of bean pool grows (shrinks) in steps
1574
+ specified by pool-resize-quantity, subject to max-pool-size
1575
+ (steady-pool-size) limit.
1576
+ removal-timeout-in-seconds
1577
+ (sfsb) Instance is removed from cache or passivation store,
1578
+ if it is not accesed within this time. All instances that can
1579
+ be removed, will be removed.
1580
+ session-store
1581
+ specifies the directory where passivated beans and persisted
1582
+ HTTP sessions are stored on the file system. Defaults to
1583
+ $INSTANCE-ROOT/session-store
1584
+ steady-pool-size
1585
+ (slsb,eb) number of bean instances normally maintained in
1586
+ pool. When a pool is first created, it will be populated with
1587
+ size equal to steady-pool-size. When an instance is removed
1588
+ from the pool, it is replenished asynchronously, so that the
1589
+ pool size is at or above the steady-pool-size. This additions
1590
+ will be in multiples of pool-resize-quantity. When a bean is
1591
+ disassociated from a method invocation, it is put back in the
1592
+ pool, subject to max-pool-size limit. If the max pool size is
1593
+ exceeded the bean id destroyed immediately. A pool cleaning
1594
+ thread, executes at an interval defined by
1595
+ pool-idle-timeout-in-seconds. This thread reduces the pool
1596
+ size to steady-pool-size, in steps defined by
1597
+ pool-resize-quantity. If the pool is empty, the required
1598
+ object will be created and returned immediately. This
1599
+ prevents threads from blocking till the pool is replenished
1600
+ by the background thread. steady-pool-size must be greater
1601
+ than 1 and at most equal to the max-pool-size.
1602
+ victim-selection-policy
1603
+ (sfsb) Victim selection policy when cache needs to shrink.
1604
+ Victims are passivated. Entity Bean Victims are selected
1605
+ always using fifo discipline. Does not apply to slsb because
1606
+ it does not matter, which particular instances are removed.
1607
+ fifo
1608
+ method picks victims, oldest instance first.
1609
+ lru
1610
+ algorithm picks least recently accessed instances.
1611
+ nru
1612
+ policy tries to pick 'not recently used' instances and is
1613
+ a pseudo-random selection process.
1614
+
1615
+ Used in:
1616
+ config
1617
+ -->
1618
+ <!ELEMENT ejb-container (ejb-timer-service?, property*)>
1619
+
1620
+ <!ATTLIST ejb-container
1621
+ steady-pool-size CDATA "32"
1622
+ pool-resize-quantity CDATA "16"
1623
+ max-pool-size CDATA "64"
1624
+ cache-resize-quantity CDATA "32"
1625
+ max-cache-size CDATA "512"
1626
+ pool-idle-timeout-in-seconds CDATA "600"
1627
+ cache-idle-timeout-in-seconds CDATA "600"
1628
+ removal-timeout-in-seconds CDATA "5400"
1629
+ victim-selection-policy (fifo | lru | nru) "nru"
1630
+ commit-option (B | C) "B"
1631
+ session-store CDATA #IMPLIED>
1632
+
1633
+
1634
+ <!-- ejb-timer-service
1635
+ Configuration for ejb timer service.
1636
+
1637
+ attributes
1638
+ max-redeliveries
1639
+ is the maximum number of times the ejb timer service will
1640
+ attempt to redeliver a timer expiration due to exception or
1641
+ rollback. The minimum value is 1, per the ejb specification.
1642
+ minimum-delivery-interval-in-millis
1643
+ is the minimum number of milliseconds allowed before the next
1644
+ timer expiration for a particular timer can occur. It guards
1645
+ against extremely small timer increments that can overload
1646
+ the server.
1647
+ redelivery-interval-internal-in-millis
1648
+ is the number of milliseconds the ejb timer service will wait
1649
+ after a failed ejbTimeout delivery before attempting a
1650
+ redelivery.
1651
+ timer-datasource
1652
+ overrides the cmp-resource (jdbc/__TimerPool) specified in
1653
+ sun-ejb-jar.xml of (__ejb_container_timer_app) of the timer
1654
+ service system application. By default this is set to
1655
+ jdbc/__TimerPool, but can be overridden for the cluster or
1656
+ server instance, if they choose to.
1657
+
1658
+ Used in:
1659
+ ejb-container
1660
+ -->
1661
+ <!ELEMENT ejb-timer-service (property*)>
1662
+
1663
+ <!ATTLIST ejb-timer-service
1664
+ minimum-delivery-interval-in-millis CDATA "7000"
1665
+ max-redeliveries CDATA "1"
1666
+ timer-datasource CDATA #IMPLIED
1667
+ redelivery-interval-internal-in-millis CDATA "5000">
1668
+
1669
+
1670
+ <!-- mdb-container
1671
+
1672
+ attributes
1673
+ idle-timeout-in-seconds
1674
+ idle bean instance in pool becomes a candidate for deletion,
1675
+ when this timeout expires.
1676
+ max-pool-size
1677
+ maximum size, pool can grow to. A non-negative integer.
1678
+ pool-resize-quantity
1679
+ quantum of increase/decrease, when the size of pool
1680
+ grows/shrinks. An integer in the range [0, max-pool-size].
1681
+ steady-pool-size
1682
+ minimum and initial number of message driven beans in pool.
1683
+ An integer in the range [0, max-pool-size].
1684
+
1685
+ Used in:
1686
+ config
1687
+ -->
1688
+ <!ELEMENT mdb-container (property*)>
1689
+
1690
+ <!ATTLIST mdb-container
1691
+ steady-pool-size CDATA "10"
1692
+ pool-resize-quantity CDATA "2"
1693
+ max-pool-size CDATA "60"
1694
+ idle-timeout-in-seconds CDATA "600">
1695
+
1696
+
1697
+ <!-- jms-service
1698
+ The jms-service element specifies information about the
1699
+ bundled/built-in JMS service that is managed by Application
1700
+ Server.
1701
+
1702
+ attributes
1703
+ addresslist-behavior
1704
+ Determines broker selection from imqAddressList.
1705
+ random
1706
+ causes selection to be performed randomly
1707
+ priority
1708
+ causes selection to be performed sequentially
1709
+ addresslist-iterations
1710
+ Number of times reconnect logic should iterate
1711
+ imqAddressList. This property will not be used if the
1712
+ addresslist-behavior is "random". An integer.
1713
+ default-jms-host
1714
+ reference to a jms-host that to be started when type of
1715
+ jms-service is LOCAL.
1716
+ init-timeout-in-seconds
1717
+ specifies the time server instance will wait at start up, for
1718
+ its corresponding JMS service instance to respond. If there
1719
+ is no response within the specifies timeout period,
1720
+ application server startup is aborted. Default value of 60
1721
+ seconds.
1722
+ mq-scheme
1723
+ Scheme for establishing connection with broker. For example,
1724
+ scheme can be specified as "http" for connecting to MQ broker
1725
+ over http. Default is "mq".
1726
+ mq-service
1727
+ Type of broker service. If a broker supports ssl, then the
1728
+ type of service can be "ssljms". If nothing is specified, MQ
1729
+ will assume 4that service is "jms".
1730
+ reconnect-attempts
1731
+ Total number of attempts to reconnect. An integer.
1732
+ reconnect-enabled
1733
+ Causes reconnect feature to be enabled (true) or disabled
1734
+ (false). A boolean.
1735
+ reconnect-interval-in-seconds
1736
+ Interval between reconnect attempts, in seconds. An integer.
1737
+ start-args
1738
+ specifies the arguments that will be supplied to start up the
1739
+ corresponding JMS service instance.
1740
+ type
1741
+ Type of JMS service.
1742
+
1743
+ Used in:
1744
+ config
1745
+ -->
1746
+ <!ELEMENT jms-service (jms-host*, property*)>
1747
+
1748
+ <!ATTLIST jms-service
1749
+ init-timeout-in-seconds CDATA "60"
1750
+ type (LOCAL | EMBEDDED | REMOTE) #REQUIRED
1751
+ start-args CDATA #IMPLIED
1752
+ default-jms-host CDATA #IMPLIED
1753
+ reconnect-interval-in-seconds CDATA "5"
1754
+ reconnect-attempts CDATA "3"
1755
+ reconnect-enabled %boolean; "true"
1756
+ addresslist-behavior (random | priority) "random"
1757
+ addresslist-iterations CDATA "3"
1758
+ mq-scheme CDATA #IMPLIED
1759
+ mq-service CDATA #IMPLIED>
1760
+
1761
+
1762
+ <!-- jms-host
1763
+
1764
+ attributes
1765
+ admin-password
1766
+ attribute specifies the admin password.
1767
+ admin-user-name
1768
+ specifies the admin username.
1769
+ host
1770
+ ip V6 or V4 address or hostname.
1771
+ port
1772
+ the port number used by the JMS service.
1773
+
1774
+ Used in:
1775
+ jms-service
1776
+ -->
1777
+ <!ELEMENT jms-host (property*)>
1778
+
1779
+ <!ATTLIST jms-host
1780
+ name CDATA #REQUIRED
1781
+ host CDATA #IMPLIED
1782
+ port CDATA "7676"
1783
+ admin-user-name CDATA "admin"
1784
+ admin-password CDATA "admin">
1785
+
1786
+
1787
+ <!-- log-service
1788
+ By default, logs would be kept in $INSTANCE-ROOT/logs. The
1789
+ following log files will be stored under the logs directory.
1790
+
1791
+ access.log
1792
+ keeps default virtual server HTTP access messages.
1793
+ server.log
1794
+ keeps log messages from default virtual server. Messages from
1795
+ other configured virtual servers also go here, unless
1796
+ log-file is explicitly specified in the virtual-server
1797
+ element.
1798
+
1799
+
1800
+ attributes
1801
+ alarms
1802
+ if true, will turn on alarms for the logger. The SEVERE and
1803
+ WARNING messages can be routed through the JMX framework to
1804
+ raise SEVERE and WARNING alerts. Alarms are turned off by
1805
+ default.
1806
+ file
1807
+ can be used to rename or relocate server.log using absolute
1808
+ path.
1809
+ log-filter
1810
+ Can plug in a log filter to do custom filtering of log
1811
+ records . By default there is no log filter other than the
1812
+ log level filtering provided by JSR 047 log API.
1813
+ log-handler
1814
+ Can plug in a custom log handler to add it to the chain of
1815
+ handlers to log into a different log destination than the
1816
+ default ones given by the system (which are Console, File and
1817
+ Syslog). It is a requirement that customers use the log
1818
+ formatter provided by the the system to maintain uniformity
1819
+ in log messages. The custom log handler will be added at the
1820
+ end of the handler chain after File + Syslog Handler, Console
1821
+ Handler and JMX Handler. User cannot replace the handler
1822
+ provided by the system, because of loosing precious log
1823
+ statements. The Server Initialization will take care of
1824
+ installing the custom handler with the system formatter
1825
+ initialized. The user need to use JSR 047 Log Handler
1826
+ Interface to implement the custom handler.
1827
+ log-rotation-limit-in-bytes
1828
+ Log Files will be rotated when the file size reaches the
1829
+ limit.
1830
+ log-rotation-timelimit-in-minutes
1831
+ This is a new attribute to enable time based log rotation.
1832
+ The Log File will be rotated only if this value is non-zero
1833
+ and the valid range is 60 minutes (1 hour) to 10*24*60
1834
+ minutes (10 days). If the value is zero then the files will
1835
+ be rotated based on size specified in
1836
+ log-rotation-limit-in-bytes.
1837
+ log-to-console
1838
+ logs will be sent to stderr when asadmin start-domain verbose
1839
+ is used
1840
+ retain-error-statistics-for-hours
1841
+ The number of hours since server start, for which error
1842
+ statistics should be retained in memory. The default and
1843
+ minimum value is 5 hours. The maximum value allowed is 500
1844
+ hours. Note that larger values will incur additional memory
1845
+ overhead.
1846
+ use-system-logging
1847
+ if true, will utilize Unix syslog service or Windows Event
1848
+ Logging to produce and manage logs.
1849
+
1850
+ Used in:
1851
+ config, node-agent
1852
+ -->
1853
+ <!ELEMENT log-service (module-log-levels?, property*)>
1854
+
1855
+ <!ATTLIST log-service
1856
+ file CDATA #IMPLIED
1857
+ use-system-logging %boolean; "false"
1858
+ log-handler CDATA #IMPLIED
1859
+ log-filter CDATA #IMPLIED
1860
+ log-to-console %boolean; "false"
1861
+ log-rotation-limit-in-bytes CDATA "500000"
1862
+ log-rotation-timelimit-in-minutes CDATA "0"
1863
+ alarms %boolean; "false"
1864
+ retain-error-statistics-for-hours CDATA "5">
1865
+
1866
+
1867
+ <!-- module-log-levels
1868
+
1869
+ Used in:
1870
+ log-service
1871
+ -->
1872
+ <!ELEMENT module-log-levels (property*)>
1873
+
1874
+ <!ATTLIST module-log-levels
1875
+ root %log-level; "INFO"
1876
+ server %log-level; "INFO"
1877
+ ejb-container %log-level; "INFO"
1878
+ cmp-container %log-level; "INFO"
1879
+ mdb-container %log-level; "INFO"
1880
+ web-container %log-level; "INFO"
1881
+ classloader %log-level; "INFO"
1882
+ configuration %log-level; "INFO"
1883
+ naming %log-level; "INFO"
1884
+ security %log-level; "INFO"
1885
+ jts %log-level; "INFO"
1886
+ jta %log-level; "INFO"
1887
+ admin %log-level; "INFO"
1888
+ deployment %log-level; "INFO"
1889
+ verifier %log-level; "INFO"
1890
+ jaxr %log-level; "INFO"
1891
+ jaxrpc %log-level; "INFO"
1892
+ saaj %log-level; "INFO"
1893
+ corba %log-level; "INFO"
1894
+ javamail %log-level; "INFO"
1895
+ jms %log-level; "INFO"
1896
+ connector %log-level; "INFO"
1897
+ jdo %log-level; "INFO"
1898
+ cmp %log-level; "INFO"
1899
+ util %log-level; "INFO"
1900
+ resource-adapter %log-level; "INFO"
1901
+ synchronization %log-level; "INFO"
1902
+ node-agent %log-level; "INFO"
1903
+ self-management %log-level; "INFO"
1904
+ group-management-service %log-level; "INFO"
1905
+ management-event %log-level; "INFO">
1906
+
1907
+
1908
+ <!-- security-service
1909
+ The security service element defines parameters and configuration
1910
+ information needed by the core J2EE security service. Some
1911
+ container-specific security configuration elements are in the
1912
+ various container configuration elements and not here. SSL
1913
+ configuration is also elsewhere. At this time the security
1914
+ service configuration consists of a set of authentication realms.
1915
+ A number of top-level attributes are defined as well.
1916
+
1917
+ children
1918
+ message-security-config
1919
+ Optional list of layer specific lists of configured message
1920
+ security providers.
1921
+
1922
+ attributes
1923
+ activate-default-principal-to-role-mapping
1924
+ Causes the appserver to apply a default principal to role
1925
+ mapping, to any application that does not have an application
1926
+ specific mapping defined. Every role is mapped to a
1927
+ same-named (as the role) instance of a
1928
+ java.security.Principal implementation class (see
1929
+ mapped-principal-class). This behavior is similar to that of
1930
+ Tomcat servlet container. It is off by default.
1931
+ anonymous-role
1932
+ Used as role name for default/anonymous role.
1933
+ audit-enabled
1934
+ If true, additional access logging is performed to provide
1935
+ audit information.
1936
+ audit-modules
1937
+ Optional list of audit provider modules which will be used by
1938
+ the audit subsystem. The default value refers to the internal
1939
+ log-based audit module.
1940
+ default-principal
1941
+ Used as the identity of default security contexts when
1942
+ necessary and no principal is provided.
1943
+ default-principal-password
1944
+ Password of default principal.
1945
+ default-realm
1946
+ Specifies which realm (by name) is used by default when no
1947
+ realm is specifically requested. The file realm is the common
1948
+ default.
1949
+ jacc
1950
+ Specifies the name of the jacc-provider element to use for
1951
+ setting up the JACC infrastructure. The default value
1952
+ "default" does not need to be changed unless adding a custom
1953
+ JACC provider.
1954
+ mapped-principal-class
1955
+ This attribute is used to customize the
1956
+ java.security.Principal implementation class used in the
1957
+ default principal to role mapping. This attribute is
1958
+ optional. When it is not specified,
1959
+ com.sun.enterprise.deployment.Group implementation of
1960
+ java.security.Principal is used. The value of this attribute
1961
+ is only relevant when the activate-default
1962
+ principal-to-role-mapping attribute is set to true.
1963
+
1964
+ Used in:
1965
+ config
1966
+ -->
1967
+ <!ELEMENT security-service
1968
+ (auth-realm+, jacc-provider+, audit-module*, message-security-config*,
1969
+ property*)>
1970
+
1971
+
1972
+ <!ATTLIST security-service
1973
+ default-realm CDATA "file"
1974
+ default-principal CDATA #IMPLIED
1975
+ default-principal-password CDATA #IMPLIED
1976
+ anonymous-role CDATA "ANYONE"
1977
+ audit-enabled %boolean; "false"
1978
+ jacc CDATA "default"
1979
+ audit-modules CDATA "default"
1980
+ activate-default-principal-to-role-mapping %boolean; "false"
1981
+ mapped-principal-class CDATA #IMPLIED>
1982
+
1983
+
1984
+ <!-- audit-module
1985
+ An audit-module specifies an optional plug-in module which
1986
+ implements audit capabilities.
1987
+
1988
+ attributes
1989
+ classname
1990
+ defines the java class which implements this audit module
1991
+ name
1992
+ defines the name of this realm
1993
+
1994
+ Used in:
1995
+ security-service
1996
+ -->
1997
+ <!ELEMENT audit-module (property*)>
1998
+
1999
+ <!ATTLIST audit-module
2000
+ name CDATA #REQUIRED
2001
+ classname CDATA #REQUIRED>
2002
+
2003
+
2004
+ <!-- auth-realm
2005
+ The auth-realm element defines and configures one authentication
2006
+ realm. There must be at least one realm available for a server
2007
+ instance; any number can be configured, as desired.
2008
+
2009
+ Authentication realms need provider-specific parameters which vary
2010
+ depending on what a particular implementation needs; these are defined as
2011
+ properties since they vary by provider and cannot be predicted for any
2012
+ custom or add-on providers.
2013
+
2014
+ For the default file provider, the param used is: file
2015
+
2016
+
2017
+ attributes
2018
+ classname
2019
+ defines the java class which implements this realm
2020
+ name
2021
+ defines the name of this realm
2022
+
2023
+ Used in:
2024
+ node-agent, security-service
2025
+ -->
2026
+ <!ELEMENT auth-realm (property*)>
2027
+
2028
+ <!ATTLIST auth-realm
2029
+ name CDATA #REQUIRED
2030
+ classname CDATA #REQUIRED>
2031
+
2032
+
2033
+ <!-- jacc-provider
2034
+ The jacc-provider element defines the standard JACC properties
2035
+ used for setting up the JACC provider. It also allows optional
2036
+ properties which can be used by the provider implementation for
2037
+ its configuration.
2038
+
2039
+ attributes
2040
+ name
2041
+ A name for this jacc-provider. Is always "default" for the
2042
+ default provider.
2043
+ policy-configuration-factory-provider
2044
+ Corresponds to (and can be overridden by) the system property
2045
+ javax.security.jacc.PolicyConfigurationFactory.provider
2046
+ policy-provider
2047
+ Corresponds to (and can be overridden by) the system property
2048
+ javax.security.jacc.policy.provider
2049
+
2050
+ Used in:
2051
+ security-service
2052
+ -->
2053
+ <!ELEMENT jacc-provider (property*)>
2054
+
2055
+ <!ATTLIST jacc-provider
2056
+ name CDATA #REQUIRED
2057
+ policy-provider CDATA #REQUIRED
2058
+ policy-configuration-factory-provider CDATA #REQUIRED>
2059
+
2060
+
2061
+ <!-- transaction-service
2062
+ Configuration for Transaction Manager.
2063
+
2064
+ attributes
2065
+ automatic-recovery
2066
+ if true, server instance attempts recovery at restart.
2067
+ heuristic-decision
2068
+ During recovery, if outcome of a transaction cannot be
2069
+ determined from the logs, then this property is used to fix
2070
+ the outcome.
2071
+ keypoint-interval
2072
+ property used to specify the number of transactions between
2073
+ keypoint operations on the log. A Keypoint operations could
2074
+ reduce the size of the transaction log files. A larger value
2075
+ for this property (for example, 1000) will result in larger
2076
+ transaction log files, between log compactions, but less
2077
+ keypoint operations, and potentially better performance. A
2078
+ smaller value (e.g. 20) results in smaller log files but
2079
+ slightly reduced performance due to the greater frequency of
2080
+ keypoint operations.
2081
+ retry-timeout-in-seconds
2082
+ used to determine the retry time in the following scenarios.
2083
+
2084
+ 1 Time to wait at the transaction recovery time, when
2085
+ resources are unreachable.
2086
+ 2 If there are any transient
2087
+ exceptions in the second phase of the 2 PC protocol.
2088
+
2089
+ A negative value indicates infinite retry. '0' indicates no
2090
+ retry. A positive value indicates the number of seconds for
2091
+ which retry will be attempted. Default is 10 minutes which
2092
+ may be appropriate for a database being restarted.
2093
+ timeout-in-seconds
2094
+ amount of time the transaction manager waits for response
2095
+ from a datasource participating in transaction. A value of 0
2096
+ implies infinite timeout.
2097
+ tx-log-dir
2098
+ Transaction service creates a sub directory 'tx' under
2099
+ tx-log-dir to store the transaction logs. The default value
2100
+ of the tx-log-dir is $INSTANCE-ROOT/logs. If this attribute
2101
+ is not explicitly specified in the <transaction-service>
2102
+ element, 'tx' sub directory will be created under the path
2103
+ specified in log-root attribute of <domain> element.
2104
+
2105
+ Used in:
2106
+ config
2107
+ -->
2108
+ <!ELEMENT transaction-service (property*)>
2109
+
2110
+ <!ATTLIST transaction-service
2111
+ automatic-recovery %boolean; "false"
2112
+ timeout-in-seconds CDATA "0"
2113
+ tx-log-dir CDATA #IMPLIED
2114
+ heuristic-decision (rollback | commit) "rollback"
2115
+ retry-timeout-in-seconds CDATA "600"
2116
+ keypoint-interval CDATA "2048">
2117
+
2118
+
2119
+ <!-- monitoring-service
2120
+
2121
+ Used in:
2122
+ config
2123
+ -->
2124
+ <!ELEMENT monitoring-service (module-monitoring-levels?, property*)>
2125
+
2126
+
2127
+ <!-- module-monitoring-levels
2128
+
2129
+ attributes
2130
+ connector-connection-pool
2131
+ monitoring level for all the connector-connection-pools used
2132
+ by the runtime.
2133
+ ejb-container
2134
+ various ejbs deployed to the server, ejb-pools, ejb-caches
2135
+ and ejb-methods.
2136
+ http-service
2137
+ http engine and the http listeners therein.
2138
+ jdbc-connection-pool
2139
+ monitoring level for all the jdbc-connection-pools used by
2140
+ the runtime.
2141
+ orb
2142
+ specifies the level for connection managers of the orb, which
2143
+ apply to connections to the orb
2144
+ thread-pool
2145
+ all the thread-pools used by the run time.
2146
+ transaction-service
2147
+ transaction subsystem.
2148
+
2149
+ Used in:
2150
+ monitoring-service
2151
+ -->
2152
+ <!ELEMENT module-monitoring-levels (property*)>
2153
+
2154
+ <!ATTLIST module-monitoring-levels
2155
+ thread-pool %monitoring-level; "OFF"
2156
+ orb %monitoring-level; "OFF"
2157
+ ejb-container %monitoring-level; "OFF"
2158
+ web-container %monitoring-level; "OFF"
2159
+ transaction-service %monitoring-level; "OFF"
2160
+ http-service %monitoring-level; "OFF"
2161
+ jdbc-connection-pool %monitoring-level; "OFF"
2162
+ connector-connection-pool %monitoring-level; "OFF"
2163
+ connector-service %monitoring-level; "OFF"
2164
+ jms-service %monitoring-level; "OFF"
2165
+ jvm %monitoring-level; "OFF">
2166
+
2167
+
2168
+ <!-- diagnostic-service
2169
+
2170
+ attributes
2171
+ capture-app-dd
2172
+ boolean attribute. If "true", application deployment
2173
+ descriptors in plain text are captured as part of diagnostic
2174
+ report. If Deployment descriptors contain any confidential
2175
+ information, it's recommended to set it to false.
2176
+ capture-hadb-info
2177
+ boolean attribute to indicate whether HADB related
2178
+ information is collected.
2179
+ capture-install-log
2180
+ boolean attribute which indicated whether the log generated
2181
+ during installation of the application server is captured.
2182
+ capture-system-info
2183
+ boolean attribute which specifies whether OS level
2184
+ information is collected as part of diagnostic report.
2185
+ compute-checksum
2186
+ boolean attribute. Indicates whether checksum of binaries is
2187
+ computed.
2188
+ max-log-entries
2189
+ Max no. of log entries being captured as part of diagnostic
2190
+ report. A non negative value.
2191
+ min-log-level
2192
+ The log levels can be changed using one of the seven levels.
2193
+ Please refer JSR 047 to understand the Log Levels. The
2194
+ default level is INFO, meaning that messages at that level or
2195
+ higher (WARNING, SEVERE) are captured as part of the
2196
+ diagnostic report.If set to OFF, log contents will not be
2197
+ captured as part of diagnostic report.
2198
+ verify-config
2199
+ A boolean attribute which indicates whether output of
2200
+ verify-config asadmin command is included in the diagnostic
2201
+ report.
2202
+
2203
+ Used in:
2204
+ config
2205
+ -->
2206
+ <!ELEMENT diagnostic-service (property*)>
2207
+
2208
+ <!ATTLIST diagnostic-service
2209
+ compute-checksum %boolean; "true"
2210
+ verify-config %boolean; "true"
2211
+ capture-install-log %boolean; "true"
2212
+ capture-system-info %boolean; "true"
2213
+ capture-hadb-info %boolean; "true"
2214
+ capture-app-dd %boolean; "true"
2215
+ min-log-level %log-level; "INFO"
2216
+ max-log-entries CDATA "500">
2217
+
2218
+
2219
+ <!-- group-management-service
2220
+ group-management-service(GMS) is an in-process service that
2221
+ provides cluster monitoring and group communication services. GMS
2222
+ notifies registered modules in an application server instance
2223
+ when one or more members in the cluster fail (become
2224
+ unreachable). GMS also provides the ability to send and receive
2225
+ messages between a group of processes. GMS is a abstraction layer
2226
+ that plugs-in group communication technologies which rely on a
2227
+ configurable stack of protocols. Each of these protocols has
2228
+ properties that can be changed for a given network and deployment
2229
+ topology. These relevant configurable protocols are: fd-protocol
2230
+ enables its members to periodically monitor other group members
2231
+ to determine their availability in the group. merge-protocol is
2232
+ used to reunite subgroups that formed as a result of a network
2233
+ partition after such a partition has healed. ping-protocol is
2234
+ used for discovery of the group and its members. vs-protocol
2235
+ verifies suspect instances by adding a verification layer to mark
2236
+ a failure suspicion as a confirmed failure.
2237
+
2238
+ attributes
2239
+ fd-protocol-max-tries
2240
+ Maximum number of attempts to try before GMS confirms that a
2241
+ failure is suspected in the group. Must be a positive integer.
2242
+ fd-protocol-timeout-in-millis
2243
+ Period of time between monitoring attempts to detect failure.
2244
+ Must be a positive integer.
2245
+ merge-protocol-max-interval-in-millis
2246
+ Specifies the maximum amount of time to wait to collect
2247
+ sub-group information before performing a merge. Must be a
2248
+ positive integer.
2249
+ merge-protocol-min-interval-in-millis
2250
+ specifies the minimum amount of time to wait to collect
2251
+ sub-group information before performing a merge. Must be a
2252
+ positive integer.
2253
+ ping-protocol-timeout-in-millis
2254
+ Amount of time in milliseconds that GMS waits for discovery
2255
+ of other members in this group. Must be a positive integer.
2256
+ vs-protocol-timeout-in-millis
2257
+ After this timeout a suspected failure is marked as verified.
2258
+ Must be a positive integer.
2259
+
2260
+ Used in:
2261
+ config
2262
+ -->
2263
+ <!ELEMENT group-management-service (property*)>
2264
+
2265
+ <!ATTLIST group-management-service
2266
+ fd-protocol-max-tries CDATA "3"
2267
+ fd-protocol-timeout-in-millis CDATA "2000"
2268
+ merge-protocol-max-interval-in-millis CDATA "10000"
2269
+ merge-protocol-min-interval-in-millis CDATA "5000"
2270
+ ping-protocol-timeout-in-millis CDATA "2000"
2271
+ vs-protocol-timeout-in-millis CDATA "1500">
2272
+
2273
+
2274
+ <!-- java-config
2275
+ Java Runtime environment configuration
2276
+
2277
+ attributes
2278
+ bytecode-preprocessors
2279
+ A comma separated list of classnames, each of which must
2280
+ implement the com.sun.appserv.BytecodePreprocessor interface.
2281
+ Each of the specified preprocessor class will be called in
2282
+ the order specified. At the moment the comelling use is for a
2283
+ 3rd party Performance Profiling tool.
2284
+ classpath-prefix
2285
+ A java classpath string that is prefixed to server-classpath
2286
+ classpath-suffix
2287
+ A java classpath string that is appended to server-classpath
2288
+ debug-enabled
2289
+ If set to true, the server starts up in debug mode ready for
2290
+ attaching with a JPDA based debugger.
2291
+ debug-options
2292
+ JPDA based debugging options string.
2293
+ env-classpath-ignored
2294
+ If set to false, the CLASSPATH environment variable will be
2295
+ read and appended to the Application Server classpath, which
2296
+ is constructed as described above. The CLASSPATH environment
2297
+ variable will be added after the classpath-suffix, at the
2298
+ very end.
2299
+ javac-options
2300
+ Options string passed to Java compiler, at application
2301
+ deployment time.
2302
+ java-home
2303
+ Specifies the installation directory for Java runtime. JDK
2304
+ 1.4 or higher is supported.
2305
+ native-library-path-prefix
2306
+ is prepended to the native library path, which is constructed
2307
+ internally.
2308
+
2309
+ Internally, the native library path is automatically constructed to be
2310
+ a concatenation of Application Server installation relative path for
2311
+ its native shared libraries, standard JRE native library path, the
2312
+ shell environment setting (LD-LIBRARY-PATH on Unix) and any path that
2313
+ may be specified in the profile element.
2314
+
2315
+ native-library-path-suffix
2316
+ is appended to the native library path, which is constructed
2317
+ as described above.
2318
+ rmic-options
2319
+ Options string passed to RMI compiler, at application
2320
+ deployment time.
2321
+ server-classpath
2322
+ A java classpath string that specifies the classes needed by
2323
+ the Application server. Do not expect users to change this
2324
+ under normal conditions. The shared application server
2325
+ classloader forms the final classpath by concatenating
2326
+ classpath-prefix, ${INSTALL_DIR}/lib, server-classpath, and
2327
+ classpath-suffix.
2328
+ system-classpath
2329
+ This classpath string supplied to the jvm at server startup.
2330
+ Contains appserv-launch.jar by default. Users may add to this
2331
+ classpath.
2332
+
2333
+ Used in:
2334
+ config
2335
+ -->
2336
+ <!ELEMENT java-config (profiler?, (jvm-options | property)*)>
2337
+
2338
+ <!ATTLIST java-config
2339
+ java-home CDATA "${com.sun.aas.javaRoot}"
2340
+ debug-enabled %boolean; "false"
2341
+ debug-options CDATA "-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n"
2342
+ rmic-options CDATA "-iiop -poa -alwaysgenerate -keepgenerated -g"
2343
+ javac-options CDATA "-g"
2344
+ classpath-prefix CDATA #IMPLIED
2345
+ classpath-suffix CDATA #IMPLIED
2346
+ server-classpath CDATA #IMPLIED
2347
+ system-classpath CDATA #IMPLIED
2348
+ native-library-path-prefix CDATA #IMPLIED
2349
+ native-library-path-suffix CDATA #IMPLIED
2350
+ bytecode-preprocessors CDATA #IMPLIED
2351
+ env-classpath-ignored %boolean; "true">
2352
+
2353
+
2354
+ <!-- jvm-options
2355
+ String value for options that will be passed to the JVM
2356
+
2357
+ Used in:
2358
+ java-config, profiler
2359
+ -->
2360
+ <!ELEMENT jvm-options (#PCDATA)>
2361
+
2362
+
2363
+ <!-- profiler
2364
+ Profilers could be one of jprobe, optimizeit, hprof, wily and so
2365
+ on jvm-options and property elements are used to record the
2366
+ settings needed to get a particular profiler going. A server
2367
+ instance is tied to a particular profiler, by the profiler
2368
+ element in java-config. Changing the profiler will require a
2369
+ server restart.
2370
+
2371
+ The adminstrative graphical interfaces, could list multiple supported
2372
+ profilers (incomplete at this point) and will populate server.xml
2373
+ appropriately.
2374
+
2375
+
2376
+ Used in:
2377
+ java-config
2378
+ -->
2379
+ <!ELEMENT profiler ((jvm-options | property)*)>
2380
+
2381
+ <!ATTLIST profiler
2382
+ name CDATA #REQUIRED
2383
+ classpath CDATA #IMPLIED
2384
+ native-library-path CDATA #IMPLIED
2385
+ enabled %boolean; "true">
2386
+
2387
+
2388
+ <!-- availability-service
2389
+ SE/EE only: TBD Needs explanation
2390
+
2391
+ attributes
2392
+ auto-manage-ha-store
2393
+ If set to true, the lifecycle of the highly available store
2394
+ is matched with the lifecycle of the highly available
2395
+ cluster. The store is started or stopped with the cluster. It
2396
+ is removed when the cluster is deleted. When set to false,
2397
+ the store lifecycle would have to manually managed by the
2398
+ administrator.
2399
+ ha-agent-hosts
2400
+ comma-delimited list of server host names or IP addresses
2401
+ where high availability store management agents are running.
2402
+ ha-agent-password
2403
+ password needed to contact highly available store management
2404
+ agents
2405
+ ha-agent-port
2406
+ port number where highly available store management agents
2407
+ can be contacted
2408
+ ha-store-healthcheck-enabled
2409
+ Application server stops saving session state when the store
2410
+ service does not function properly or is is not accessible
2411
+ for any reason. When this attribute is set to true, periodic
2412
+ checking is done to detect if the store service has become
2413
+ available again. If healthcheck succeeds the session state
2414
+ saving is resumed. Defaults to false.
2415
+ ha-store-healthcheck-interval-in-seconds
2416
+ The periodicity at which store health is checked.
2417
+ ha-store-name
2418
+ Name of the session store
2419
+ store-pool-name
2420
+ This is the jndi-name for the JDBC Connection Pool used
2421
+ potentially by both the Web Container and the EJB Stateful
2422
+ Session Bean Container for use in checkpointing/passivation
2423
+ when persistence-type = "ha". See sfsb-ha-persistence-type
2424
+ and sfsb-persistence-type for more details. It will default
2425
+ to "jdbc/hastore". This attribute can be over-ridden in
2426
+ either web-container-availability (with
2427
+ http-session-store-pool-name) and/or in
2428
+ ejb-container-availability (with sfsb-store-pool-name). If
2429
+ store-pool-name is not over-ridden then both containers will
2430
+ share the same connection pool. If either container
2431
+ over-rides then it may have its own dedicated pool. In this
2432
+ case there must also be a new corresponding JDBC Resource and
2433
+ JDBC Connection Pool defined for this new pool name.
2434
+
2435
+ Used in:
2436
+ config
2437
+ -->
2438
+ <!ELEMENT availability-service
2439
+ (web-container-availability?, ejb-container-availability?,
2440
+ jms-availability?, property*)>
2441
+
2442
+
2443
+ <!ATTLIST availability-service
2444
+ availability-enabled %boolean; "true"
2445
+ ha-agent-hosts CDATA #IMPLIED
2446
+ ha-agent-port CDATA #IMPLIED
2447
+ ha-agent-password CDATA #IMPLIED
2448
+ ha-store-name CDATA #IMPLIED
2449
+ auto-manage-ha-store %boolean; "false"
2450
+ store-pool-name CDATA #IMPLIED
2451
+ ha-store-healthcheck-enabled %boolean; "false"
2452
+ ha-store-healthcheck-interval-in-seconds CDATA "5">
2453
+
2454
+
2455
+ <!-- web-container-availability
2456
+ web-container-availability SE/EE only:
2457
+
2458
+ attributes
2459
+ availability-enabled
2460
+ This boolean flag controls whether availability is enabled
2461
+ for HTTP session persistence. If this is "false", then
2462
+ session persistence is disabled for all web modules in j2ee
2463
+ apps and stand-alone web modules. If it is "true" (and
2464
+ providing that the global availability-enabled in
2465
+ availability-service is also "true", then j2ee apps and
2466
+ stand-alone web modules may be ha enabled. Finer-grained
2467
+ control exists at lower levels. If this attribute is missing,
2468
+ it "inherits" the value of the global availability-enabled
2469
+ under availability-service.
2470
+ http-session-store-pool-name
2471
+ This is the jndi-name for the JDBC Connection Pool used by
2472
+ the HTTP Session Persistence Framework. If missing, internal
2473
+ code will default it to value of store-pool-name under
2474
+ availability-service (ultimately "jdbc/hastore").
2475
+ persistence-frequency
2476
+ The persistence frequency used by the session persistence
2477
+ framework, when persistence-type = "ha". Values may be
2478
+ "time-based" or "web-event". If it is missing, then the
2479
+ persistence-type will revert to "memory".
2480
+ persistence-scope
2481
+ The persistence scope used by the session persistence
2482
+ framework, when persistence-type = "ha". Values may be
2483
+ "session", "modified-session", "modified-attribute". If it is
2484
+ missing, then the persistence-type will revert to "memory".
2485
+ persistence-store-health-check-enabled
2486
+ Deprecated. This attribute has no effect. If you wish to
2487
+ control enabling/disabling HADB health check, refer to
2488
+ store-healthcheck-enabled attribute in the
2489
+ availability-service element.
2490
+ persistence-type
2491
+ The persistence type used by the session persistence
2492
+ framework.
2493
+ sso-failover-enabled
2494
+ This controls whether Single-Sign-On state will be made
2495
+ available for failover.
2496
+
2497
+ Used in:
2498
+ availability-service
2499
+ -->
2500
+ <!ELEMENT web-container-availability (property*)>
2501
+
2502
+ <!ATTLIST web-container-availability
2503
+ availability-enabled %boolean; #IMPLIED
2504
+ persistence-type %persistence-type; "memory"
2505
+ persistence-frequency %session-save-frequency; #IMPLIED
2506
+ persistence-scope %session-save-scope; #IMPLIED
2507
+ persistence-store-health-check-enabled %boolean; "false"
2508
+ sso-failover-enabled %boolean; "false"
2509
+ http-session-store-pool-name CDATA #IMPLIED>
2510
+
2511
+
2512
+ <!-- ejb-container-availability
2513
+
2514
+ attributes
2515
+ availability-enabled
2516
+ This boolean flag controls whether availability is enabled
2517
+ for SFSB checkpointing (and potentially passivation). If this
2518
+ is "false", then all SFSB checkpointing is disabled for all
2519
+ j2ee apps and ejb modules. If it is "true" (and providing
2520
+ that the global availability-enabled in availability-service
2521
+ is also "true", then j2ee apps and stand-alone ejb modules
2522
+ may be ha enabled. Finer-grained control exists at lower
2523
+ levels. If this attribute is missing, it inherits the value
2524
+ of the global availability-enabled under availability-service.
2525
+ sfsb-checkpoint-enabled
2526
+ This attribute is deprecated, replaced by
2527
+ availability-enabled and will be ignored if present.
2528
+ sfsb-ha-persistence-type
2529
+ The persistence type used by the EJB Stateful Session Bean
2530
+ Container for checkpointing and passivating
2531
+ availability-enabled beans' state. Values may be "file" or
2532
+ "ha". Default is "ha".
2533
+ sfsb-quick-checkpoint-enabled
2534
+ This attribute is deprecated and will be ignored if present.
2535
+ sfsb-store-pool-name
2536
+ This is the jndi-name for the JDBC Connection Pool used by
2537
+ the EJB Stateful Session Bean Container for use in
2538
+ checkpointing/passivation when persistence-type = "ha". See
2539
+ sfsb-ha-persistence-type and sfsb-persistence-type for more
2540
+ details. It will default to value of store-pool-name under
2541
+ availability-service (ultimately "jdbc/hastore").
2542
+
2543
+ Used in:
2544
+ availability-service
2545
+ -->
2546
+ <!ELEMENT ejb-container-availability (property*)>
2547
+
2548
+ <!ATTLIST ejb-container-availability
2549
+ availability-enabled %boolean; #IMPLIED
2550
+ sfsb-ha-persistence-type %sfsb-persistence-type; "ha"
2551
+ sfsb-persistence-type %sfsb-persistence-type; "file"
2552
+ sfsb-checkpoint-enabled %boolean; #IMPLIED
2553
+ sfsb-quick-checkpoint-enabled %boolean; #IMPLIED
2554
+ sfsb-store-pool-name CDATA #IMPLIED>
2555
+
2556
+
2557
+ <!-- jdbc-connection-pool
2558
+ jdbc-connection-pool defines configuration used to create and
2559
+ manage a pool physical database connections. Pool definition is
2560
+ named, and can be referred to by multiple jdbc-resource elements
2561
+ (See <jdbc-resource>).
2562
+
2563
+ Each named pool definition results in a pool instantiated at server
2564
+ start-up. Pool is populated when accessed for the first time. If two or
2565
+ more jdbc-resource elements point to the same jdbc-connection-pool
2566
+ element, they are using the same pool of connections, at run time.
2567
+
2568
+
2569
+ children
2570
+ property
2571
+ Most JDBC 2.0 drivers permit use of standard property lists,
2572
+ to specify User, Password and other resource configuration.
2573
+ While these are optional properties, according to the
2574
+ specification, several of these properties may be necessary
2575
+ for most databases. See Section 5.3 of JDBC 2.0 Standard
2576
+ Extension API.
2577
+
2578
+ The following are the names and corresponding values for these
2579
+ properties
2580
+
2581
+ databaseName
2582
+ Name of the Database
2583
+ serverName
2584
+ Database Server name.
2585
+ port
2586
+ Port where a Database server is listening for requests.
2587
+ networkProtocol
2588
+ Communication Protocol used.
2589
+ user
2590
+ default name of the database user with which connections
2591
+ will be stablished. Programmatic database authentication
2592
+ or default-resource-principal specified in vendor
2593
+ specific web and ejb deployment descriptors will take
2594
+ precedence, over this default. The details and caveats
2595
+ are described in detail in the Administrator's guide.
2596
+ password
2597
+ password for default database user
2598
+ roleName
2599
+ The initial SQL role name.
2600
+ datasourceName
2601
+ used to name an underlying XADataSource, or
2602
+ ConnectionPoolDataSource when pooling of connections is
2603
+ done
2604
+ description
2605
+ Textual Description
2606
+
2607
+ When one or more of these properties are specified, they are passed as
2608
+ is using set<Name>(<Value>) methods to the vendors Datasource class
2609
+ (specified in datasource-classname). User and Password properties are
2610
+ used as default principal, if Container Managed authentication is
2611
+ specified and a default-resource-principal is not found in application
2612
+ deployment descriptors.
2613
+
2614
+
2615
+ attributes
2616
+ allow-non-component-callers
2617
+ A pool with this property set to true, can be used by
2618
+ non-J2EE components (i.e components other than EJBs or
2619
+ Servlets). The returned connection is enlisted automatically
2620
+ with the transaction context obtained from the transaction
2621
+ manager. This property is to enable the pool to be used by
2622
+ non-component callers such as ServletFilters, Lifecycle
2623
+ modules, and 3rd party persistence managers. Standard J2EE
2624
+ components can continue to use such pools. Connections
2625
+ obtained by non-component callers are not automatically
2626
+ cleaned at the end of a transaction by the container. They
2627
+ need to be explicitly closed by the the caller.
2628
+ connection-validation-method
2629
+ specifies the type of validation to be performed when
2630
+ is-connection-validation-required is true. The following
2631
+ types of validation are supported:
2632
+ auto-commit
2633
+ using connection.autoCommit()
2634
+ meta-data
2635
+ using connection.getMetaData()
2636
+ table
2637
+ performing a query on a user specified table (see
2638
+ validation-table-name).
2639
+ datasource-classname
2640
+ Name of the vendor supplied JDBC datasource resource manager.
2641
+ An XA or global transactions capable datasource class will
2642
+ implement javax.sql.XADatasource interface. Non XA or Local
2643
+ transactions only datasources will implement
2644
+ javax.sql.Datasource interface.
2645
+ fail-all-connections
2646
+ indicates if all connections in the pool must be closed
2647
+ should a single validation check fail. The default is false.
2648
+ One attempt will be made to re-establish failed connections.
2649
+ idle-timeout-in-seconds
2650
+ maximum time in seconds, that a connection can remain idle in
2651
+ the pool. After this time, the pool implementation can close
2652
+ this connection. Note that this does not control connection
2653
+ timeouts enforced at the database server side. Adminsitrators
2654
+ are advised to keep this timeout shorter than the database
2655
+ server side timeout (if such timeouts are configured on the
2656
+ specific vendor's database), to prevent accumulation of
2657
+ unusable connection in Application Server.
2658
+ is-connection-validation-required
2659
+ if true, connections are validated (checked to find out if
2660
+ they are usable) before giving out to the application. The
2661
+ default is false.
2662
+ is-isolation-level-guaranteed
2663
+ Applicable only when a particular isolation level is
2664
+ specified for transaction-isolation-level. The default value
2665
+ is true. This assures that every time a connection is
2666
+ obtained from the pool, it is guaranteed to have the
2667
+ isolation set to the desired value. This could have some
2668
+ performance impact on some JDBC drivers. Can be set to false
2669
+ by that administrator when they are certain that the
2670
+ application does not change the isolation level before
2671
+ returning the connection.
2672
+ max-pool-size
2673
+ maximum number of conections that can be created
2674
+ max-wait-time-in-millis
2675
+ amount of time the caller will wait before getting a
2676
+ connection timeout. The default is 60 seconds. A value of 0
2677
+ will force caller to wait indefinitely.
2678
+ name
2679
+ unique name of the pool definition.
2680
+ non-transactional-connections
2681
+ A pool with this property set to true returns
2682
+ non-transactional connections. This connection does not get
2683
+ automatically enlisted with the transaction manager.
2684
+ pool-resize-quantity
2685
+ number of connections to be removed when
2686
+ idle-timeout-in-seconds timer expires. Connections that have
2687
+ idled for longer than the timeout are candidates for removal.
2688
+ When the pool size reaches steady-pool-size, the connection
2689
+ removal stops.
2690
+ res-type
2691
+ DataSource implementation class could implement one of of
2692
+ javax.sql.DataSource, javax.sql.XADataSource or
2693
+ javax.sql.ConnectionPoolDataSource interfaces. This optional
2694
+ attribute must be specified to disambiguate when a Datasource
2695
+ class implements two or more of these interfaces. An error is
2696
+ produced when this attribute has a legal value and the
2697
+ indicated interface is not implemented by the datasource
2698
+ class. This attribute has no default value.
2699
+ steady-pool-size
2700
+ minimum and initial number of connections maintained in the
2701
+ pool.
2702
+ transaction-isolation-level
2703
+ Specifies the Transaction Isolation Level on the pooled
2704
+ database connections. Optional. Has no default. If left
2705
+ unspecified the pool operates with default isolation level
2706
+ provided by the JDBC Driver. A desired isolation level can be
2707
+ set using one of the standard transaction isolation levels,
2708
+ which see.
2709
+
2710
+ Applications that change the Isolation level on a pooled connection
2711
+ programmatically, risk polluting the pool and this could lead to
2712
+ program errors. Also see: is-isolation-level-guaranteed
2713
+
2714
+ validation-table-name
2715
+ specifies the table name to be used to perform a query to
2716
+ validate a connection. This parameter is mandatory, if
2717
+ connection-validation-type set to table. Verification by
2718
+ accessing a user specified table may become necessary for
2719
+ connection validation, particularly if database driver caches
2720
+ calls to setAutoCommit() and getMetaData().
2721
+
2722
+ Used in:
2723
+ resources
2724
+ -->
2725
+ <!ELEMENT jdbc-connection-pool (description?, property*)>
2726
+
2727
+ <!ATTLIST jdbc-connection-pool
2728
+ name CDATA #REQUIRED
2729
+ datasource-classname CDATA #REQUIRED
2730
+ res-type (javax.sql.DataSource | javax.sql.XADataSource | javax.sql.ConnectionPoolDataSource) #IMPLIED
2731
+ steady-pool-size CDATA "8"
2732
+ max-pool-size CDATA "32"
2733
+ max-wait-time-in-millis CDATA "60000"
2734
+ pool-resize-quantity CDATA "2"
2735
+ idle-timeout-in-seconds CDATA "300"
2736
+ transaction-isolation-level %isolation; #IMPLIED
2737
+ is-isolation-level-guaranteed %boolean; "true"
2738
+ is-connection-validation-required %boolean; "false"
2739
+ connection-validation-method (auto-commit | meta-data | table) "auto-commit"
2740
+ validation-table-name CDATA #IMPLIED
2741
+ fail-all-connections %boolean; "false"
2742
+ non-transactional-connections %boolean; "false"
2743
+ allow-non-component-callers %boolean; "false">
2744
+
2745
+
2746
+ <!-- connector-connection-pool
2747
+ connector-connection-pool defines configuration used to create
2748
+ and manage a pool of connections to a EIS. Pool definition is
2749
+ named, and can be referred to by multiple connector-resource
2750
+ elements (See connector-resource).
2751
+
2752
+ Each named pool definition results in a pool instantiated at server
2753
+ start-up. Pool is populated when accessed for the first time. If two or
2754
+ more connector-resource elements point to the same
2755
+ connector-connection-pool element, they are using the same pool of
2756
+ connections, at run time.
2757
+
2758
+ There can be more than one pool for one connection-definition in one
2759
+ resource-adapter.
2760
+
2761
+
2762
+ children
2763
+ property
2764
+ Properties are used to override the ManagedConnectionFactory
2765
+ javabean configuration settings.
2766
+
2767
+ When one or more of these properties are specified, they are passed as
2768
+ is using set<Name>(<Value>) methods to the Resource Adapter's
2769
+ ManagedConnectionfactory class (specified in ra.xml).
2770
+
2771
+
2772
+ attributes
2773
+ connection-definition-name
2774
+ unique name, identifying one connection-definition in a
2775
+ Resource Adapter. Currently this is ConnectionFactory type.
2776
+ fail-all-connections
2777
+ indicates if all connections in the pool must be closed
2778
+ should a single connection fail validation. The default is
2779
+ false. One attempt will be made to re-establish failed
2780
+ connections.
2781
+ idle-timeout-in-seconds
2782
+ maximum time in seconds, that a connection can remain idle in
2783
+ the pool. After this time, the pool implementation can close
2784
+ this connection. Note that this does not control connection
2785
+ timeouts enforced at the database server side. Adminsitrators
2786
+ are advised to keep this timeout shorter than the EIS
2787
+ connection timeout (if such timeouts are configured on the
2788
+ specific EIS), to prevent accumulation of unusable connection
2789
+ in Application Server.
2790
+ is-connection-validation-required
2791
+ This attribute specifies if the connection that is about to
2792
+ be returned is to be validated by the container,
2793
+ max-pool-size
2794
+ maximum number of conections that can be created
2795
+ max-wait-time-in-millis
2796
+ amount of time the caller will wait before getting a
2797
+ connection timeout. The default is 60 seconds. A value of 0
2798
+ will force caller to wait indefinitely.
2799
+ name
2800
+ unique name of the pool definition.
2801
+ pool-resize-quantity
2802
+ number of connections to be removed when
2803
+ idle-timeout-in-seconds timer expires. Connections that have
2804
+ idled for longer than the timeout are candidates for removal.
2805
+ When the pool size reaches steady-pool-size, the connection
2806
+ removal stops.
2807
+ resource-adapter-name
2808
+ This is the name of resource adapter. Name of .rar file is
2809
+ taken as the unique name for the resource adapter.
2810
+ steady-pool-size
2811
+ minimum and initial number of connections maintained in the
2812
+ pool.
2813
+ transaction-support
2814
+ Indicates the level of transaction support that this pool
2815
+ will have. Possible values are "XATransaction",
2816
+ "LocalTransaction" and "NoTransaction". This attribute will
2817
+ override that transaction support attribute in the Resource
2818
+ Adapter in a downward compatible way, i.e it can support a
2819
+ lower/equal transaction level than specified in the RA, but
2820
+ not a higher level.
2821
+
2822
+ Used in:
2823
+ resources
2824
+ -->
2825
+ <!ELEMENT connector-connection-pool (description?, security-map*, property*)>
2826
+
2827
+ <!ATTLIST connector-connection-pool
2828
+ name CDATA #REQUIRED
2829
+ resource-adapter-name CDATA #REQUIRED
2830
+ connection-definition-name CDATA #REQUIRED
2831
+ steady-pool-size CDATA "8"
2832
+ max-pool-size CDATA "32"
2833
+ max-wait-time-in-millis CDATA "60000"
2834
+ pool-resize-quantity CDATA "2"
2835
+ idle-timeout-in-seconds CDATA "300"
2836
+ fail-all-connections %boolean; "false"
2837
+ transaction-support (XATransaction | LocalTransaction | NoTransaction) #IMPLIED
2838
+ is-connection-validation-required %boolean; "false">
2839
+
2840
+
2841
+ <!-- security-map
2842
+ Perform mapping from principal received during Servlet/EJB
2843
+ authentication, to credentials accepted by the EIS. This mapping
2844
+ is optional.It is possible to map multiple (server) principal to
2845
+ the same backend principal.
2846
+
2847
+ Used in:
2848
+ connector-connection-pool
2849
+ -->
2850
+ <!ELEMENT security-map ((principal | user-group)+, backend-principal)>
2851
+
2852
+ <!ATTLIST security-map
2853
+ name CDATA #REQUIRED>
2854
+
2855
+
2856
+ <!-- principal
2857
+ Principal of the Servlet and EJB client
2858
+
2859
+ Used in:
2860
+ security-map
2861
+ -->
2862
+ <!ELEMENT principal (#PCDATA)>
2863
+
2864
+
2865
+ <!-- user-group
2866
+
2867
+ Used in:
2868
+ security-map
2869
+ -->
2870
+ <!ELEMENT user-group (#PCDATA)>
2871
+
2872
+
2873
+ <!-- backend-principal
2874
+
2875
+ Used in:
2876
+ security-map
2877
+ -->
2878
+ <!ELEMENT backend-principal EMPTY>
2879
+
2880
+ <!ATTLIST backend-principal
2881
+ user-name CDATA #REQUIRED
2882
+ password CDATA #IMPLIED>
2883
+
2884
+
2885
+ <!-- thread-pools
2886
+
2887
+ Used in:
2888
+ config
2889
+ -->
2890
+ <!ELEMENT thread-pools (thread-pool+)>
2891
+
2892
+
2893
+ <!-- thread-pool
2894
+
2895
+ attributes
2896
+ idle-thread-timeout-in-seconds
2897
+ idle threads are removed from pool, after this time
2898
+ max-thread-pool-size
2899
+ Maximum number of threads in the threadpool servicing
2900
+ requests in this queue. This is the upper bound on the no. of
2901
+ threads that exist in the threadpool.
2902
+ min-thread-pool-size
2903
+ Minimum number of threads in the threadpool servicing
2904
+ requests in this queue. These are created up front when this
2905
+ threadpool is instantiated
2906
+ num-work-queues
2907
+ This denotes the total number of work queues that are
2908
+ serviced by this threadpool.
2909
+ thread-pool-id
2910
+ This is an id for the work-queue e.g. "thread-pool-1",
2911
+ "thread-pool-2" etc
2912
+
2913
+ Used in:
2914
+ thread-pools
2915
+ -->
2916
+ <!ELEMENT thread-pool EMPTY>
2917
+
2918
+ <!ATTLIST thread-pool
2919
+ thread-pool-id CDATA #REQUIRED
2920
+ min-thread-pool-size CDATA "0"
2921
+ max-thread-pool-size CDATA "200"
2922
+ idle-thread-timeout-in-seconds CDATA "120"
2923
+ num-work-queues CDATA "1">
2924
+
2925
+
2926
+ <!-- property
2927
+ Syntax for supplying properties as name value pairs
2928
+
2929
+ Used in:
2930
+ admin-object-resource, admin-service, alert-service,
2931
+ appclient-module, audit-module, auth-realm, availability-service,
2932
+ cluster, config, connector-connection-pool, connector-module,
2933
+ connector-resource, custom-resource, das-config,
2934
+ diagnostic-service, domain, ejb-container,
2935
+ ejb-container-availability, ejb-module, ejb-timer-service, event,
2936
+ external-jndi-resource, filter-config, group-management-service,
2937
+ http-listener, http-service, iiop-listener, j2ee-application,
2938
+ jacc-provider, java-config, jdbc-connection-pool, jdbc-resource,
2939
+ jms-availability, jms-host, jms-service, jmx-connector,
2940
+ lb-config, lifecycle-module, listener-config, load-balancer,
2941
+ log-service, mail-resource, manager-properties, mbean,
2942
+ mdb-container, module-log-levels, module-monitoring-levels,
2943
+ monitoring-service, node-agent, orb,
2944
+ persistence-manager-factory-resource, profiler, provider-config,
2945
+ resource-adapter-config, security-service, server,
2946
+ session-properties, store-properties, transaction-service,
2947
+ virtual-server, web-container, web-container-availability,
2948
+ web-module
2949
+ -->
2950
+ <!ELEMENT property (description?)>
2951
+
2952
+ <!ATTLIST property
2953
+ name CDATA #REQUIRED
2954
+ value CDATA #REQUIRED>
2955
+
2956
+
2957
+ <!-- system-property
2958
+ Syntax for supplying system properties as name value pairs
2959
+
2960
+ Used in:
2961
+ cluster, config, domain, server
2962
+ -->
2963
+ <!ELEMENT system-property (description?)>
2964
+
2965
+ <!ATTLIST system-property
2966
+ name CDATA #REQUIRED
2967
+ value CDATA #REQUIRED>
2968
+
2969
+
2970
+ <!-- server
2971
+ J2EE Application Server Configuration
2972
+
2973
+ Each Application Server instance is a J2EEv1.4 compliant container. One
2974
+ server instance is specially designated as the Administration Server in
2975
+ SE/EE. User applications cannot be deployed to an Adminsitration Server
2976
+ instance.
2977
+
2978
+
2979
+ children
2980
+ application-ref
2981
+ References to applications deployed to the server instance
2982
+ resource-ref
2983
+ References to resources deployed to the server instance
2984
+
2985
+ attributes
2986
+ config-ref
2987
+ points to a named config. needed for stand-alone servers. If
2988
+ the server instance is part of a cluster, then it must not be
2989
+ present, and will be ignored.
2990
+ lb-weight
2991
+ Each server instance in a cluster has a weight, which may be
2992
+ used to represent the relative processing capacity of that
2993
+ instance. Default weight is 100 for every instance. Weighted
2994
+ load balancing policies will use this weight while load
2995
+ balancing requests within the cluster. It is the
2996
+ responsibility of the administrator to set the relative
2997
+ weights correctly, keeping in mind deployed hardware capacity.
2998
+ name
2999
+ name of the server instance.
3000
+ node-agent-ref
3001
+ SE/EE only. Specifies the name of the node agent where the
3002
+ server instance is hosted.
3003
+
3004
+ Used in:
3005
+ servers
3006
+ -->
3007
+ <!ELEMENT server
3008
+ (application-ref*, resource-ref*, system-property*, property*)>
3009
+
3010
+
3011
+ <!ATTLIST server
3012
+ name CDATA #REQUIRED
3013
+ config-ref CDATA #IMPLIED
3014
+ node-agent-ref CDATA #IMPLIED
3015
+ lb-weight CDATA "100">
3016
+
3017
+
3018
+ <!-- application-ref
3019
+
3020
+ attributes
3021
+ disable-timeout-in-minutes
3022
+ The time, in minutes, that it takes this application to reach
3023
+ a quiescent state after having been disabled
3024
+ lb-enabled
3025
+ A boolean flag that causes any and all load-balancers using
3026
+ this application to consider this application unavailable to
3027
+ them. Defaults to unavailable (false).
3028
+
3029
+ Used in:
3030
+ cluster, server
3031
+ -->
3032
+ <!ELEMENT application-ref EMPTY>
3033
+
3034
+ <!ATTLIST application-ref
3035
+ enabled %boolean; "true"
3036
+ virtual-servers CDATA #IMPLIED
3037
+ lb-enabled %boolean; "false"
3038
+ disable-timeout-in-minutes CDATA "30"
3039
+ ref CDATA #REQUIRED>
3040
+
3041
+
3042
+ <!-- resource-ref
3043
+
3044
+ Used in:
3045
+ cluster, server
3046
+ -->
3047
+ <!ELEMENT resource-ref EMPTY>
3048
+
3049
+ <!ATTLIST resource-ref
3050
+ enabled %boolean; "true"
3051
+ ref CDATA #REQUIRED>
3052
+
3053
+
3054
+ <!-- cluster
3055
+ SE/EE Cluster configuration. A cluster defines a homogenous set
3056
+ of server instances that share the same applications, resources,
3057
+ and configuration.
3058
+
3059
+ children
3060
+ server-ref
3061
+ list of servers in the cluster
3062
+
3063
+ attributes
3064
+ config-ref
3065
+ points to a named config. All server instances in the cluster
3066
+ will share this config.
3067
+ heartbeat-address
3068
+ This is the address (only multicast supported) at which GMS
3069
+ will listen for group events.
3070
+ heartbeat-enabled
3071
+ When "heartbeat-enabled" is set to "true", the GMS services
3072
+ will be started as a lifecycle module in each the application
3073
+ server in the cluster.When "heartbeat-enabled" is set to
3074
+ "false", GMS will not be started and its services will be
3075
+ unavailable. Clusters should function albeit with reduced
3076
+ functionality.
3077
+ heartbeat-port
3078
+ This is the communication port GMS uses to listen for group
3079
+ events . This should be a valid port number.
3080
+ name
3081
+ cluster name
3082
+
3083
+ Used in:
3084
+ clusters
3085
+ -->
3086
+ <!ELEMENT cluster
3087
+ (server-ref*, resource-ref*, application-ref*, system-property*,
3088
+ property*)>
3089
+
3090
+
3091
+ <!ATTLIST cluster
3092
+ name CDATA #REQUIRED
3093
+ config-ref CDATA #REQUIRED
3094
+ heartbeat-port CDATA #REQUIRED
3095
+ heartbeat-address CDATA #REQUIRED
3096
+ heartbeat-enabled %boolean; "true">
3097
+
3098
+
3099
+ <!-- server-ref
3100
+
3101
+ attributes
3102
+ disable-timeout-in-minutes
3103
+ The time, in minutes, that it takes this server to reach a
3104
+ quiescent state after having been disabled
3105
+ enabled
3106
+ A boolean flag that causes the server to be enabled to serve
3107
+ end-users, or not. Default is to be enabled (true)
3108
+ lb-enabled
3109
+ A boolean flag that causes any and all load-balancers using
3110
+ this server to consider this server unavailable to them.
3111
+ Defaults to unavailable (false)
3112
+ ref
3113
+ A reference to the name of a server defined elsewhere
3114
+
3115
+ Used in:
3116
+ cluster, lb-config
3117
+ -->
3118
+ <!ELEMENT server-ref (health-checker?)>
3119
+
3120
+ <!ATTLIST server-ref
3121
+ ref CDATA #REQUIRED
3122
+ disable-timeout-in-minutes CDATA "30"
3123
+ lb-enabled %boolean; "false"
3124
+ enabled %boolean; "true">
3125
+
3126
+
3127
+ <!-- node-agent
3128
+ SE/EE Node Controller. The node agent is an agent that manages
3129
+ server instances on a host machine.
3130
+
3131
+ attributes
3132
+ name
3133
+ Node Controller name
3134
+ start-servers-in-startup
3135
+ If true starts all managed server instances when the Node
3136
+ Controller is started.
3137
+ system-jmx-connector-name
3138
+ The name of the internal jmx connector
3139
+
3140
+ Used in:
3141
+ node-agents
3142
+ -->
3143
+ <!ELEMENT node-agent (jmx-connector?, auth-realm?, log-service, property*)>
3144
+
3145
+ <!ATTLIST node-agent
3146
+ name CDATA #REQUIRED
3147
+ system-jmx-connector-name CDATA #IMPLIED
3148
+ start-servers-in-startup %boolean; "true">
3149
+
3150
+
3151
+ <!-- lb-config
3152
+
3153
+ attributes
3154
+ https-routing
3155
+ Boolean flag indicating how load-balancer will route https
3156
+ requests. If true then an https request to the load-balancer
3157
+ will result in an https request to the server; if false then
3158
+ https requests to the load-balancer result in http requests
3159
+ to the server. Default is to use http (i.e. value of false);
3160
+ monitoring-enabled
3161
+ Boolean flag that determines whether monitoring is switched
3162
+ on or not. Default is that monitoring is switched off (false)
3163
+ name
3164
+ Name of the load balancer configuration
3165
+ reload-poll-interval-in-seconds
3166
+ Maximum period, in seconds, that a change to the load
3167
+ balancer configuration file takes before it is detected by
3168
+ the load balancer and the file reloaded. A value of 0
3169
+ indicates that reloading is disabled. Default period is 1
3170
+ minute (60)
3171
+ response-timeout-in-seconds
3172
+ Period within which a server must return a response or
3173
+ otherwise it will be considered unhealthy. Default value is
3174
+ 60 seconds. Must be greater than or equal to 0. A value of 0
3175
+ effectively turns off this check functionality, meaning the
3176
+ server will always be considered healthy.
3177
+ route-cookie-enabled
3178
+ Boolean flag that determines whether a route cookie is or is
3179
+ not enabled. Default is enabled (true).
3180
+
3181
+ Used in:
3182
+ lb-configs
3183
+ -->
3184
+ <!ELEMENT lb-config ((cluster-ref* | server-ref*), property*)>
3185
+
3186
+ <!ATTLIST lb-config
3187
+ name CDATA #REQUIRED
3188
+ response-timeout-in-seconds CDATA "60"
3189
+ https-routing %boolean; "false"
3190
+ reload-poll-interval-in-seconds CDATA "60"
3191
+ monitoring-enabled %boolean; "false"
3192
+ route-cookie-enabled %boolean; "true">
3193
+
3194
+
3195
+ <!-- health-checker
3196
+ Each cluster would be configured for a ping based health check
3197
+ mechanism.
3198
+
3199
+ attributes
3200
+ interval-in-seconds
3201
+ Interval, in seconds, between health checks. A value of "0"
3202
+ means that the health check is disabled. Default is 30
3203
+ seconds. Must be 0 or greater.
3204
+ timeout-in-seconds
3205
+ Maximum time, in seconds, that a server must respond to a
3206
+ health check request to be considered healthy. Default is 10
3207
+ seconds. Must be greater than 0.
3208
+ url
3209
+ URL to ping so as to determine the health state of a
3210
+ listener. This must be a relative URL.
3211
+
3212
+ Used in:
3213
+ cluster-ref, server-ref
3214
+ -->
3215
+ <!ELEMENT health-checker EMPTY>
3216
+
3217
+ <!ATTLIST health-checker
3218
+ url CDATA "/"
3219
+ interval-in-seconds CDATA "30"
3220
+ timeout-in-seconds CDATA "10">
3221
+
3222
+
3223
+ <!-- cluster-ref
3224
+ Element relating a reference to a cluster to be load balanced to
3225
+ an (optional) health-checker
3226
+
3227
+ attributes
3228
+ lb-policy
3229
+ load balancing policy to be used for this cluster. Possible
3230
+ values are round-robin , weighted-round-robin or
3231
+ user-defined. round-robin is the default. For
3232
+ weighted-round-robin, the weights of the instance are
3233
+ considered while load balancing. For user-defined, the policy
3234
+ is implemented by a shared library which is loaded by the
3235
+ load balancer and the instance selected is delegated to the
3236
+ loaded module.
3237
+ lb-policy-module
3238
+ specifies the absolute path to the shared library
3239
+ implementing the user-defined policy. This should be
3240
+ specified only when the lb-policy is user-defined. The shared
3241
+ library should exist and be readable in the machine where
3242
+ load balancer is running.
3243
+ ref
3244
+ A reference to the name of a cluster defined elsewhere
3245
+
3246
+ Used in:
3247
+ lb-config
3248
+ -->
3249
+ <!ELEMENT cluster-ref (health-checker?)>
3250
+
3251
+ <!ATTLIST cluster-ref
3252
+ ref CDATA #REQUIRED
3253
+ lb-policy %lb-policy-type; "round-robin"
3254
+ lb-policy-module CDATA #IMPLIED>
3255
+
3256
+
3257
+ <!-- message-security-config
3258
+ The message-security-config element defines the message layer
3259
+ specific provider configurations of the application server.
3260
+
3261
+ All of the providers within a message-security-config element must be able
3262
+ to perform authentication processing at the message layer defined by the
3263
+ value of the auth-layer attribute.
3264
+
3265
+
3266
+ attributes
3267
+ default-client-provider
3268
+ used to identify the client provider to be invoked for any
3269
+ application for which a specific client provider has not been
3270
+ bound.
3271
+ default-provider
3272
+ used to identify the server provider to be invoked for any
3273
+ application for which a specific server provider has not been
3274
+ bound.
3275
+
3276
+ When a default provider of a type is not defined for a message layer,
3277
+ the container will only invoke a provider of the type (at the layer)
3278
+ for those applications for which a specific provider has been bound.
3279
+
3280
+
3281
+ Used in:
3282
+ security-service
3283
+ -->
3284
+ <!ELEMENT message-security-config (provider-config+)>
3285
+
3286
+ <!ATTLIST message-security-config
3287
+ auth-layer %message-layer; #REQUIRED
3288
+ default-provider CDATA #IMPLIED
3289
+ default-client-provider CDATA #IMPLIED>
3290
+
3291
+
3292
+ <!-- provider-config
3293
+ The provider-config element defines the configuration of an
3294
+ authentication provider.
3295
+
3296
+ A provider-config with no contained request-policy or response-policy
3297
+ sub-elements, is a null provider. The container will not instantiate or
3298
+ invoke the methods of a null provider, and as such the implementation
3299
+ class of a null provider need not exist.
3300
+
3301
+
3302
+ children
3303
+ request-policy
3304
+ defines the authentication policy requirements associated
3305
+ with the request processing performed by the authentication
3306
+ provider.
3307
+ response-policy
3308
+ defines the authentication policy requirements associated
3309
+ with the response processing performed by the authentication
3310
+ provider.
3311
+
3312
+ attributes
3313
+ class-name
3314
+ defines the java implementation class of the provider. Client
3315
+ authentication providers must implement the
3316
+
3317
+ com.sun.enterprise.security.jauth.ClientAuthModule
3318
+ interface. Server-side providers must implement the
3319
+
3320
+ com.sun.enterprise.security.jauth.ServerAuthModule
3321
+ interface. A provider may implement both interfaces, but it
3322
+ must implement the interface corresponding to its provider
3323
+ type.
3324
+ provider-id
3325
+ Identifier used to uniquely identify this
3326
+
3327
+ provider-config
3328
+ element
3329
+ provider-type
3330
+ defines whether the provider is a client authentication
3331
+ provider or a server authentication provider.
3332
+
3333
+ Used in:
3334
+ message-security-config
3335
+ -->
3336
+ <!ELEMENT provider-config (request-policy?, response-policy?, property*)>
3337
+
3338
+ <!ATTLIST provider-config
3339
+ provider-id CDATA #REQUIRED
3340
+ provider-type (client | server | client-server) #REQUIRED
3341
+ class-name CDATA #REQUIRED>
3342
+
3343
+
3344
+ <!-- request-policy
3345
+ Used to define the authentication policy requirements associated
3346
+ with the request processing performed by an authentication
3347
+ provider (i.e. when a client provider's
3348
+
3349
+ ClientAuthModule.initiateRequest()
3350
+ method is called or when a server provider's
3351
+
3352
+ ServerAuthModule.validateRequest()
3353
+ method is called).
3354
+
3355
+ attributes
3356
+ auth-recipient
3357
+ defines a requirement for message layer authentication of the
3358
+ reciever of a message to its sender (e.g. by XML encryption).
3359
+ before-content
3360
+ indicates that recipient authentication (e.g. encryption)
3361
+ is to occur before any content authentication (e.g.
3362
+ encrypt then sign) with respect to the target of the
3363
+ containing auth-policy.
3364
+ after-content
3365
+ indicates that recipient authentication (e.g. encryption)
3366
+ is to occur after any content authentication (e.g. sign
3367
+ then encrypt) with respect to the target of the
3368
+ containing auth-policy.
3369
+ auth-source
3370
+ defines a requirement for message layer sender authentication
3371
+ (e.g. username password) or content authentication (e.g.
3372
+ digital signature).
3373
+
3374
+ Used in:
3375
+ provider-config
3376
+ -->
3377
+ <!ELEMENT request-policy EMPTY>
3378
+
3379
+ <!ATTLIST request-policy
3380
+ auth-source (sender | content) #IMPLIED
3381
+ auth-recipient (before-content | after-content) #IMPLIED>
3382
+
3383
+
3384
+ <!-- response-policy
3385
+ Used to define the authentication policy requirements associated
3386
+ with the response processing performed by an authentication
3387
+ provider (i.e. when a client provider's
3388
+
3389
+ ClientAuthModule.validateResponse()
3390
+ method is called or when a server provider's
3391
+
3392
+ ServerAuthModule.secureResponse()
3393
+ method is called).
3394
+
3395
+ attributes
3396
+ auth-recipient
3397
+ defines a requirement for message layer authentication of the
3398
+ reciever of a message to its sender (e.g. by XML encryption).
3399
+ before-content
3400
+ indicates that recipient authentication (e.g. encryption)
3401
+ is to occur before any content authentication (e.g.
3402
+ encrypt then sign) with respect to the target of the
3403
+ containing auth-policy.
3404
+ after-content
3405
+ indicates that recipient authentication (e.g. encryption)
3406
+ is to occur after any content authentication (e.g. sign
3407
+ then encrypt) with respect to the target of the
3408
+ containing auth-policy.
3409
+ auth-source
3410
+ defines a requirement for message layer sender authentication
3411
+ (e.g. username password) or content authentication (e.g.
3412
+ digital signature).
3413
+
3414
+ Used in:
3415
+ provider-config
3416
+ -->
3417
+ <!ELEMENT response-policy EMPTY>
3418
+
3419
+ <!ATTLIST response-policy
3420
+ auth-source (sender | content) #IMPLIED
3421
+ auth-recipient (before-content | after-content) #IMPLIED>
3422
+
3423
+
3424
+ <!-- web-service-endpoint
3425
+ This specifies configuration for a web service end point. This
3426
+ web service end point could be JAXRPC or JSR-109 web service. It
3427
+ contains configuration about Monitoring, Transformation rules and
3428
+ Monitoring Log.
3429
+
3430
+ attributes
3431
+ jbi-enabled
3432
+ when false, it disables the visibility of this endoint as a
3433
+ service in JBI
3434
+ max-history-size
3435
+ maximum number of monitoring records stored in history for
3436
+ this end point
3437
+ monitoring
3438
+ monitoring level for this web service.
3439
+ name
3440
+ fully qualified web service name. Format:
3441
+ |ModuleName|#|EndpointName|, if the web service endpoint
3442
+ belongs to an application. (Parent of this element is
3443
+ j2ee-application). |EndpointName|, if the web service
3444
+ endpoint belongs to stand alone ejb-module or web-module.
3445
+ (Parent of this element is either ejb-module or web-module).
3446
+
3447
+ Used in:
3448
+ ejb-module, j2ee-application, web-module
3449
+ -->
3450
+ <!ELEMENT web-service-endpoint (registry-location*, transformation-rule*)>
3451
+
3452
+ <!ATTLIST web-service-endpoint
3453
+ name CDATA #REQUIRED
3454
+ monitoring %monitoring-level; "OFF"
3455
+ max-history-size CDATA "25"
3456
+ jbi-enabled %boolean; "true">
3457
+
3458
+
3459
+ <!-- registry-location
3460
+ Specifies the registry where web service end point artifacts are
3461
+ published.
3462
+
3463
+ Used in:
3464
+ web-service-endpoint
3465
+ -->
3466
+ <!ELEMENT registry-location EMPTY>
3467
+
3468
+ <!ATTLIST registry-location
3469
+ connector-resource-jndi-name CDATA #REQUIRED>
3470
+
3471
+
3472
+ <!-- transformation-rule
3473
+ Specifies configuration for a XSLT transformation rule.
3474
+
3475
+ attributes
3476
+ apply-to
3477
+ - "request": transformations are applied to request in the order in
3478
+ which they are specified.
3479
+
3480
+ - "response": transformation is applied to response in the order in
3481
+ which they are specified.
3482
+
3483
+ - "both": transformation rule is applied to request and response. The
3484
+ order is reversed for response.
3485
+
3486
+ enabled
3487
+ if false, this transformation rule is disabled.
3488
+ name
3489
+ name of the transformation rule
3490
+ rule-file-location
3491
+ location of rule file to do the transformation. Only XSLT
3492
+ files are allowed. Default location is:
3493
+ ${com.sun.aas.instanceRoot}/generated/xml/*appOrModule*/*xslt-
3494
+ ilename*/ Absolute paths can also be specified.
3495
+
3496
+ Used in:
3497
+ web-service-endpoint
3498
+ -->
3499
+ <!ELEMENT transformation-rule EMPTY>
3500
+
3501
+ <!ATTLIST transformation-rule
3502
+ name CDATA #REQUIRED
3503
+ enabled %boolean; "true"
3504
+ apply-to %apply-to-type; "request"
3505
+ rule-file-location CDATA #REQUIRED>
3506
+
3507
+
3508
+ <!-- load-balancers
3509
+
3510
+ Used in:
3511
+ domain
3512
+ -->
3513
+ <!ELEMENT load-balancers (load-balancer*)>
3514
+
3515
+
3516
+ <!-- load-balancer
3517
+ known properties:
3518
+
3519
+ device-host - Host name or IP address for the device
3520
+
3521
+ device-admin-port - Device administration port number
3522
+
3523
+ ssl-proxy-host - proxy host used for outbound HTTP
3524
+
3525
+ ssl-proxy-port - proxy port used for outbound HTTP
3526
+
3527
+
3528
+ attributes
3529
+ auto-apply-enabled
3530
+ when true, immediately push changes to lb config to the
3531
+ physical load balancer
3532
+ lb-config-name
3533
+ name of the lb-config used by this load balancer
3534
+ name
3535
+ name of the load balancer
3536
+
3537
+ Used in:
3538
+ load-balancers
3539
+ -->
3540
+ <!ELEMENT load-balancer (property*)>
3541
+
3542
+ <!ATTLIST load-balancer
3543
+ name CDATA #REQUIRED
3544
+ lb-config-name CDATA #REQUIRED
3545
+ auto-apply-enabled %boolean; "false">
3546
+
3547
+
3548
+ <!-- mbean
3549
+
3550
+ attributes
3551
+ enabled
3552
+ impl-class-name
3553
+ A String that represents fully qualified class name of MBean
3554
+ implementation. This is read-only.
3555
+ name
3556
+ A String that represents the name of the MBean. It is
3557
+ required that the name is valid to represent a "value" of a
3558
+ property in the property-list of an MBean ObjectName. The
3559
+ name must be specified and is a primary key for an MBean. An
3560
+ invalid name implies failure of operation.
3561
+ object-name
3562
+ A String that represents a system-generated Object Name for
3563
+ this MBean.
3564
+ object-type
3565
+ A String representing whether it is a user-defined MBean or a
3566
+ System MBean.
3567
+
3568
+ Used in:
3569
+ applications
3570
+ -->
3571
+ <!ELEMENT mbean (description?, property*)>
3572
+
3573
+ <!ATTLIST mbean
3574
+ name CDATA #REQUIRED
3575
+ object-type %object-type; "user"
3576
+ impl-class-name CDATA #REQUIRED
3577
+ object-name CDATA #IMPLIED
3578
+ enabled %boolean; "true">
3579
+
3580
+
3581
+ <!-- jms-availability
3582
+
3583
+ attributes
3584
+ availability-enabled
3585
+ This boolean flag controls whether the MQ cluster associated
3586
+ with the application server cluster is HA enabled or not. If
3587
+ this attribute is "false", then the MQ cluster pointed to by
3588
+ the jms-service element is considered non-HA. JMS Messages
3589
+ are not persisted to a highly available store. If this
3590
+ attribute is "true" the MQ cluster pointed to by the
3591
+ jms-service element is a HA cluster and the MQ cluster uses
3592
+ the database pointed to by mq-store-pool-name to save
3593
+ persistent JMS messages and other broker cluster
3594
+ configuration information. Individual applications will not
3595
+ be able to control or override MQ cluster availability
3596
+ levels. They inherit the availability attribute defined in
3597
+ this element. If this attribute is missing, availability is
3598
+ turned off by default [i.e. the MQ cluster associated with
3599
+ the AS cluster would behave as a non-HA cluster]
3600
+ mq-store-pool-name
3601
+ This is the jndi-name for the JDBC Connection Pool used by
3602
+ the MQ broker cluster for use in saving persistent JMS
3603
+ messages and other broker cluster configuration information.
3604
+ It will default to value of store-pool-name under
3605
+ availability-service (ultimately "jdbc/hastore").
3606
+
3607
+ Used in:
3608
+ availability-service
3609
+ -->
3610
+ <!ELEMENT jms-availability (property*)>
3611
+
3612
+ <!ATTLIST jms-availability
3613
+ availability-enabled %boolean; "false"
3614
+ mq-store-pool-name CDATA #IMPLIED>
3615
+
3616
+
3617
+ <!-- management-rules
3618
+ Container for self management rules
3619
+
3620
+ attributes
3621
+ enabled
3622
+ Acts as high level switch for disabling all the defined
3623
+ rules. If set to "false" all the configured rules would
3624
+ disabled. If set to "true", enabled state of a particular
3625
+ rule will be decided at that rule level.
3626
+
3627
+ Used in:
3628
+ config
3629
+ -->
3630
+ <!ELEMENT management-rules (management-rule*)>
3631
+
3632
+ <!ATTLIST management-rules
3633
+ enabled %boolean; "true">
3634
+
3635
+
3636
+ <!-- management-rule
3637
+ Defines the configured self management rule
3638
+
3639
+ attributes
3640
+ enabled
3641
+ Determines whether the rule is enabled or not. Default value
3642
+ is false.
3643
+ name
3644
+ Name of the management rule
3645
+
3646
+ Used in:
3647
+ management-rules
3648
+ -->
3649
+ <!ELEMENT management-rule (event, action?, description?)>
3650
+
3651
+ <!ATTLIST management-rule
3652
+ name CDATA #REQUIRED
3653
+ enabled %boolean; "true">
3654
+
3655
+
3656
+ <!-- event
3657
+ Defines the event associated with the configured rule. For each
3658
+ configured rule there exists one event associated with it.
3659
+
3660
+ attributes
3661
+ level
3662
+ Specifies at what level to record the event occurance in
3663
+ server log file. Default value is INFO
3664
+ record-event
3665
+ Specifies whether the occurance of the event is to be logged
3666
+ or not. By default this would be true. If no action is
3667
+ specified, the event would be recorded.
3668
+ type
3669
+ Identifies the configured event as one of the predefined
3670
+ event types.
3671
+
3672
+ Used in:
3673
+ management-rule
3674
+ -->
3675
+ <!ELEMENT event (description?, property*)>
3676
+
3677
+ <!ATTLIST event
3678
+ type %event-type; #REQUIRED
3679
+ record-event %boolean; "true"
3680
+ level %log-level; "INFO">
3681
+
3682
+
3683
+ <!-- action
3684
+ Defines the action MBean associated with the event.
3685
+
3686
+ attributes
3687
+ action-mbean-name
3688
+ identifies the name of the action MBean.
3689
+
3690
+ Used in:
3691
+ management-rule
3692
+ -->
3693
+ <!ELEMENT action EMPTY>
3694
+
3695
+ <!ATTLIST action
3696
+ action-mbean-name CDATA #REQUIRED>
3697
+