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