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,62 @@
1
+
2
+ <!ENTITY % boolean "(yes | no | on | off | 1 | 0 | true | false)">
3
+
4
+ <!-- Each deployed Resource Adapter (RAR) Module, will have ias-ra.xml
5
+ associated with it, which specifies several dynamic configuration
6
+ properties. Key aspects are pool sizing and security role maps.
7
+ -->
8
+ <!ELEMENT sun-connector (resource-adapter, role-map?)>
9
+
10
+ <!-- Resource adapter configuration
11
+
12
+ jndi-name name by which, this adapter will appear in JNDI tree
13
+ max-pool-size maximum size of connection to EIS
14
+ steady-pool-size initial and minimum number of connections to be maintained
15
+ max-wait-in-millis if a connection is not readily found, caller will have to
16
+ wait this long, before a connection is created. A value of
17
+ 0 implies, wait till a connection becomes available. If the
18
+ pool is completely utilized and the timer expires, an
19
+ exception will be delivered to the application.
20
+
21
+ idle-timeout-in-seconds A timer thread periodically removed unused connections.
22
+ The interval at which this thread runs. All idle
23
+ connections will be removed, while mainataining
24
+ the configured steady-pool-size.
25
+ -->
26
+ <!ELEMENT resource-adapter (description?, property*)>
27
+ <!ATTLIST resource-adapter jndi-name CDATA #REQUIRED
28
+ max-pool-size CDATA "32"
29
+ steady-pool-size CDATA "4"
30
+ max-wait-time-in-millis CDATA "10000"
31
+ idle-timeout-in-seconds CDATA "1000">
32
+
33
+ <!-- Perform mapping from principal received during Servlet/EJB
34
+ authentication, to credentials accepted by the EIS. This
35
+ mapping is optional. The map consists of several 2-tuples
36
+ map-id is the name of the mapping
37
+ -->
38
+ <!ELEMENT role-map (description?, map-element*)>
39
+ <!ATTLIST role-map map-id CDATA #REQUIRED>
40
+
41
+
42
+ <!-- It is possible to map multiple (server) principal to the
43
+ same backend principal.
44
+ -->
45
+ <!ELEMENT map-element (principal+, backend-principal)>
46
+
47
+ <!-- Principal of the Servlet and EJB client -->
48
+ <!ELEMENT principal (description?)>
49
+ <!ATTLIST principal user-name CDATA #REQUIRED>
50
+
51
+ <!-- Backend EIS principal -->
52
+ <!ELEMENT backend-principal EMPTY>
53
+ <!ATTLIST backend-principal user-name CDATA #REQUIRED
54
+ password CDATA #REQUIRED
55
+ credential CDATA #REQUIRED>
56
+
57
+ <!ELEMENT description (#PCDATA)>
58
+
59
+ <!-- Syntax for supplying properties as name value pairs -->
60
+ <!ELEMENT property EMPTY>
61
+ <!ATTLIST property name CDATA #REQUIRED
62
+ value CDATA #REQUIRED>
@@ -0,0 +1,2007 @@
1
+ <?xml version='1.0' encoding='UTF-8' ?>
2
+
3
+ <!--
4
+ The contents of this file are subject to the terms
5
+ of the Common Development and Distribution License
6
+ (the "License"). You may not use this file except
7
+ in compliance with the License.
8
+
9
+ You can obtain a copy of the license at
10
+ glassfish/bootstrap/legal/CDDLv1.0.txt or
11
+ https://glassfish.dev.java.net/public/CDDLv1.0.html.
12
+ See the License for the specific language governing
13
+ permissions and limitations under the License.
14
+
15
+ When distributing Covered Code, include this CDDL
16
+ HEADER in each file and include the License file at
17
+ glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
18
+ add the following below this CDDL HEADER, with the
19
+ fields enclosed by brackets "[]" replaced with your
20
+ own identifying information: Portions Copyright [yyyy]
21
+ [name of copyright owner]
22
+ -->
23
+
24
+ <!-- ENTITY Definitions for the dtd -->
25
+
26
+ <!ENTITY % boolean "(yes | no | on | off | 1 | 0 | true | false)">
27
+
28
+ <!ENTITY % isolation "(read-uncommitted | read-committed | repeatable-read | serializable)">
29
+
30
+ <!ENTITY % validation-level "(full | parsing | none)">
31
+
32
+ <!--
33
+ object-type defines the type of the resource. It can be:
34
+ system-all These are system resources for all instances and DAS
35
+ system-admin These are system resources only in DAS
36
+ system-instance These are system resources only in instances (and not DAS)
37
+ user User resources (This is the default for all elements)
38
+ -->
39
+ <!ENTITY % object-type "(system-all | system-admin | system-instance | user)">
40
+
41
+ <!-- SE/EE related ENTITIES: This will define the available JSR 160 connector
42
+ transport protocols.
43
+ -->
44
+ <!ENTITY % rjmx-protocol "(jmxmp)">
45
+
46
+ <!--
47
+ monitoring-level controls the amount of monitoring data collected
48
+ and exposed to clients
49
+ OFF: no monitoring/statistical data is exposed to the clients.
50
+ LOW: SE/EE only
51
+ HIGH: maximum data is gathered and released.
52
+ -->
53
+ <!ENTITY % monitoring-level "(OFF|LOW|HIGH)">
54
+
55
+ <!-- SE/EE related ENTITIES -->
56
+ <!ENTITY % persistence-type "(memory | file | ha | jdbc-oracle | jdbc-pointbase | custom)">
57
+ <!ENTITY % checkpoint-location "(end-of-method | end-of-transaction)">
58
+ <!ENTITY % session-save-frequency "(web-method | timer | synch)">
59
+ <!ENTITY % session-save-scope "(session | modified-session | modified-attribute)" >
60
+
61
+ <!--
62
+ Top level Domain Element that includes applications, resources, configs, servers,
63
+ clusters and node-controllers, load balancer configurations and load balancers.
64
+ node-controllers and load balancers are SE/EE related entities only.
65
+
66
+ application-root for PE this defines the location where applications are
67
+ deployed
68
+
69
+ log-root specifies where the server instance's log files are kept,
70
+ including HTTP access logs, server logs, and transaction
71
+ logs. Default is $INSTANCE-ROOT/logs
72
+
73
+ locale If present, overrides OS locale setting.
74
+ -->
75
+ <!ELEMENT domain (applications?, resources? , configs, servers, clusters?,
76
+ node-controllers?, lb-configurations?, loadbalancers?,
77
+ property* )>
78
+ <!ATTLIST domain application-root CDATA #IMPLIED
79
+ log-root CDATA #IMPLIED
80
+ locale CDATA #IMPLIED>
81
+
82
+ <!-- Aggregation elements that includes 0 or more of its types.
83
+
84
+ configs: for PE there will be only a single named configuration
85
+ servers: for PE there will be only a single named server instance
86
+ clusters: SE/EE only
87
+ node-controllers: SE/EE only
88
+ lb-configurations: SE/EE only
89
+ loadbalancers: SE/EE only
90
+ -->
91
+ <!ELEMENT configs (config+)>
92
+ <!ELEMENT servers (server*)>
93
+ <!ELEMENT clusters (cluster*)>
94
+ <!ELEMENT node-controllers (node-controller*)>
95
+ <!ELEMENT lb-configurations (lb-configuration*)>
96
+ <!ELEMENT loadbalancers (loadbalancer*)>
97
+
98
+
99
+ <!--- APPLICATIONS SECTION -->
100
+
101
+ <!-- Various types of applications that can be deployed on Sun ONE Application
102
+ Server instance
103
+
104
+ applications-dir specifies an absolute path to where deployed
105
+ applications will reside for this instance. The default location
106
+ is $INSTANCE-ROOT/applications
107
+
108
+ -->
109
+ <!ELEMENT applications ((lifecycle-module | j2ee-application | ejb-module |
110
+ web-module | connector-module | appclient-module)*)>
111
+
112
+ <!--
113
+ Server Lifecycle Listener Modules
114
+
115
+ name unqiue identifier for the deployed server lifecycle event
116
+ listener module.
117
+ class-name fully qualified name of the startup class.
118
+ classpath where this module is actually located, if it is not under
119
+ applications-root
120
+ load-order integer value that can be used to force the order in which deployed
121
+ lifecycle modules are loaded at server start up. Smaller numbered
122
+ modules get loaded sooner. Order is unspecified if two or more
123
+ lifecycle modules have the same load-order value.
124
+ is-failure-fatal, if true, aborts server start up if this module does not
125
+ load properly.
126
+ enabled boolean attribute. If set to "false" this module will not be
127
+ loaded at server start up.
128
+ -->
129
+ <!ELEMENT lifecycle-module (description? , property*)>
130
+
131
+ <!ATTLIST lifecycle-module name CDATA #REQUIRED
132
+ class-name CDATA #REQUIRED
133
+ classpath CDATA #IMPLIED
134
+ load-order CDATA #IMPLIED
135
+ is-failure-fatal %boolean; "false"
136
+ enabled %boolean; "true">
137
+
138
+
139
+ <!-- j2ee-application and ejb-module attributes
140
+ -->
141
+ <!ELEMENT j2ee-application (description?)>
142
+ <!ATTLIST j2ee-application name CDATA #REQUIRED
143
+ location CDATA #REQUIRED
144
+ object-type %object-type; "user"
145
+ enabled %boolean; "true">
146
+
147
+ <!ELEMENT ejb-module (description?)>
148
+ <!ATTLIST ejb-module name CDATA #REQUIRED
149
+ location CDATA #REQUIRED
150
+ object-type %object-type; "user"
151
+ enabled %boolean; "true">
152
+
153
+ <!ELEMENT web-module (description?)>
154
+ <!ATTLIST web-module name CDATA #REQUIRED
155
+ context-root CDATA #REQUIRED
156
+ location CDATA #REQUIRED
157
+ object-type %object-type; "user"
158
+ enabled %boolean; "true">
159
+
160
+
161
+ <!ELEMENT connector-module (description?)>
162
+ <!ATTLIST connector-module name CDATA #REQUIRED
163
+ location CDATA #REQUIRED
164
+ object-type %object-type; "user"
165
+ enabled %boolean; "true">
166
+
167
+
168
+ <!ELEMENT appclient-module (description?)>
169
+ <!ATTLIST appclient-module name CDATA #REQUIRED
170
+ location CDATA #REQUIRED>
171
+
172
+
173
+ <!--- RESOURCES SECTION -->
174
+
175
+ <!-- J2EE Applications look up resources registered with the
176
+ Application server, using portable JNDI names.
177
+ -->
178
+ <!ELEMENT resources ((custom-resource | external-jndi-resource | jdbc-resource |
179
+ mail-resource | persistence-manager-factory-resource |
180
+ admin-object-resource | connector-resource | resource-adapter-config |
181
+ jdbc-connection-pool | connector-connection-pool)*)>
182
+
183
+
184
+ <!-- Textual description of a configured entity -->
185
+ <!ELEMENT description (#PCDATA)>
186
+
187
+ <!-- custom (or generic) resource managed by a user-written factory class. -->
188
+ <!ELEMENT custom-resource (description? , property*)>
189
+
190
+ <!--
191
+ JNDI name for generic resource, the fully qualified type of the resource
192
+ and whether it is enabled at runtime
193
+ -->
194
+ <!ATTLIST custom-resource jndi-name CDATA #REQUIRED
195
+ res-type CDATA #REQUIRED
196
+ factory-class CDATA #REQUIRED
197
+ enabled %boolean; "true">
198
+
199
+ <!-- resource residing in an external JNDI repository -->
200
+ <!ELEMENT external-jndi-resource (description? , property*)>
201
+
202
+ <!ATTLIST external-jndi-resource jndi-name CDATA #REQUIRED
203
+ jndi-lookup-name CDATA #REQUIRED
204
+ res-type CDATA #REQUIRED
205
+ factory-class CDATA #REQUIRED
206
+ enabled %boolean; "true">
207
+
208
+ <!-- JDBC javax.sql.(XA)DataSource resource definition -->
209
+ <!ELEMENT jdbc-resource (description? , property*)>
210
+
211
+ <!ATTLIST jdbc-resource jndi-name CDATA #REQUIRED
212
+ pool-name CDATA #REQUIRED
213
+ object-type %object-type; "user"
214
+ enabled %boolean; "true">
215
+
216
+ <!-- The mail-resource element describes a javax.mail.Session resource -->
217
+ <!ELEMENT mail-resource (description? , property*)>
218
+
219
+ <!ATTLIST mail-resource jndi-name CDATA #REQUIRED
220
+ store-protocol CDATA "imap"
221
+ store-protocol-class CDATA "com.sun.mail.imap.IMAPStore"
222
+ transport-protocol CDATA "smtp"
223
+ transport-protocol-class CDATA "com.sun.mail.smtp.SMTPTransport"
224
+ host CDATA #REQUIRED
225
+ user CDATA #REQUIRED
226
+ from CDATA #REQUIRED
227
+ debug %boolean; "false"
228
+ enabled %boolean; "true">
229
+ <!--
230
+ Persistence Manager runtime configuration.
231
+
232
+ jndi-name JNDI name for this resource
233
+ jdbc-resource-jndi-name: jdbc resource with which database connections
234
+ are obtained.
235
+ must be the name of one of pre-created jdbc resources.
236
+ factory-class: Class that creates persistence manager instance.
237
+ -->
238
+ <!ELEMENT persistence-manager-factory-resource (description? , property*)>
239
+
240
+ <!ATTLIST persistence-manager-factory-resource
241
+ jndi-name CDATA #REQUIRED
242
+ factory-class CDATA
243
+ "com.sun.jdo.spi.persistence.support.sqlstore.impl.PersistenceManagerFactoryImpl"
244
+ jdbc-resource-jndi-name CDATA #IMPLIED
245
+ enabled %boolean; "true">
246
+
247
+ <!-- The admin-object-resource element describes a administered object for a inbound
248
+ resource adapter.
249
+ jndi-name JNDI name for this resource
250
+ res-type Interface definition for the administered object
251
+ res-adapter Name of the inbound resource adapter.
252
+ -->
253
+ <!ELEMENT admin-object-resource (description?, property*)>
254
+ <!ATTLIST admin-object-resource jndi-name CDATA #REQUIRED
255
+ res-type CDATA #REQUIRED
256
+ res-adapter CDATA #REQUIRED
257
+ enabled %boolean; "true">
258
+
259
+ <!ELEMENT connector-resource (description?, property*)>
260
+ <!ATTLIST connector-resource jndi-name CDATA #REQUIRED
261
+ pool-name CDATA #REQUIRED
262
+ object-type %object-type; "user"
263
+ enabled %boolean; "true">
264
+
265
+ <!--
266
+ This element is for configuring the resource adapter. These values
267
+ (properties) over-rides the default values present in ra.xml.
268
+ The name attribute has to be unique . It is optional for PE. It is
269
+ used mainly for EE.
270
+ -->
271
+
272
+ <!ELEMENT resource-adapter-config (property*)>
273
+ <!ATTLIST resource-adapter-config name CDATA #IMPLIED
274
+ thread-pool-ids CDATA #IMPLIED
275
+ resource-adapter-name CDATA #REQUIRED>
276
+
277
+ <!-- CONFIGS SECTION -->
278
+ <!--
279
+ The configuration defines the configuration of a server instance that
280
+ can be shared by other server instances. The availability-service and
281
+ quorum-service are SE/EE only.
282
+ -->
283
+ <!ELEMENT config (http-service, iiop-service, admin-service,
284
+ web-container, ejb-container, mdb-container,
285
+ jms-service?, log-service, security-service,
286
+ transaction-service, monitoring-service, java-config ,
287
+ availability-service? , quorum-service?,
288
+ thread-pools, property*)>
289
+
290
+ <!ATTLIST config name CDATA #REQUIRED>
291
+
292
+
293
+ <!-- HTTP service configuration -->
294
+ <!ELEMENT http-service ((http-listener | virtual-server)* ,
295
+ property*)>
296
+
297
+
298
+ <!-- Configure HTTP listener
299
+
300
+ id Unique identifier for http listener.
301
+
302
+ address IP address of the listen socket. Can be in dotted-pair or IPv6 notation.
303
+ Can also be any for INADDR-ANY. Configuring a listen socket to listen on
304
+ any is required if more than one http-listener is configured to it.
305
+
306
+ port Port number to create the listen socket on. Legal values are 1 - 65535.
307
+ On Unix, creating sockets that listen on ports 1 - 1024 requires
308
+ superuser privileges. Configuring an SSL listen socket to listen on
309
+ port 443 is recommended.
310
+
311
+ security-enabled (optional) Determines whether the http listener runs SSL. You can
312
+ turn SSL2 or SSL3 on or off and set ciphers using an ssl element
313
+ The Security setting in the init.conf file globally enables or disables
314
+ SSL by making certificates available to the server instance. Therefore,
315
+ Security in init.conf must be on or security in server.xml does not
316
+ work.
317
+
318
+ acceptor-threads (optional) Number of acceptor threads for the listen socket.
319
+ The recommended value is the number of processors in the machine.
320
+
321
+ default-virtual-server The id attribute of the default virtual server for this
322
+ particular connection group.
323
+
324
+ server-name Tells the server what to put in the host name section of any URLs
325
+ it sends to the client. This affects URLs the server automatically generates;
326
+ it doesn't affect the URLs for directories and files stored in the server.
327
+ This name should be the alias name if your server uses an alias.
328
+ If you append a colon and port number, that port will be used in URLs
329
+ the server sends to the client.
330
+
331
+ xpowered-by The Servlet 2.4 spec defines a special X-Powered-By: Servlet/2.4
332
+ header, which containers may add to servlet-generated responses. This
333
+ is complemented by the JSP 2.0 spec, which defines a X-Powered-By: JSP/2.0
334
+ header to be added (on an optional basis) to responses utilizing JSP technology.
335
+ The goal of these headers is to aid in gathering statistical data
336
+ about the use of Servlet and JSP technology. If true, these headers will
337
+ be added.
338
+
339
+ redirect-port if the connector is supporting non-SSL requests and a request is received
340
+ for which a matching <security-constraint> requires SSL transport
341
+ catalina will automatically redirect the request to the port number
342
+ specified here
343
+ -->
344
+ <!ELEMENT http-listener (ssl?, property*)>
345
+ <!ATTLIST http-listener id CDATA #REQUIRED
346
+ address CDATA #REQUIRED
347
+ port CDATA #REQUIRED
348
+ acceptor-threads CDATA "1"
349
+ security-enabled %boolean; "false"
350
+ default-virtual-server CDATA #REQUIRED
351
+ server-name CDATA #REQUIRED
352
+ redirect-port CDATA #IMPLIED
353
+ xpowered-by %boolean; "true"
354
+ enabled %boolean; "true" >
355
+ <!-- Define SSL processing parameters
356
+
357
+ cert-nickname nickname of the server certificate in the certificate database
358
+ or the PKCS#11 token. In the certificate, the name format is
359
+ tokenname:nickname. Including the tokenname: part of the name
360
+ in this attribute is optional.
361
+
362
+ ssl2-enabled (optional) Determines whether SSL2 is enabled.
363
+
364
+ ssl3-enabled (optional) Determines whether SSL3 is enabled.
365
+
366
+ If both SSL2 and SSL3 are enabled for a virtual server, the server
367
+ tries SSL3 encryption first. If that fails, the server tries SSL2
368
+ encryption.
369
+
370
+ ssl2-ciphers (optional) A comma-separated list of the SSL2 ciphers used, with
371
+ the prefix + to enable or - to disable, for example +rc4. Allowed
372
+ values are rc4, rc4export, rc2, rc2export, idea, des, desede3.
373
+ If no value is specified, all supported ciphers are assumed to
374
+ be enabled.
375
+
376
+ ssl3-tls-ciphers (optional) A comma-separated list of the SSL3 ciphers used, with
377
+ the prefix + to enable or - to disable, for example +rsa-des-sha.
378
+ Allowed SSL3 values are rsa-rc4-128-md5, rsa3des-sha, rsa-des-sha,
379
+ rsa-rc4-40-md5, rsa-rc2-40-md5, rsa-null-md5. Allowed TLS values
380
+ are rsa-des-56-sha, rsa-rc4-56-sha. If no value is specified,
381
+ all supported ciphers are assumed to be enabled.
382
+
383
+ tls-enabled (optional) Determines whether TLS is enabled.
384
+
385
+ tls-rollback-enabled (optional) Determines whether TLS rollback is enabled. TLS
386
+ rollback should be enabled for Microsoft Internet Explorer
387
+ 5.0 and 5.5.
388
+
389
+ client-auth-enabled (optional) Determines whether SSL3 client authentication is
390
+ performed on every request, independent of ACL-based access
391
+ control.
392
+ -->
393
+
394
+ <!ELEMENT ssl EMPTY>
395
+ <!ATTLIST ssl cert-nickname CDATA #REQUIRED
396
+ ssl2-enabled %boolean; "false"
397
+ ssl2-ciphers CDATA #IMPLIED
398
+ ssl3-enabled %boolean; "true"
399
+ ssl3-tls-ciphers CDATA #IMPLIED
400
+ tls-enabled %boolean; "true"
401
+ tls-rollback-enabled %boolean; "true"
402
+ client-auth-enabled %boolean; "false" >
403
+
404
+ <!-- Configuration of Virtual Server
405
+
406
+ Virtualization in Application Server allows multiple URL domains to be served by
407
+ the same HTTP server process, which is listening on multiple host addresses If
408
+ an application is available at two virtual servers, they still share same physical
409
+ resource pools, such as JDBC connection pools.
410
+
411
+ Sun ONE Application Server allows a list of virtual servers, to be specified
412
+ along with web-module and j2ee-application elements. This establishes an
413
+ association between URL domains, represented by the virtual server and the web
414
+ modules (standalone web modules or web modules inside the ear file)
415
+
416
+ id Virtual server ID. This is a unique ID that allows lookup of a
417
+ specific virtual server. Can also be referred to as the
418
+ variable $id in an obj.conf file. A virtual server ID cannot
419
+ begin with a number.
420
+
421
+ http-listeners (optional) A comma-separated list of http-listener id(s),
422
+ Required only for a Virtual Server that is not the default
423
+ virtual server.
424
+
425
+ default-web-module (optional) stand alone web module associated with this
426
+ virtual server by default.
427
+
428
+
429
+ hosts A comma-separated list of values allowed in the Host request
430
+ header to select the current virtual server. Each Virtual Server
431
+ that is configured to the same Connection Group must have a
432
+ unique hosts value for that group.
433
+
434
+ state (optional) Determines whether a Virtual Server is active
435
+ (on) or inactive (off, disable). The default is on (active).
436
+ When inactive, a Virtual Server does not service requests.
437
+ If a Virtual Server is disabled, only the server administrator
438
+ can turn it on.
439
+
440
+ log-file (optional) Specifies a log file for virtual-server-specific
441
+ log messages. If this is not specified, log messages go to
442
+ $LOG-ROOT/server.log
443
+
444
+ -->
445
+ <!ELEMENT virtual-server (property*)>
446
+
447
+ <!ATTLIST virtual-server id CDATA #REQUIRED
448
+ http-listeners CDATA #IMPLIED
449
+ default-web-module CDATA #IMPLIED
450
+ hosts CDATA #REQUIRED
451
+ state (on | off | disabled ) "on"
452
+ log-file CDATA #IMPLIED >
453
+
454
+ <!-- ORB underlies the EJB container. Requests for EJBs from Application Client
455
+ Container(s) or from another EJB interoperability capable J2EE Container(s)
456
+ are serviced by iiop listener(s). One non-SSL iiop listener can be configured.
457
+ SSL support may require up to two SSL secured IIOP listeners to be configured:
458
+ Server Authentication only, Mutual Authentication only, or both.
459
+
460
+ ssl-client-config element specifies the SSL configuration when the Application
461
+ Server is making outbound IIOP/SSL connections.
462
+
463
+ By default, a server instance will configure non-secure IIOP access.
464
+ Administrator can create and configure IIOP/SSL listener(s).
465
+
466
+ client-authentication-required if true, the server will reject unauthenticated requests.
467
+ It will also insert an "Authentication required"
468
+ bit in IORs sent to clients.
469
+ -->
470
+
471
+ <!ELEMENT iiop-service (orb , ssl-client-config? , iiop-listener*)>
472
+ <!ATTLIST iiop-service client-authentication-required %boolean; "false">
473
+
474
+ <!-- Orb Configuration properties
475
+
476
+ message-fragment-size GIOPv1.2 messages larger than this will get fragmented.
477
+ max-connections maximum number of incoming connections, on all listeners
478
+ use-thread-pool-ids This would refer to the thread-pool-id(s) defined in
479
+ the thread-pool sub-element of thread-pool-config
480
+ element in server.xml. These would be the threadpool(s)
481
+ used by the ORB. More than one thread-pool-id(s) could
482
+ be specified by using commas to separate
483
+ the names e.g. "orb-thread-pool-1, orb-thread-pool-2"
484
+ -->
485
+ <!ELEMENT orb (property*)>
486
+
487
+ <!ATTLIST orb use-thread-pool-ids CDATA #REQUIRED
488
+ message-fragment-size CDATA "1024"
489
+ max-connections CDATA "1024">
490
+
491
+ <!-- Client SSL Configuration -->
492
+ <!ELEMENT ssl-client-config (ssl)>
493
+
494
+ <!-- IIOP Listener Configuration.
495
+
496
+ ssl element specifies optional SSL configuration
497
+ id unique identifier for this listener.
498
+ address ip address or hostname (resolvable by DNS)
499
+ port port number
500
+ security-enabled Determines whether the iiop listener runs SSL. You can
501
+ turn SSL2 or SSL3 on or off and set ciphers using an ssl element
502
+ enabled if false, a configured listener, is disabled
503
+ -->
504
+ <!ELEMENT iiop-listener (ssl? , property*)>
505
+
506
+ <!ATTLIST iiop-listener id CDATA #REQUIRED
507
+ address CDATA #REQUIRED
508
+ port CDATA "1072"
509
+ security-enabled %boolean; "false"
510
+ enabled %boolean; "true" >
511
+
512
+
513
+ <!--
514
+
515
+ Admin Service exists in every instance. It is the configuration for either
516
+ a normal server, DAS or PE instance.
517
+
518
+ type an instance can either be of type:
519
+ das: Domain Administration Server in SE/EE
520
+ server: Any non-DAS instance in SE/EE
521
+ das-and-server: DAS with Deployment (PE case)
522
+ system-jmx-connector-name SE/EE only. Defines the name of the internally
523
+ used jmx-connector.
524
+
525
+ -->
526
+ <!ELEMENT admin-service (jmx-connector*, das-config?, property* )>
527
+ <!ATTLIST admin-service type (das|das-and-server|server) "server"
528
+ system-jmx-connector-name CDATA #IMPLIED>
529
+
530
+ <!-- SE/EE only. The jmx-connector element defines the configuration of a JSR 160 compliant
531
+ remote JMX Connector.
532
+ name name of jmx connector used for identification
533
+ protocol Defines the protocol that this jmx-connector should
534
+ support. Supported protocols are defined by Entity
535
+ rjmx-protocol. Sun ONE AS 8.0 supports "jmxmp" protocol.
536
+ For other protocols supported, refer to documentation.
537
+
538
+ address Specifies the IP address or host-name.
539
+ port Specifies the port of the jmx-connector-server.
540
+ Note that jmx-service-uRL is a function of protocol, port
541
+ and address as defined by the JSR 160 1.0 Specification.
542
+ accept-all Determines whether the connection can be made on all the
543
+ value of false implies that the connections only for
544
+ this specific address will be selected.
545
+ auth-realm-name The name of the auth-realm in this config element that represents the special
546
+ administrative realm. All authentication (from administraive GUI and CLI) will
547
+ be handled by this realm.
548
+ security-enabled Decides whether the transport layer security be used in
549
+ jmx-connector. If true, configure the ssl element.
550
+
551
+ Used in: admin-service.
552
+ -->
553
+ <!ELEMENT jmx-connector (ssl?, property*)>
554
+
555
+ <!ATTLIST jmx-connector name CDATA #REQUIRED
556
+ protocol %rjmx-protocol; "jmxmp"
557
+ address CDATA #REQUIRED
558
+ port CDATA #REQUIRED
559
+ accept-all %boolean; "false"
560
+ auth-realm-name CDATA #REQUIRED
561
+ security-enabled %boolean; "true">
562
+
563
+ <!--
564
+
565
+ dynamic-reload-enabled when true, server checks timestamp on a .reload
566
+ file at every module and application directory level to trigger
567
+ reload. polling frequency is controlled by
568
+ reload-poll-interval-in-seconds
569
+
570
+ autodeploy-enabled This will enable the autodeployment service. If true, the
571
+ service will automatically starts with the admin-server.
572
+ Auto Deployment is a feature that enables developers to quickly
573
+ deploy applications and modules to a running application server
574
+ withoutrequiring the developer to perform an explicit application
575
+ server restart or separate deployment operation.
576
+
577
+ autodeploy-polling-interval-in-seconds The polling interval (in seconds), at the end of
578
+ which autodeployment service will scan the source directory
579
+ (specified by "autodeploy-dir" tag) for any new deployable component.
580
+
581
+ autodeploy-dir The source directory (relative to instance root) from which autodeploy
582
+ service will pick deployable components. You can also specify an
583
+ absolute directory.
584
+
585
+ autodeploy-verifier-enabled To enable/disable verifier, during auto-deployment. If true,
586
+ verification will be done before any deployment activity.
587
+ In the event of any verifier test failure, deployment is
588
+ not performed.
589
+
590
+
591
+ autodeploy-jsp-precompilation-enabled If true, JSPs will be pre compiled during
592
+ deployment of the war module(s).
593
+
594
+ deploy-xml-validation specifies if descriptor validation is required or not.
595
+ full: xml will be validated and in case of xml validation errors,
596
+ deployment will fail.
597
+ parsing: xml errors will be reported but deployment process will continue.
598
+ none: no xml validation will be perfomed on the standard or
599
+ runtime deployment descriptors.
600
+
601
+ admin-session-timeout-in-minutes timeout in minutes indicating the administration gui session timeout.
602
+
603
+ -->
604
+ <!ELEMENT das-config (property*)>
605
+ <!ATTLIST das-config dynamic-reload-enabled %boolean; "false"
606
+ dynamic-reload-poll-interval-in-seconds CDATA '2'
607
+ autodeploy-enabled %boolean; "false"
608
+ autodeploy-polling-interval-in-seconds CDATA '30'
609
+ autodeploy-dir CDATA "autodeploy"
610
+ autodeploy-verifier-enabled %boolean; "false"
611
+ autodeploy-jsp-precompilation-enabled %boolean;"false"
612
+ deploy-xml-validation %validation-level; "full"
613
+ admin-session-timeout-in-minutes CDATA #IMPLIED >
614
+
615
+
616
+ <!-- SE/EE only. needs explanation TBD -->
617
+ <!ELEMENT web-container (session-config?, property*)>
618
+
619
+ <!ELEMENT session-config (session-manager?, session-properties?)>
620
+ <!ELEMENT session-manager (manager-properties?, store-properties?)>
621
+ <!ELEMENT manager-properties (property*)>
622
+ <!ATTLIST manager-properties session-file-name CDATA #IMPLIED
623
+ reap-interval-in-seconds CDATA #IMPLIED
624
+ max-sessions CDATA #IMPLIED
625
+ session-id-generator-classname CDATA #IMPLIED>
626
+
627
+ <!ELEMENT store-properties (property*)>
628
+ <!ATTLIST store-properties directory CDATA #IMPLIED
629
+ reap-interval-in-seconds CDATA #IMPLIED>
630
+
631
+ <!ELEMENT session-properties (property*)>
632
+ <!ATTLIST session-properties timeout-in-seconds CDATA #IMPLIED>
633
+
634
+
635
+ <!--
636
+ Configuration of EJB Container. Properties apply to all beans in all deployed
637
+ applications, unless different parameters are specified in Sun ONE Application Server
638
+ specific deployment descriptors. Applicability is indicated in middle column, using
639
+ the following acronyms:
640
+
641
+ slsb - stateless session bean
642
+ sfsb - stateful session bean
643
+ eb - entity bean (incl. read-only)
644
+
645
+ steady-pool-size slsb,eb number of bean instances normally maintained in pool. When a pool
646
+ is first created, it will be populated with size equal to
647
+ steady-pool-size. When an instance is removed from the pool, it
648
+ is replenished asynchronously, so that the pool size is at
649
+ or above the steady-pool-size. This additions will be in multiples
650
+ of pool-resize-quantity. When a bean is disassociated from a
651
+ method invocation, it is put back in the pool, subject to
652
+ max-pool-size limit. If the max pool size is exceeded the bean
653
+ id destroyed immediately. A pool cleaning thread, executes at
654
+ an interval defined by pool-idle-timeout-in-seconds. This thread
655
+ reduces the pool size to steady-pool-size, in steps defined by
656
+ pool-resize-quantity. If the pool is empty, the required object
657
+ will be created and returned immediately. This prevents threads
658
+ from blocking till the pool is replenished by the background
659
+ thread. steady-pool-size must be greater than 1 and at most equal
660
+ to the max-pool-size.
661
+
662
+ max-pool-size slsb,eb maximum size, a pool can grow to. A value of 0 implies
663
+ an unbounded pool. Unbounded pools eventually shrink to the
664
+ steady-pool-size, in steps defined by pool-resize-quantity.
665
+
666
+ pool-resize-quantity slsb,eb size of bean pool grows (shrinks) in steps specified by
667
+ pool-resize-quantity, subject to max-pool-size (steady-pool-size) limit.
668
+
669
+ Pool is resized when the pool cleaner thread runs. This rate at which
670
+ this thread runs is defined by pool-idle-timeout-in-seconds
671
+
672
+ pool-resize-quantity must be greater 1 and less than max-pool-size.
673
+ pool will never be resized below the steady pool size.
674
+
675
+ pool-idle-timeout-in-seconds slsb,eb defines the rate at which the pool cleaning thread is executed.
676
+ this thread checks if current size is greater than steady pool
677
+ size, it removes pool-resize-quantity elements. If the current
678
+ size is less than steady-pool-size it is increased by
679
+ pool-resize-quantity, with a ceiling of
680
+ min (current-pool-size+pool + resize-quantity, max-pool-size)
681
+ Only objects that have not been accessed for more than
682
+ pool-idle-timeout-in-seconds are candidates for removal.
683
+
684
+ cache-resize-quantity eb,sfsb Cache elements have identity, hence growth is in unit steps
685
+ and created on demand. Shrinking of cache happens
686
+
687
+ when cache-idle-timeout-in-seconds timer expires and a cleaner
688
+ thread passivates beans which have been idle for longer than
689
+ cache-idle-timeout-in-seconds. All idle instances are passivated at once.
690
+ cache-resize-quantity does not apply in this case.
691
+
692
+ when max cache size is reached, an asynchronous task is created
693
+ to bring the size back under the max-cache-size limit. This task
694
+ removes cache-resize-quantity elements, consulting the
695
+ victim-selection-policy.
696
+
697
+ Must be greater than 1 and less than max-cache-size.
698
+
699
+ max-cache-size sfsb,eb specifies the maximum number of instances that can be cached.
700
+ For entity beans, internally two caches are maintained for
701
+ higher concurrency: (i) Ready (R$) (ii) Active in an Incomplete
702
+ Transaction (TX$). The TX$ is populated with instances from R$
703
+ or from the Pool directly. When an instance in TX$ completes the
704
+ transaction, it is placed back in the R$ (or in pool, in case an
705
+ instance with same identity already is in R$). max-cache-size
706
+ only specifies the upper limit for R$. The container computes
707
+ an appropriate size for TX$.
708
+
709
+ cache-idle-timeout-in-seconds eb specifies the rate at which the cache cleaner thread is scheduled.
710
+ All idle instances are passivated at once.
711
+
712
+ removal-timeout-in-seconds sfsb Instance is removed from cache or passivation store, if it is
713
+ not accesed within this time. All instances that can be removed,
714
+ will be removed.
715
+
716
+ victim-selection-policy sfsb Victim selection policy when cache needs to shrink. fifo method
717
+ picks victims, oldest instance first. lru algorithm picks least
718
+ recently accessed instances. nru policy tries to pick
719
+ "not recently used" instances and is a pseudo-random selection
720
+ process. Victims are passivated. Entity Bean Victims are selected
721
+ always using fifo discipline. Does not apply to slsb because it
722
+ does not matter, which particular instances are removed.
723
+
724
+
725
+ commit-option eb Entity Beans caching is controlled by this setting. Commit Option
726
+ C implies that no caching is performed in the container.
727
+
728
+
729
+ Above defaults, apply only if they are not specified in vendor specific Bean Deployment Descriptors.
730
+
731
+
732
+ The ejb-timer-service element contains the configuration for the
733
+ ejb timer service. There is at most one ejb timer service per
734
+ server instance.
735
+
736
+ session-store specifies the directory where passivated beans and
737
+ persisted HTTP sessions are stored on the file system.
738
+ Defaults to $INSTANCE-ROOT/session-store
739
+
740
+ -->
741
+ <!ELEMENT ejb-container (ejb-timer-service?, property*)>
742
+
743
+ <!ATTLIST ejb-container steady-pool-size CDATA "32"
744
+ pool-resize-quantity CDATA "16"
745
+ max-pool-size CDATA "64"
746
+ cache-resize-quantity CDATA "32"
747
+ max-cache-size CDATA "512"
748
+ pool-idle-timeout-in-seconds CDATA "600"
749
+ cache-idle-timeout-in-seconds CDATA "600"
750
+ removal-timeout-in-seconds CDATA "5400"
751
+ victim-selection-policy (fifo | lru | nru ) "nru"
752
+ commit-option (B | C ) "B"
753
+ session-store CDATA #IMPLIED>
754
+
755
+ <!--
756
+ Configuration for ejb timer service.
757
+
758
+ "minimum-delivery-interval-in-millis" is the minimum number of milliseconds
759
+ allowed before the next timer expiration for a particular timer can occur.
760
+ It guards against extremely small timer increments that can overload
761
+ the server.
762
+
763
+ "max-redeliveries" is the maximum number of times the ejb timer service
764
+ will attempt to redeliver a timer expiration due to exception or
765
+ rollback. The minimum value is 1, per the ejb specification.
766
+
767
+ "timer-datasource" overrides the cmp-resource (jdbc/__TimerPool) specified
768
+ in sun-ejb-jar.xml of (__ejb_container_timer_app) of the timer service
769
+ system application. By default this is set to jdbc/__TimerPool, but
770
+ can be overridden for the cluster or server instance, if they choose to.
771
+
772
+ "redelivery-interval-in-millis" is the number of milliseconds the ejb
773
+ timer service will wait after a failed ejbTimeout delivery before
774
+ attempting a redelivery.
775
+
776
+ -->
777
+ <!ELEMENT ejb-timer-service (property*)>
778
+ <!ATTLIST ejb-timer-service minimum-delivery-interval-in-millis CDATA "7000"
779
+ max-redeliveries CDATA "1"
780
+ timer-datasource CDATA #IMPLIED
781
+ redelivery-interval-internal-in-millis CDATA "5000">
782
+
783
+
784
+
785
+
786
+ <!--
787
+ Configuration of MDB Container
788
+
789
+ steady-pool-size minimum and initial number of message driven beans in pool.
790
+ pool-resize-quantity quantum of increase/decrease, when the size of pool grows/shrinks.
791
+ max-pool-size maximum size, pool can grow to.
792
+ idle-timeout-in-seconds idle bean instance in pool becomes a candidate for deletion,
793
+ when this timeout expires.
794
+
795
+ The above pool defaults, apply if they are not specified
796
+ in the Sun ONE Application Server specific Deployment
797
+ Descriptors.
798
+
799
+ -->
800
+ <!ELEMENT mdb-container (property*)>
801
+
802
+ <!ATTLIST mdb-container steady-pool-size CDATA "10"
803
+ pool-resize-quantity CDATA "2"
804
+ max-pool-size CDATA "60"
805
+ idle-timeout-in-seconds CDATA "600">
806
+
807
+ <!--
808
+ The jms-service element specifies information about the bundled/built-in
809
+ JMS service that is managed by Application Server.
810
+
811
+ If the "enabled" attribute is set to "true", the server instance
812
+ will be responsible for starting up and shutting down the JMS service.
813
+ If the "enabled" attribute is set to "false", the server instance
814
+ will not startup nor shutdown the JMS service (either because JMS
815
+ is not used or because it is managed independently of application server).
816
+
817
+ "port" attribute specifies the port number used by the JMS service.
818
+ "admin-username" attribute specifies the admin username.
819
+ "admin-password" attribute specifies the admin password.
820
+
821
+ "init-timeout-in-seconds" specifies the time server instance
822
+ will wait at start up, for its corresponding JMS service instance
823
+ to respond. If there is no response within the specifies timeout
824
+ period, application server startup is aborted.
825
+
826
+ "start-args" specifies the arguments that will be supplied to
827
+ start up the corresponding JMS service instance.
828
+ -->
829
+ <!ELEMENT jms-service (jms-host*, property*)>
830
+
831
+ <!ATTLIST jms-service init-timeout-in-seconds CDATA "60"
832
+ type (LOCAL|NONE|REMOTE) "LOCAL"
833
+ start-args CDATA #IMPLIED>
834
+
835
+ <!ELEMENT jms-host (property*)>
836
+ <!ATTLIST jms-host name CDATA #REQUIRED
837
+ host CDATA #IMPLIED
838
+ port CDATA "7676"
839
+ admin-user-name CDATA "admin"
840
+ admin-password CDATA "admin">
841
+
842
+ <!-- Generic Log Service Configuration
843
+
844
+ By default, logs would be kept in $INSTANCE-ROOT/logs. The following log
845
+ files will be stored under the logs directory.
846
+
847
+ access.log keeps default virtual server HTTP access messages.
848
+ server.log keeps log messages from default virtual server.
849
+ Messages from other configured virtual servers
850
+ also go here, unless log-file is explicitly
851
+ specified in the virtual-server element.
852
+
853
+ file attribute can be used to rename or relocate server.log using absolute
854
+ path.
855
+
856
+ use-system-logging if true, will utilize Unix syslog service or Windows
857
+ Event Logging to produce and manage logs.
858
+
859
+ log-handler Can plug in a custom log handler to add it to the chain of
860
+ handlers to log into a different log destination than the default
861
+ ones given by the system (which are Console, File and Syslog). It is
862
+ a requirement that customers use the log formatter provided by the the
863
+ system to maintain uniformity in log messages. The custom log handler will
864
+ be added at the end of the handler chain after File + Syslog Handler,
865
+ Console Handler and JMX Handler. User cannot replace the handler
866
+ provided by the system, because of loosing precious log statements. The
867
+ Server Initialization will take care of installing the custom handler
868
+ with the system formatter initialized. The user need to use JSR 047
869
+ Log Handler Interface to implement the custom handler.
870
+
871
+ log-filter Can plug in a log filter to do custom filtering of log records . By
872
+ default there is no log filter other than the log level filtering
873
+ provided by JSR 047 log API.
874
+
875
+ log-to-console logs will be sent to stderr when asadmin start-domain verbose is used
876
+
877
+ log-rotation-limit-in-bytes Log Files will be rotated when the file size reaches the limit.
878
+
879
+ alarms if true, will turn on alarms for the logger. The SEVERE and WARNING messages
880
+ can be routed through the JMX framework to raise SEVERE and WARNING alerts. Alarms
881
+ are turned off by default.
882
+
883
+ -->
884
+ <!ELEMENT log-service (module-log-levels?, property*)>
885
+ <!ATTLIST log-service file CDATA #IMPLIED
886
+ use-system-logging %boolean; "false"
887
+ log-handler CDATA #IMPLIED
888
+ log-filter CDATA #IMPLIED
889
+ log-to-console %boolean; "false"
890
+ log-rotation-limit-in-bytes CDATA "500000"
891
+ alarms %boolean; "false">
892
+
893
+ <!--
894
+ Configure the Log Levels for Various Loggers in the SUN ONE Modules.
895
+ The Default level is set to INFO, The log levels can be changed
896
+ using one of the seven levels. Please refer JSR 047 to understand
897
+ the Log Levels.
898
+
899
+ The Logs can be completely turned off by using 'OFF' value. The names
900
+ of the module loggers are self-explanatory
901
+
902
+ transaction If greater or less verbosity is desired from transaction
903
+ sub-system this can be adjusted. Note that this refers to
904
+ logging messages and not transaction co-ordination logs.
905
+ -->
906
+ <!ENTITY % log-level "(FINEST|FINER|FINE|CONFIG|INFO|WARNING|SEVERE|OFF)">
907
+ <!ELEMENT module-log-levels (property*)>
908
+ <!ATTLIST module-log-levels
909
+ root %log-level; "INFO"
910
+ server %log-level; "INFO"
911
+ ejb-container %log-level; "INFO"
912
+ cmp-container %log-level; "INFO"
913
+ mdb-container %log-level; "INFO"
914
+ web-container %log-level; "INFO"
915
+ classloader %log-level; "INFO"
916
+ configuration %log-level; "INFO"
917
+ naming %log-level; "INFO"
918
+ security %log-level; "INFO"
919
+ jts %log-level; "INFO"
920
+ jta %log-level; "INFO"
921
+ admin %log-level; "INFO"
922
+ deployment %log-level; "INFO"
923
+ verifier %log-level; "INFO"
924
+ jaxr %log-level; "INFO"
925
+ jaxrpc %log-level; "INFO"
926
+ saaj %log-level; "INFO"
927
+ corba %log-level; "INFO"
928
+ javamail %log-level; "INFO"
929
+ jms %log-level; "INFO"
930
+ connector %log-level; "INFO"
931
+ jdo %log-level; "INFO"
932
+ cmp %log-level; "INFO"
933
+ resource-adapter %log-level; "INFO">
934
+
935
+ <!--
936
+ The security service element defines parameters and configuration
937
+ information needed by the core J2EE security service. Some
938
+ container-specific security configuration elements are in the
939
+ various container configuration elements and not here. SSL
940
+ configuration is also elsewhere. At this time the security service
941
+ configuration consists of a set of authentication realms. A number
942
+ of top-level attributes are defined as well.
943
+
944
+ default-realm: Specifies which realm (by name) is used by default when no
945
+ realm is specifically requested. The file realm is the common default.
946
+ default-principal: Used as the identity of default security contexts when
947
+ necessary and no principal is provided.
948
+ default-principal-pwd: Password of default principal.
949
+ anonymous-role: Used as role name for default/anonymous role.
950
+ audit-enabled: If true, additional access logging is performed to provide
951
+ audit information.
952
+ jacc: Specifies the name of the jacc-provider element to use for setting
953
+ up the JACC infrastructure. The default value "default" does not need
954
+ to be changed unless adding a custom JACC provider.
955
+ audit-modules: Optional list of audit provider modules which will be used
956
+ by the audit subsystem. The default value refers to the internal
957
+ log-based audit module.
958
+ -->
959
+
960
+ <!ELEMENT security-service (auth-realm+ , jacc-provider+ , audit-module*, property*)>
961
+ <!ATTLIST security-service default-realm CDATA "file"
962
+ default-principal CDATA #IMPLIED
963
+ default-principal-password CDATA #IMPLIED
964
+ anonymous-role CDATA "ANYONE"
965
+ audit-enabled %boolean; "false"
966
+ jacc CDATA "default"
967
+ audit-modules CDATA "default">
968
+
969
+ <!--
970
+ An audit-module specifies an optional plug-in module which implements
971
+ audit capabilities.
972
+
973
+ name: defines the name of this realm
974
+ classname: defines the java class which implements this audit module
975
+ -->
976
+
977
+ <!ELEMENT audit-module (property*)>
978
+ <!ATTLIST audit-module name CDATA #REQUIRED
979
+ classname CDATA #REQUIRED>
980
+
981
+
982
+ <!--
983
+ The auth-realm element defines and configures one authentication realm.
984
+ There must be at least one realm available for a server instance; any
985
+ number can be configured, as desired.
986
+
987
+ Authentication realms need provider-specific parameters which vary depending
988
+ on what a particular implementation needs; these are defined as properties
989
+ since they vary by provider and cannot be predicted for any custom or add-on
990
+ providers.
991
+
992
+ For the default file provider, the param used is: file
993
+
994
+ name: defines the name of this realm
995
+ classname: defines the java class which implements this realm
996
+ property: name/value pairs of provider implementation specific attributes.
997
+
998
+ -->
999
+
1000
+ <!ELEMENT auth-realm (property*)>
1001
+ <!ATTLIST auth-realm name CDATA #REQUIRED
1002
+ classname CDATA #REQUIRED>
1003
+
1004
+ <!--
1005
+ The jacc-provider element defines the standard JACC properties used for
1006
+ setting up the JACC provider. It also allows optional properties which can
1007
+ be used by the provider implementation for its configuration.
1008
+
1009
+ name: A name for this jacc-provider. Is always "default" for the default
1010
+ provider.
1011
+ policy-provider: Corresponds to (and can be overridden by) the system
1012
+ property javax.security.jacc.policy.provider
1013
+ policy-configuration-factory-provider: Corresponds to (and can be
1014
+ overridden by) the system property
1015
+ javax.security.jacc.PolicyConfigurationFactory.provider
1016
+
1017
+ -->
1018
+
1019
+ <!ELEMENT jacc-provider (property*)>
1020
+ <!ATTLIST jacc-provider name CDATA #REQUIRED
1021
+ policy-provider CDATA #REQUIRED
1022
+ policy-configuration-factory-provider CDATA #REQUIRED>
1023
+
1024
+ <!-- Configuration for Transaction Manager.
1025
+ automatic-recovery if true, server instance attempts recovery at restart.
1026
+ timeout-in-seconds amount of time the transaction manager waits for
1027
+ response from a datasource participating in transaction.
1028
+ A value of 0 implies infinite timeout.
1029
+
1030
+ tx-log-dir By default the transaction log is kept in the directory
1031
+ $INSTANCE-ROOT/logs/tx. If user specifies log-root
1032
+ attribute under <domain> element, tx.log would appear
1033
+ in that directory. User can also specify an alternative
1034
+ location using transaction-service.txlog-file attribute.
1035
+ The transaction service creates and uses 3 files for
1036
+ logging and tracking transactions in progress.
1037
+
1038
+ heuristic-decision During recovery, if outcome of a transaction cannot be
1039
+ determined from the logs, then this property is used
1040
+ to fix the outcome.
1041
+
1042
+ retry-timeout-in-seconds used to determine the retry time in the following
1043
+ scenarios.
1044
+ 1. Time to wait at the transaction recovery time,
1045
+ when resources are unreachable.
1046
+ 2. If there are any transient exceptions in the
1047
+ second phase of the 2 PC protocol.
1048
+ A negative value indicates infinite retry.
1049
+ '0' indicates no retry.
1050
+ A positive value indicates the number of seconds for
1051
+ which retry will be attempted. Default is 10 minutes
1052
+ which may be appropriate for a database being restarted.
1053
+
1054
+ keypoint-interval property used to specify the number of transactions between
1055
+ keypoint operations on the log. A Keypoint operations could
1056
+ reduce the size of the transaction log files. A larger value
1057
+ for this property (for example, 1000) will result in larger
1058
+ transaction log files, between log compactions, but less
1059
+ keypoint operations, and potentially better performance.
1060
+ A smaller value (e.g. 20) results in smaller log files but
1061
+ slightly reduced performance due to the greater frequency of
1062
+ keypoint operations.
1063
+
1064
+ -->
1065
+ <!ELEMENT transaction-service (property*)>
1066
+
1067
+ <!ATTLIST transaction-service automatic-recovery %boolean; "false"
1068
+ timeout-in-seconds CDATA "0"
1069
+ tx-log-dir CDATA #IMPLIED
1070
+ heuristic-decision (rollback | commit ) "rollback"
1071
+ retry-timeout-in-seconds CDATA "600"
1072
+ keypoint-interval CDATA "2048">
1073
+
1074
+
1075
+ <!-- Configuration for monitoring service -->
1076
+
1077
+ <!ELEMENT monitoring-service (module-monitoring-levels?, property*)>
1078
+
1079
+ <!--
1080
+ The attributes of module-monitoring-levels define various monitoring levels for various components:
1081
+
1082
+ thread-pool all the thread-pools used by the run time.
1083
+ orb ORB, its connection managers etc. (WHAT IS ETC? TBD???)
1084
+ ejb-container various ejbs deployed to the server, ejb-pools, ejb-caches and ejb-methods.
1085
+ transaction-service transaction subsystem.
1086
+ http-service h ttp engine and the http listeners therein.
1087
+ jdbc-connection-pool monitoring level for all the jdbc-connection-pools used by the runtime.
1088
+ connector-connection-pool monitoring level for all the connector-connection-pools used by the runtime.
1089
+ -->
1090
+
1091
+ <!ELEMENT module-monitoring-levels (property*)>
1092
+ <!ATTLIST module-monitoring-levels thread-pool %monitoring-level; "OFF"
1093
+ orb %monitoring-level; "OFF"
1094
+ ejb-container %monitoring-level; "OFF"
1095
+ web-container %monitoring-level; "OFF"
1096
+ transaction-service %monitoring-level; "OFF"
1097
+ http-service %monitoring-level; "OFF"
1098
+ jdbc-connection-pool %monitoring-level; "OFF"
1099
+ connector-connection-pool %monitoring-level; "OFF" >
1100
+
1101
+ <!-- Java Runtime environment configuration
1102
+
1103
+ java-home Specifies the installation directory for Java runtime.
1104
+ JDK 1.4 or higher is supported.
1105
+ debug-enabled If set to true, the server starts up in debug mode ready for
1106
+ attaching with a JPDA based debugger.
1107
+ debug-options JPDA based debugging options string.
1108
+ rmic-options Options string passed to RMI compiler, at application deployment
1109
+ time.
1110
+ javac-options Options string passed to Java compiler, at application deployment
1111
+ time.
1112
+ classpath-prefix A java classpath string that is prefixed to server-classpath
1113
+ classpath-suffix A java classpath string that is appended to server-classpath
1114
+ server-classpath A java classpath string that specifies the classes needed by the
1115
+ Application server. Do not expect users to change this under
1116
+ normal conditions.
1117
+
1118
+
1119
+ native-library-path is automatically constructed to be a concatenation of Application
1120
+ Server installation relative path for its native shared libraries, standard JRE native
1121
+ library path, the shell environment setting (LD-LIBRARY-PATH on Unix) and any path
1122
+ that may be specified in the profile element. Since this is synthesied, it is not
1123
+ required to have this appear explicitly in the server configuration.
1124
+
1125
+ native-library-path-prefix (native-library-path-suffix) is prepended (appended) to
1126
+ the native library path, which is constricted as per the above description.
1127
+
1128
+ bytecode-preprocessors A comma separated list of classnames, each of which must
1129
+ implement the com.sun.appserv.BytecodePreprocessor interface.
1130
+ Each of the specified preprocessor class will be called in the
1131
+ order specified. At the moment the comelling use is for a 3rd
1132
+ party Performance Profiling tool.
1133
+
1134
+ env-classpath-ignored If set to false, the CLASSPATH environment variable will be
1135
+ read and appended to the Application Server classpath, which
1136
+ is constructed as described above. The CLASSPATH environment
1137
+ variable will be added after the classpath-suffix, at the very
1138
+ end.
1139
+ -->
1140
+ <!ELEMENT java-config (profiler? , (jvm-options | property)*)>
1141
+
1142
+ <!ATTLIST java-config java-home CDATA #REQUIRED
1143
+ debug-enabled %boolean; "false"
1144
+ debug-options CDATA "-Xdebug -Xrunjdwp:transport=dt-socket,server=y,suspend=n"
1145
+ rmic-options CDATA "-iiop -poa -alwaysgenerate -keepgenerated -g"
1146
+ javac-options CDATA "-g"
1147
+ classpath-prefix CDATA #IMPLIED
1148
+ classpath-suffix CDATA #IMPLIED
1149
+ server-classpath CDATA #IMPLIED
1150
+ native-library-path-prefix CDATA #IMPLIED
1151
+ native-library-path-suffix CDATA #IMPLIED
1152
+ bytecode-preprocessors CDATA #IMPLIED
1153
+ env-classpath-ignored %boolean; "true" >
1154
+ <!-- String value for options that will be passed to the JVM -->
1155
+ <!ELEMENT jvm-options (#PCDATA)>
1156
+
1157
+ <!-- Profilers could be one of jprobe, optimizeit, hprof, wily and so on
1158
+ jvm-options and property elements are used to record the settings
1159
+ needed to get a particular profiler going. A server instance is tied
1160
+ to a particular profiler, by the profiler element in java-config.
1161
+ Changing the profiler will require a server restart.
1162
+
1163
+ The adminstrative graphical interfaces, could list multiple supported
1164
+ profilers (incomplete at this point) and will populate server.xml
1165
+ appropriately.
1166
+ -->
1167
+ <!ELEMENT profiler ((jvm-options | property)*)>
1168
+
1169
+ <!ATTLIST profiler name CDATA #REQUIRED
1170
+ classpath CDATA #IMPLIED
1171
+ native-library-path CDATA #IMPLIED
1172
+ enabled %boolean; "true" >
1173
+
1174
+
1175
+ <!-- SE/EE only: TBD Needs explanation
1176
+ quick-checkpoint EJB container tries to convert an SFSB to
1177
+ a serializable form before saving it to a checkpointing
1178
+ store. If it fails to serialize the SFSB, it normally calls
1179
+ the ejbPassivate() method on the SFSB, since the application
1180
+ developer is expected to implement an ejbPassivate() method
1181
+ to ensure that the bean is in serializable form before
1182
+ passivation. However invocation of ejbPassivate() causes
1183
+ additional performance overhead on the checkpointing mechanism.
1184
+ By setting the quick-checkpoint flag to true, the application
1185
+ deployer can ensure that the ejbPassivate() method is not invoked
1186
+ on a particular SFSB, or for any SFSB within a scope
1187
+ (ejb-container, a J2EE application, or an EJB module),
1188
+ before checkpointing to persistent store. This minimizes the
1189
+ overhead of the checkpointing operation.
1190
+
1191
+ checkpoint-location specifies a Stateful enterprise bean's check pointing mechanism
1192
+ type. Whether checkpointing is done at the end of transaction or
1193
+ at the end of method calls. The checkpoint-location element must
1194
+ be one of the following: end-of-transaction or end-of-method
1195
+ -->
1196
+
1197
+ <!ELEMENT availability-service (web-container-availability?, ejb-container-availability?, property*)>
1198
+ <!ATTLIST availability-service availability-enabled %boolean; "false">
1199
+
1200
+ <!ELEMENT web-container-availability (property)*>
1201
+ <!ATTLIST web-container-availability persistence-type %persistence-type; "memory"
1202
+ persistence-frequency %session-save-frequency; #IMPLIED
1203
+ persistence-scope %session-save-scope; #IMPLIED
1204
+ persistence-store-health-check-enabled %boolean; "false"
1205
+ sso-failover-enabled %boolean; "false"
1206
+ http-session-store-pool-name CDATA #REQUIRED>
1207
+
1208
+ <!ELEMENT ejb-container-availability (property*)>
1209
+ <!ATTLIST ejb-container-availability sfsb-checkpoint-enabled %boolean; "false"
1210
+ sfsb-quick-checkpoint-enabled %boolean; "false"
1211
+ sfsb-store-pool-name CDATA #REQUIRED>
1212
+
1213
+ <!--
1214
+ Quorum Service is used by instances to determine the membership composition of the cluster.
1215
+
1216
+ name should correspond to the cluster name
1217
+ serviceClassName Fully qualified class name of the group service provider implementation
1218
+
1219
+ -->
1220
+ <!ELEMENT quorum-service (property*)>
1221
+ <!ATTLIST quorum-service
1222
+ name CDATA #REQUIRED
1223
+ service-classname CDATA
1224
+ "com.sun.enterprise.ee.quorum.impl.jmx.S1ASJMXGroupServiceProvider">
1225
+
1226
+
1227
+ <!--
1228
+ jdbc-connection-pool defines configuration used to create and manage
1229
+ a pool physical database connections. Pool definition is named, and
1230
+ can be referred to by multiple jdbc-resource elements (See <jdbc-resource>).
1231
+
1232
+ Each named pool definition results in a pool instantiated at server
1233
+ start-up. Pool is populated when accessed for the first time. If two
1234
+ or more jdbc-resource elements point to the same jdbc-connection-pool
1235
+ element, they are using the same pool of connections, at run time.
1236
+
1237
+ name unique name of the pool definition.
1238
+
1239
+ datasource-classname Name of the vendor supplied JDBC datasource
1240
+ resource manager. An XA or global transactions
1241
+ capable datasource class will implement
1242
+ javax.sql.XADatasource interface. Non XA or
1243
+ Local transactions only datasources will
1244
+ implement javax.sql.Datasource interface.
1245
+
1246
+ res-type DataSource implementation class could implement
1247
+ one or both of javax.sql.DataSource, javax.sql.XADataSource
1248
+ interfaces. This optional attribute must be specified to
1249
+ disambiguate when a Datasource class implements both
1250
+ interfaces. An error is produced when this attribute has
1251
+ a legal value and the indicated interface is not implemented
1252
+ by the datasource class. This attribute has no default value.
1253
+
1254
+ steady-pool-size minimum and initial number of connections
1255
+ maintained in the pool.
1256
+
1257
+ max-pool-size maximum number of conections that can be created
1258
+
1259
+ max-wait-time-in-millis amount of time the caller will wait before getting
1260
+ a connection timeout. The default is 60 seconds.
1261
+ A value of 0 will force caller to wait indefinitely.
1262
+
1263
+ pool-resize-quantity number of connections to be removed when
1264
+ idle-timeout-in-seconds timer expires. Connections
1265
+ that have idled for longer than the timeout are
1266
+ candidates for removal. When the pool size reaches
1267
+ steady-pool-size, the connection removal stops.
1268
+
1269
+ idle-timeout-in-seconds maximum time in seconds, that a connection can
1270
+ remain idle in the pool. After this time, the pool
1271
+ implementation can close this connection. Note that
1272
+ this does not control connection timeouts enforced
1273
+ at the database server side. Adminsitrators are
1274
+ advised to keep this timeout shorter than the database
1275
+ server side timeout (if such timeouts are configured
1276
+ on the specific vendor's database), to prevent
1277
+ accumulation of unusable connection in Application Server.
1278
+
1279
+ transaction-isolation-level Specifies the Transaction Isolation Level on the pooled
1280
+ database connections. Optional. Has no default. If left
1281
+ unspecified the pool operates with default isolation level
1282
+ provided by the JDBC Driver. A desired isolation level
1283
+ can be set using one of the standard transaction isolation
1284
+ levels: read-uncommitted, read-committed, repeatable-read,
1285
+ serializable
1286
+
1287
+ Applications that change the Isolation level on a pooled
1288
+ connection programmatically, risk polluting the pool and this
1289
+ could lead to program errors.
1290
+ Also see: is-isolation-level-guaranteed
1291
+
1292
+ is-isolation-level-guaranteed Applicable only when a particular isolation level is specified
1293
+ for transaction-isolation-level. The default value is true.
1294
+ This assures that every time a connection is obtained from
1295
+ the pool, it is guaranteed to have the isolation set to the
1296
+ desired value. This could have some performance impact on
1297
+ some JDBC drivers. Can be set to false by that administrator
1298
+ when they are certain that the application does not
1299
+ change the isolation level before returning the connection.
1300
+
1301
+ is-connection-validation-required if true, connections are validated (checked to
1302
+ find out if they are usable) before giving out to
1303
+ the application. The default is false.
1304
+
1305
+ If is-connection-validation-required is true then connection-validation-type
1306
+ specifies the type of validation to be performed. Three types of validation
1307
+ are supported:
1308
+
1309
+ 1) using connection.autoCommit(),
1310
+ 2) using connection.getMetaData()
1311
+ 3) performing a query on a user specified table (see validation-table-name).
1312
+
1313
+ The possible values are one of: auto-commit | meta-data | table
1314
+
1315
+ validation-table-name specifies the table name to be used to perform a query to
1316
+ validate a connection. This parameter is mandatory, if connection-validation-type
1317
+ set to table. Verification by accessing a user specified table may become necessary
1318
+ for connection validation, particularly if database driver caches calls to
1319
+ setAutoCommit() and getMetaData().
1320
+
1321
+ fail-all-connections: indicates if all connections in the pool must be
1322
+ closed should a single validation check fail. The
1323
+ default is false. One attempt will be made to
1324
+ re-establish failed connections.
1325
+
1326
+ Use of property lists:
1327
+
1328
+ Most JDBC 2.0 drivers permit use of standard property lists, to specify User, Password
1329
+ and other resource configuration. While these are optional properties, according to the
1330
+ specification, several of these properties may be necessary for most databases. See
1331
+ Section 5.3 of JDBC 2.0 Standard Extension API.
1332
+
1333
+ Name Value
1334
+
1335
+ databaseName Name of the Database.
1336
+ serverName Database Server name.
1337
+ port Port where a Database server is listening for requests.
1338
+ networkProtocol Communication Protocol used.
1339
+ user default name of the database user with which
1340
+ connections will be stablished. Programmatic database
1341
+ authentication or default-resource-principal specified
1342
+ in vendor specific web and ejb deployment descriptors
1343
+ will take precedence, over this default. The details
1344
+ and caveats are described in detail in the
1345
+ Administrator's guide.
1346
+ password password for default database user
1347
+ roleName The initial SQL role name.
1348
+ datasourceName used to name an underlying XADataSource, or
1349
+ ConnectionPoolDataSource when pooling of connections
1350
+ is done
1351
+ description Textual description
1352
+
1353
+ When one or more of these properties are specified, they are passed as is using
1354
+ set<Name>(<Value>) methods to the vendors Datasource class (specified in
1355
+ datasource-classname). User and Password properties are used as default principal,
1356
+ if Container Managed authentication is specified and a default-resource-principal is
1357
+ not found in application deployment descriptors.
1358
+ -->
1359
+ <!ELEMENT jdbc-connection-pool (description? , property*)>
1360
+
1361
+ <!ATTLIST jdbc-connection-pool name CDATA #REQUIRED
1362
+ datasource-classname CDATA #REQUIRED
1363
+ res-type CDATA #IMPLIED
1364
+ steady-pool-size CDATA "8"
1365
+ max-pool-size CDATA "32"
1366
+ max-wait-time-in-millis CDATA "60000"
1367
+ pool-resize-quantity CDATA "2"
1368
+ idle-timeout-in-seconds CDATA "300"
1369
+ transaction-isolation-level %isolation; #IMPLIED
1370
+ is-isolation-level-guaranteed %boolean; "true"
1371
+ is-connection-validation-required %boolean; "false"
1372
+ connection-validation-method (auto-commit |
1373
+ meta-data |
1374
+ table ) "auto-commit"
1375
+ validation-table-name CDATA #IMPLIED
1376
+ fail-all-connections %boolean; "false" >
1377
+
1378
+
1379
+
1380
+ <!--
1381
+ connector-connection-pool defines configuration used to create and manage
1382
+ a pool of connections to a EIS. Pool definition is named, and
1383
+ can be referred to by multiple connector-resource elements (See <connector-resource>).
1384
+
1385
+ Each named pool definition results in a pool instantiated at server
1386
+ start-up. Pool is populated when accessed for the first time. If two
1387
+ or more connector-resource elements point to the same connector-connection-pool
1388
+ element, they are using the same pool of connections, at run time.
1389
+
1390
+ There can be more than one pool for one connection-definition in one resource-adapter.
1391
+
1392
+ name unique name of the pool definition.
1393
+
1394
+ resource-adapter-name This is the name of resource adapter. Name of .rar file
1395
+ is taken as the unique name for the resource adapter.
1396
+
1397
+ connection-definition-name unique name, identifying one connection-definition in
1398
+ a Resource Adapter. Currently this is ConnectionFactory
1399
+ type.
1400
+
1401
+ steady-pool-size minimum and initial number of connections
1402
+ maintained in the pool.
1403
+
1404
+ max-pool-size maximum number of conections that can be created
1405
+
1406
+ max-wait-time-in-millis amount of time the caller will wait before getting
1407
+ a connection timeout. The default is 60 seconds.
1408
+ A value of 0 will force caller to wait indefinitely.
1409
+
1410
+ pool-resize-quantity number of connections to be removed when
1411
+ idle-timeout-in-seconds timer expires. Connections
1412
+ that have idled for longer than the timeout are
1413
+ candidates for removal. When the pool size reaches
1414
+ steady-pool-size, the connection removal stops.
1415
+
1416
+ idle-timeout-in-seconds maximum time in seconds, that a connection can
1417
+ remain idle in the pool. After this time, the pool
1418
+ implementation can close this connection. Note that
1419
+ this does not control connection timeouts enforced
1420
+ at the database server side. Adminsitrators are
1421
+ advised to keep this timeout shorter than the EIS
1422
+ connection timeout (if such timeouts are configured
1423
+ on the specific EIS), to prevent accumulation
1424
+ of unusable connection in Application Server.
1425
+ fail-all-connections: indicates if all connections in the pool must be
1426
+ closed should a single connection fail validation. The
1427
+ default is false. One attempt will be made to
1428
+ re-establish failed connections.
1429
+
1430
+ Use of property lists:
1431
+
1432
+ Properties are used to override the ManagedConnectionFactory javabean configuration
1433
+ settings.
1434
+
1435
+ When one or more of these properties are specified, they are passed as is using
1436
+ set<Name>(<Value>) methods to the Resource Adapter's ManagedConnectionfactory class
1437
+ (specified in ra.xml).
1438
+ -->
1439
+ <!ELEMENT connector-connection-pool (description?, security-map*, property*)>
1440
+ <!ATTLIST connector-connection-pool name CDATA #REQUIRED
1441
+ resource-adapter-name CDATA #REQUIRED
1442
+ connection-definition-name CDATA #REQUIRED
1443
+ steady-pool-size CDATA "8"
1444
+ max-pool-size CDATA "32"
1445
+ max-wait-time-in-millis CDATA "60000"
1446
+ pool-resize-quantity CDATA "2"
1447
+ idle-timeout-in-seconds CDATA "300"
1448
+ fail-all-connections %boolean; "false">
1449
+
1450
+ <!-- Perform mapping from principal received during Servlet/EJB authentication, to
1451
+ credentials accepted by the EIS. This mapping is optional.It is possible to
1452
+ map multiple (server) principal to the same backend principal.
1453
+ -->
1454
+ <!ELEMENT security-map ((principal | user-group)+, backend-principal)>
1455
+ <!ATTLIST security-map name CDATA #REQUIRED>
1456
+
1457
+ <!-- Principal of the Servlet and EJB client -->
1458
+ <!ELEMENT principal (#PCDATA)>
1459
+
1460
+ <!-- Group of user -->
1461
+ <!ELEMENT user-group (#PCDATA)>
1462
+
1463
+ <!-- Backend EIS principal -->
1464
+ <!ELEMENT backend-principal EMPTY>
1465
+ <!ATTLIST backend-principal user-name CDATA #REQUIRED
1466
+ password CDATA #IMPLIED>
1467
+
1468
+
1469
+ <!ELEMENT thread-pools (thread-pool+)>
1470
+
1471
+ <!--
1472
+ thread-pool-id This is an id for the work-queue e.g.
1473
+ "thread-pool-1", "thread-pool-2" etc
1474
+ min-thread-pool-size Minimum number of threads in the threadpool
1475
+ servicing requests in this queue.
1476
+ These are created up front when this threadpool
1477
+ is instantiated
1478
+ max-thread-pool-size Maximum number of threads in the threadpool
1479
+ servicing requests in this queue. This is the
1480
+ upper bound on the no. of threads that
1481
+ exist in the threadpool.
1482
+ idle-thread-timeout-in-seconds idle threads are removed from pool, after this time
1483
+ num-work-queues This denotes the total number of work queues
1484
+ that are serviced by this threadpool.
1485
+ -->
1486
+
1487
+ <!ELEMENT thread-pool EMPTY>
1488
+ <!ATTLIST thread-pool thread-pool-id CDATA #REQUIRED
1489
+ min-thread-pool-size CDATA "0"
1490
+ max-thread-pool-size CDATA "200"
1491
+ idle-thread-timeout-in-seconds CDATA "120"
1492
+ num-work-queues CDATA "1">
1493
+
1494
+
1495
+ <!-- Syntax for supplying properties as name value pairs -->
1496
+ <!ELEMENT property (description?)>
1497
+
1498
+ <!ATTLIST property name CDATA #REQUIRED
1499
+ value CDATA #REQUIRED >
1500
+
1501
+
1502
+
1503
+ <!-- SERVER SECTION -->
1504
+
1505
+ <!-- J2EE Application Server Configuration
1506
+
1507
+ Each Application Server instance is a J2EEv1.4 compliant container.
1508
+ One server instance is specially designated as the Administration Server in SE/EE.
1509
+ User applications cannot be deployed to an Adminsitration Server instance.
1510
+
1511
+ instance-name name of the server instance.
1512
+
1513
+
1514
+ config-ref points to a named config. needed for stand-alone servers.
1515
+ If the server instance is part of a cluster, then it must
1516
+ not be present, and will be ignored.
1517
+
1518
+ node-controller-ref SE/EE only. Specifies the name of the node controller where
1519
+ the server instance is hosted.
1520
+
1521
+ application-ref References to applications deployed to the server instance
1522
+
1523
+ resource-ref References to resources deployed to the server instance
1524
+
1525
+ -->
1526
+ <!ELEMENT server (application-ref* , resource-ref* , property*)>
1527
+ <!ATTLIST server name CDATA #REQUIRED
1528
+ config-ref CDATA #IMPLIED
1529
+ node-controller-ref CDATA #IMPLIED
1530
+ >
1531
+
1532
+ <!ELEMENT application-ref EMPTY>
1533
+ <!ATTLIST application-ref enabled %boolean; "true"
1534
+ virtual-servers CDATA #IMPLIED
1535
+ ref CDATA #REQUIRED
1536
+ >
1537
+
1538
+ <!ELEMENT resource-ref EMPTY>
1539
+ <!ATTLIST resource-ref enabled %boolean; "true"
1540
+ ref CDATA #REQUIRED>
1541
+
1542
+
1543
+ <!-- SE/EE Cluster configuration. A cluster defines a homogenous set of
1544
+ server instances that share the same applications, resources, and configuration.
1545
+
1546
+ name cluster name
1547
+
1548
+ config-ref points to a named config. All server instances in the cluster will
1549
+ share this config.
1550
+
1551
+ server-ref list of servers in the cluster.
1552
+ -->
1553
+ <!ELEMENT cluster (server-ref*, resource-ref*, application-ref*)>
1554
+ <!ATTLIST cluster name CDATA #REQUIRED
1555
+ config-ref CDATA #REQUIRED>
1556
+
1557
+ <!ELEMENT server-ref EMPTY>
1558
+ <!ATTLIST server-ref ref CDATA #REQUIRED>
1559
+
1560
+ <!-- SE/EE Node Controller. The node controller is an agent that manages
1561
+ server instances on a host machine.
1562
+
1563
+ name Node Controller name
1564
+
1565
+ system-jmx-connector-name The name of the internal jmx connector
1566
+
1567
+ stop-servers-in-shutdown If true stops all managed server instances when
1568
+ the Node Controller is stopped.
1569
+
1570
+ start-servers-in-startup If true starts all managed server instances when
1571
+ the Node Controller is started.
1572
+ -->
1573
+
1574
+ <!ELEMENT node-controller (jmx-connector+, log-service, property*)>
1575
+ <!ATTLIST node-controller name CDATA #REQUIRED
1576
+ system-jmx-connector-name CDATA #REQUIRED
1577
+ stop-servers-in-shutdown %boolean; "false"
1578
+ start-servers-in-startup %boolean; "true"
1579
+ >
1580
+
1581
+ <!--
1582
+ SE/EE Only: Load Balancer configuration
1583
+ -->
1584
+
1585
+ <!ELEMENT loadbalancer (property*)>
1586
+ <!ATTLIST loadbalancer name CDATA #REQUIRED
1587
+ lb-configuration-ref CDATA #REQUIRED>
1588
+
1589
+ <!--
1590
+ XML DTD for S1AS 8.0EE load balancer configuration.
1591
+
1592
+ Copyright (c) 2002 by Sun Microsystems, Inc. All Rights Reserved.
1593
+ $Revision: 1.2 $
1594
+ -->
1595
+
1596
+ <!-- Load Balancer Algorithm Types
1597
+
1598
+ This is a list of various load balancing algorithm types that are supported
1599
+ by the load balancers. Note that each of these algorithms have an implicit
1600
+ "sticky" prefix. That is, the round-robin actually implies sticky
1601
+ round-robin.
1602
+ -->
1603
+ <!ENTITY % lb-algorithm-type "(round-robin | random | weighted-round-robin | weighted-random)" >
1604
+
1605
+ <!-- Load Balancer Configuration
1606
+
1607
+ Specify a load balancer configuration for one or more load balancers. The
1608
+ load balancers use this configuration to load balance the request. The
1609
+ DTD contains configuration details that pertain to the load balancer. The
1610
+ lb-configuration is an aggregation of lb-groups. Additionally, there are
1611
+ properties that can be specified at the lb-configuration level that allows
1612
+ the administrator to control the operation of the load balancer.
1613
+
1614
+ name identifies the lb-configuration.
1615
+
1616
+ lb-algorithm-type identifies the type of load balancing algorithm that Load Balancer should use. The default value would be
1617
+ "round-robin".
1618
+ -->
1619
+
1620
+ <!ELEMENT lb-configuration (lb-groups?, property*)>
1621
+ <!ATTLIST lb-configuration name CDATA #REQUIRED
1622
+ lb-algorithm-type %lb-algorithm-type; "round-robin">
1623
+
1624
+ <!ELEMENT lb-groups (lb-group*)>
1625
+
1626
+ <!-- Load Balancer Group
1627
+
1628
+ This the counterpart of a "group" from domain.xml in the load balancer
1629
+ realm. The lb-group is an aggregation of lb-servers, lb-j2ee-applications
1630
+ and stand-alone lb-web-modules. In the HTTP load balancer world,
1631
+ lb-j2ee-applications contain one or more web-modules.
1632
+
1633
+ The default implicit health checker configuration can also be specified at
1634
+ the lb-group level. This health checker configuration is used as the
1635
+ default if the health checker configuration is not specified at the
1636
+ lb-j2ee-application or lb-web-module level. However, if the health checker
1637
+ configuration is specified at the lb-j2ee-application or lb-web-module
1638
+ level, it overrides the health checker configuration specified at the
1639
+ lb-group level.
1640
+
1641
+ NOTE: The default health checker only "instance" health, i.e, all
1642
+ applications on the instance would be available or unavailable depending
1643
+ upon whether the instance is healthy or not. This is contrast to
1644
+ application level health checker that is described below:
1645
+
1646
+ name identifies the lb-group
1647
+
1648
+ ping-healthy-servers
1649
+ a boolean attribute that is used only if the
1650
+ health-checker is configured. It determines if the health
1651
+ check sweep will check only unhealthy servers or both
1652
+ healthy and unhealthy servers. By default, this attribute
1653
+ would be false, which would imply that only unhealthy
1654
+ servers are pinged during the health check sweep. This
1655
+ attribute can be set to true if the customers need a
1656
+ pro-active health check mechanism to detect unhealthy
1657
+ instances.
1658
+ -->
1659
+
1660
+ <!ELEMENT lb-group (lb-servers?, lb-j2ee-applications?, lb-web-modules?, computed-response-timeout?, health-checker?)>
1661
+ <!ATTLIST lb-group name CDATA #REQUIRED
1662
+ ping-healthy-servers %boolean; "false">
1663
+
1664
+ <!ELEMENT lb-servers (lb-server*)>
1665
+
1666
+ <!-- Load Balancer Server Instance
1667
+
1668
+ This element is the counterpart of an "server" from domain.xml for the
1669
+ load balancer. The attributes that apply to an server specific to the
1670
+ load balancer are specified in this section. The lb-server is an
1671
+ aggregation of HTTP Listeners.
1672
+
1673
+ name identifies the server server within the lb-group
1674
+
1675
+ enabled specifies whether server is active (enabled)
1676
+ for requests to be load balanced to it.
1677
+
1678
+ disable-timeout-in-minutes
1679
+ specifies the quiescing timeout interval in seconds, upon
1680
+ elapse of which load balancer would close all the open
1681
+ connections related to the server being disabled and no
1682
+ further requests would be routed to the server. Default
1683
+ value would be 31 minutes (i.e. more than the default
1684
+ session idle timeout which is 30 minutes).
1685
+
1686
+ weight
1687
+ This attribute is used if the weighted-round-robin policy
1688
+ is specified as the lb-algorithm for the lb-configuration.
1689
+ It is used to supply a weighted value for each server in
1690
+ the lb-group a numerical weight between 1 and 100. This
1691
+ value determines what proportion of the load the server
1692
+ will take relative to other servers. The default value is
1693
+ 100. Note that this attribute is ignored if the
1694
+ round-robin or random algorithm is selected.
1695
+
1696
+ -->
1697
+
1698
+ <!ELEMENT lb-server (lb-http-listener*)>
1699
+ <!ATTLIST lb-server name CDATA #REQUIRED
1700
+ enabled %boolean; "true"
1701
+ disable-timeout-in-minutes CDATA "31"
1702
+ weight CDATA "100">
1703
+
1704
+ <!-- HTTP listeners for a lb-server
1705
+
1706
+ This element is used to specify HTTP/HTTPS listeners for an lb-server.
1707
+ An server could have one or more listeners configured. When the load
1708
+ balancer forwards requests to an server, it selects a listener from the
1709
+ list of configured listeners for the server.
1710
+
1711
+ id Unique identifier for http listener.
1712
+
1713
+ address IP address for the listener.
1714
+
1715
+ port Port number for the listener.
1716
+
1717
+ security-enabled
1718
+ An optional boolean attribute that determines whether the
1719
+ http listener runs SSL. The default is false.
1720
+ -->
1721
+
1722
+ <!ELEMENT lb-http-listener EMPTY>
1723
+ <!ATTLIST lb-http-listener id CDATA #REQUIRED
1724
+ address CDATA #REQUIRED
1725
+ port CDATA #REQUIRED
1726
+ security-enabled %boolean; "false">
1727
+
1728
+ <!ELEMENT lb-j2ee-applications (lb-j2ee-application*)>
1729
+
1730
+ <!-- Deployed LB J2EE Applications.
1731
+
1732
+ This element is the counterpart of an "j2ee-application" from domain.xml
1733
+ for the load balancer. The attributes that apply to an j2ee-application
1734
+ specific to the load balancer are specified in this section. The
1735
+ lb-j2ee-application is an aggregation of context-roots and an
1736
+ j2ee-application level implicit health checker.
1737
+
1738
+ NOTE: The j2ee-application level health checker allows health checks to
1739
+ be performed on a per application basis. So instead of marking an entire
1740
+ instance unhealthy, as is the case in the default lb-group level health
1741
+ checker, a j2ee-application level health checker can mark an instance
1742
+ healthy or unhealthy in the context of a particular application. This
1743
+ allows an instance to be marked unhealthy for some applications while
1744
+ being marked as healthy for other applications.
1745
+
1746
+ name identifies the lb-j2ee-application
1747
+
1748
+ enabled signifies whether the lb-j2ee-application is enabled or
1749
+ disabled. Default value would be "true".
1750
+
1751
+ disable-timeout-in-minutes
1752
+ specifies the quiescing timeout interval after which no
1753
+ further requests would be sent to the lb-j2ee-application
1754
+ that has been disabled. Application is identified by the
1755
+ lb-j2ee-application context root as specified in
1756
+ applicaiton-web-module element. Default value would be 31
1757
+ minutes (i.e. more than the default session idle timeout
1758
+ which is 30 minutes).
1759
+ -->
1760
+
1761
+ <!ELEMENT lb-j2ee-application (j2ee-application-web-module*, health-checker?)>
1762
+ <!ATTLIST lb-j2ee-application name CDATA #REQUIRED
1763
+ enabled %boolean; "true"
1764
+ disable-timeout-in-minutes CDATA "31">
1765
+
1766
+ <!-- Web Modules in the deployed j2ee-application.
1767
+
1768
+ This element is used to specify web-modules that are part of a
1769
+ lb-j2ee-application. An j2ee-application could have one or more
1770
+ web-modules. The j2ee-application-web-module element is an aggregation of
1771
+ idempotent-url-patterns and a health-checker.
1772
+
1773
+ NOTE: The j2ee-application-web-module level health checker overrides the
1774
+ health checker specified at the lb-j2ee-application level.
1775
+
1776
+ name identifies the j2ee-application-web-module
1777
+
1778
+ lb-context-root context root of the j2ee-application deployed
1779
+
1780
+ -->
1781
+
1782
+ <!ELEMENT j2ee-application-web-module (idempotent-url-pattern*, web-module-response-timeout?, urls-and-response-timeouts?, health-checker?, error-url?)>
1783
+ <!ATTLIST j2ee-application-web-module name CDATA #REQUIRED
1784
+ lb-context-root CDATA #REQUIRED>
1785
+
1786
+ <!-- Idempotent URLs for the deployed Web Module.
1787
+
1788
+ This element is used to specify all idempotent-url-patterns for a
1789
+ web-module that is part of an lb-j2ee-application as well as for a
1790
+ stand-alone lb-web-module. What this implies is that when a load balancer
1791
+ detects that an instance is unhealthy while servicing a request, it would
1792
+ implicitly retry the request on another server in the lb-group, if its URL
1793
+ matches one of the idempotent-url-patterns for that j2ee-application.
1794
+
1795
+ url-pattern URL patterns that are idempotent that can be retried by
1796
+ the load balancer, if a request containing the pattern
1797
+ fails due to an instance being unhealthy.
1798
+
1799
+ no-of-retries Number of times the URL should be retried. The default
1800
+ value is equal to the number of servers that support the
1801
+ the context-root for the url-pattern, minus 1.
1802
+
1803
+ -->
1804
+
1805
+ <!ELEMENT idempotent-url-pattern EMPTY>
1806
+ <!ATTLIST idempotent-url-pattern url-pattern CDATA #REQUIRED
1807
+ no-of-retries CDATA "-1">
1808
+
1809
+ <!-- Web Module Response Timeouts
1810
+
1811
+ This element is used to specify all timeouts at a Web Module level.
1812
+ This includes standalone web-modules and web-modules that are part of
1813
+ an lb-j2ee-application. This setting overrides the LB wide response
1814
+ timeout for the web-module.
1815
+
1816
+ timeout-in-seconds
1817
+ timeout interval in seconds within which response should
1818
+ be obtained for a request load balanced; else the server
1819
+ would be considered unhealthy. Default value would be "60".
1820
+ This is applicable for all requests in the web-module
1821
+ (that have the same context-root as that of the web-module)
1822
+ and overrides the global response timeout settings.
1823
+
1824
+ -->
1825
+
1826
+ <!ELEMENT web-module-response-timeout EMPTY>
1827
+ <!ATTLIST web-module-response-timeout timeout-in-seconds CDATA "60">
1828
+
1829
+ <!-- URLs and Response Timeouts
1830
+
1831
+ This element is used to specify specific response timeouts for URLs within
1832
+ a Web Module level. This overrides the LB wide response timeout as well as
1833
+ the web module specific response timeout. This element is specified as a
1834
+ space delimited list of name=value pairs comprising the URLs and the
1835
+ corresponding response timeout values in seconds.
1836
+
1837
+ urls-n-timeouts
1838
+ A space delimited list of URLs and the corresponding
1839
+ response timeout. For example:
1840
+ "/myApp/abc=15 /myApp/xyz=90"
1841
+
1842
+ -->
1843
+
1844
+ <!ELEMENT urls-and-response-timeouts EMPTY>
1845
+ <!ATTLIST urls-and-response-timeouts urls-n-timeouts CDATA #REQUIRED>
1846
+
1847
+ <!-- Computed Response Timeout
1848
+
1849
+ This element is used to enable computed response times for all URLs.
1850
+ This overrides all configurable response timeout settings including the
1851
+ global response timeout, web module response timeout and URL wise
1852
+ response timeouts. This computes the average response time per URL and
1853
+ multiplies it with a latency-multiplier and adds a latency-offset to
1854
+ compute the response timeout.
1855
+
1856
+ latency-multiplier
1857
+ A number to be multiplied to the average response time to
1858
+ get the response timeout. The default value is 1.
1859
+
1860
+ latency-offset
1861
+ Represents ad-hoc delays that impact the response time, for
1862
+ example, GC pause time.
1863
+
1864
+
1865
+ -->
1866
+
1867
+ <!ELEMENT computed-response-timeout EMPTY>
1868
+ <!ATTLIST computed-response-timeout latency-multiplier CDATA "1"
1869
+ latency-offset CDATA "0">
1870
+
1871
+ <!-- Deployed stand-alone Web Modules.
1872
+
1873
+ This element is the counterpart of a stand-alone "web-module" from
1874
+ domain.xml for the load balancer. These are web-modules thar are not part
1875
+ of any j2ee-application. The lb-web-modules is an aggregation of
1876
+ idempotent-url-patterns and an implicit health checker.
1877
+
1878
+ NOTE: The web-module level health checker allows health checks to
1879
+ be performed on a per web-module basis. So instead of marking an entire
1880
+ instance unhealthy, as is the case in the default lb-group level health
1881
+ checker, a web-module level health checker can mark an instance
1882
+ healthy or unhealthy in the context of a particular web-module. This
1883
+ allows an instance to be marked unhealthy for some web-modules while
1884
+ being marked as healthy for other web-modules.
1885
+
1886
+ name identifies the lb-web-module
1887
+
1888
+ lb-context-root context root of the stand-alone lb-web-module
1889
+
1890
+ enabled signifies whether the lb-web-module is enabled or
1891
+ disabled. Default value would be "true".
1892
+
1893
+ disable-timeout-in-minutes
1894
+ specifies the quiescing timeout interval after which no
1895
+ further requests would be sent to the lb-web-module that
1896
+ has been disabled. The lb-web-module is identified by the
1897
+ context root. Default value would be 31 minutes (i.e.
1898
+ more than the default session idle timeout which is 30
1899
+ minutes).
1900
+ -->
1901
+
1902
+ <!ELEMENT lb-web-modules (lb-web-module*)>
1903
+
1904
+ <!ELEMENT lb-web-module (idempotent-url-pattern*, web-module-response-timeout?, urls-and-response-timeouts?, health-checker?, error-url?)>
1905
+ <!ATTLIST lb-web-module name CDATA #REQUIRED
1906
+ lb-context-root CDATA #REQUIRED
1907
+ enabled %boolean; "true"
1908
+ disable-timeout-in-minutes CDATA "31">
1909
+
1910
+ <!-- Health Checker Configuration.
1911
+
1912
+ This element describes the Health Checker configuration. A health checker
1913
+ could be configured at the lb-group level, at a per j2ee-application level
1914
+ or a per stand-alone web-module level. If no health checker is specified
1915
+ at the lb-j2ee-application level or a lb-web-module level, then the
1916
+ health checker specified at the lb-group level is picked up. However, if
1917
+ the health checker is specified at the lb-j2ee-application level or the
1918
+ lb-web-module level, then it overrides the setting at the lb-group level.
1919
+
1920
+ url URL to ping so as to determine the health state
1921
+ of a listener.
1922
+
1923
+ interval-in-seconds
1924
+ specifies the interval in seconds at which health checks
1925
+ of unhealthy servers carried out to check if the servers
1926
+ has turned healthy. Default value is "30" seconds. A value
1927
+ of "0" would imply that health check is disabled.
1928
+
1929
+ timeout-in-seconds
1930
+ timeout interval in seconds within which response should
1931
+ be obtained for a health check request; else the server
1932
+ would be considered unhealthy. Default value would be
1933
+ "10" seconds.
1934
+ -->
1935
+
1936
+ <!ELEMENT health-checker EMPTY>
1937
+ <!ATTLIST health-checker url CDATA "/"
1938
+ interval-in-seconds CDATA "30"
1939
+ timeout-in-seconds CDATA "10">
1940
+
1941
+ <!-- Error URL Configuration.
1942
+
1943
+
1944
+ The error-url element is specified optionally for the lb-web-module or
1945
+ j2ee-application-web-module element. This element allows the URL that
1946
+ represents an user-defined error page to be specified. This URL is invoked
1947
+ by the LB in the event of an error during the load balancing phase. If
1948
+ this element is specified, it overrides all other mechanisms of error
1949
+ reporting.
1950
+
1951
+ While the LB does not interfere with application errors, it has a role to
1952
+ play when it encounters an error in the process of forwarding a request.
1953
+ The errors fall into two broad categories:
1954
+
1955
+ 1. No socket connection can be opened by the LB to the selected
1956
+ Server (or alternate servers defined in the lb-configuration) and
1957
+ hence the LB cannot forward the request at all.
1958
+
1959
+ 2. The LB forwarded the request to the server but did not get a
1960
+ response back before the configured response timeout.
1961
+
1962
+ url URL to be invoked in event of an LB error.
1963
+
1964
+ -->
1965
+
1966
+ <!ELEMENT error-url EMPTY>
1967
+ <!ATTLIST error-url url CDATA #REQUIRED>
1968
+
1969
+ <!-- Properties that control the global configuration of the load balancer.
1970
+
1971
+ Name Value
1972
+
1973
+ response-timeout-in-seconds timeout interval in seconds within which
1974
+ response should be obtained for a request
1975
+ load balanced; else the server would be
1976
+ considered unhealthy. Default value would
1977
+ be "60".
1978
+
1979
+ https-routing flag ("true" | "false") that determines
1980
+ whether the load balancer should route the
1981
+ incoming HTTPS request as HTTPS request to
1982
+ the server. Default value would be
1983
+ "false".
1984
+
1985
+ require-monitor-data flag ("true" | "false") that determines
1986
+ whether monitoring is switched on or not.
1987
+ Default value would be "false".
1988
+
1989
+ pull-interval-in-minutes
1990
+ interval in minutes after which Agent will
1991
+ initiate a pull of the load balancer
1992
+ configuration from the DAS. Default value
1993
+ is "10" minutes. If the pull interval is
1994
+ set to "0",
1995
+
1996
+ supported-url-pattern specifies the URL pattern that needs to
1997
+ be processed by the LB. The Web Server
1998
+ will forward all URLs that match the URL
1999
+ pattern to the LB Plugin. This property
2000
+ needs to be only set for LB plugins that
2001
+ are deployed on the IIS Web Server. The
2002
+ default is "/*", which implies that all
2003
+ URL patterns will be sent to the LB
2004
+ Plugin.
2005
+
2006
+ -->
2007
+