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,230 @@
1
+
2
+ <!ENTITY % boolean "(yes | no | on | off | 1 | 0 | true | false)">
3
+
4
+ <!-- root element for vendor specific web application (module) configuration -->
5
+ <!ELEMENT sun-web-app (security-role-mapping*, servlet*, session-config?,
6
+ resource-env-ref*, resource-ref*,
7
+ ejb-ref*, cache?, class-loader?,
8
+ jsp-config?, locale-charset-info?, property*)>
9
+
10
+ <!ELEMENT security-role-mapping (role-name, (principal-name | group-name)+)>
11
+ <!ELEMENT role-name (#PCDATA)>
12
+
13
+ <!ELEMENT principal-name (#PCDATA)>
14
+ <!ELEMENT group-name (#PCDATA)>
15
+
16
+ <!ELEMENT servlet (servlet-name, principal-name)>
17
+
18
+ <!ELEMENT session-config (session-manager?, session-properties?, cookie-properties?)>
19
+
20
+ <!ENTITY % persistence-type "(memory | file | custom)">
21
+
22
+ <!ELEMENT session-manager (manager-properties?, store-properties?)>
23
+ <!ATTLIST session-manager persistence-type %persistence-type; "memory">
24
+
25
+ <!ELEMENT manager-properties (property*)>
26
+ <!ELEMENT store-properties (property*)>
27
+ <!ELEMENT session-properties (property*)>
28
+ <!ELEMENT cookie-properties (property*)>
29
+
30
+ <!ELEMENT jndi-name (#PCDATA)>
31
+
32
+ <!ELEMENT resource-env-ref (resource-env-ref-name, jndi-name)>
33
+ <!ELEMENT resource-env-ref-name (#PCDATA)>
34
+
35
+ <!ELEMENT resource-ref (res-ref-name, jndi-name, default-resource-principal?)>
36
+ <!ELEMENT res-ref-name (#PCDATA)>
37
+
38
+ <!ELEMENT default-resource-principal ( name, password)>
39
+
40
+ <!--
41
+ This text nodes holds a name string.
42
+ -->
43
+ <!ELEMENT name (#PCDATA)>
44
+
45
+ <!--
46
+ This element holds password text.
47
+ -->
48
+ <!ELEMENT password (#PCDATA)>
49
+
50
+
51
+ <!ELEMENT ejb-ref (ejb-ref-name, jndi-name)>
52
+ <!ELEMENT ejb-ref-name (#PCDATA)>
53
+
54
+ <!ENTITY % scope "(context.attribute | request.header | request.parameter |
55
+ request.cookie | request.attribute | session.attribute)">
56
+ <!ENTITY % key-scope "(context.attribute | request.header | request.parameter |
57
+ request.cookie | session.id | session.attribute)">
58
+ <!ENTITY % expr "(equals | greater | lesser | not-equals | in-range)">
59
+
60
+ <!-- cache element configures the cache for web application. iAS 7.0 web container
61
+ supports one such cache object per application: i.e. <cache> is a sub element
62
+ of <ias-web-app>. A cache can have zero or more cache-mapping elements and
63
+ zero or more customizable cache-helper classes.
64
+
65
+ max-entries Maximum number of entries this cache may hold. [4096]
66
+ timeout-in-seconds Default timeout for the cache entries in seconds. [30]
67
+ enabled Is this cache enabled? [false]
68
+ -->
69
+ <!ELEMENT cache (cache-helper*, default-helper?, property*, cache-mapping*)>
70
+ <!ATTLIST cache max-entries CDATA "4096"
71
+ timeout-in-seconds CDATA "30"
72
+ enabled %boolean; "false">
73
+
74
+ <!-- cache-helper specifies customizable class which implements CacheHelper interface.
75
+
76
+ name Unique name for the helper class; this is referenced in
77
+ the cache-mapping elements (see below).
78
+ "default" is reserved for the built-in default helper.
79
+ class-name Fully qualified class name of the cache-helper; this class
80
+ must extend the com.sun.appserv.web.CacheHelper class.
81
+ -->
82
+ <!ELEMENT cache-helper (property*)>
83
+ <!ATTLIST cache-helper name CDATA #REQUIRED
84
+ class-name CDATA #REQUIRED>
85
+
86
+ <!--
87
+ Default, built-in cache-helper properties
88
+ -->
89
+ <!ELEMENT default-helper (property*)>
90
+
91
+ <!--
92
+ cache-mapping element defines what to be cached, the key to be used, any other
93
+ constraints to be applied and a customizable cache-helper to programmatically
94
+ hook this information.
95
+ -->
96
+ <!ELEMENT cache-mapping ((servlet-name | url-pattern),
97
+ (cache-helper-ref |
98
+ (timeout?, refresh-field?, http-method*, key-field*, constraint-field*)))>
99
+
100
+ <!--
101
+ servlet-name element defines a named servlet to which this caching is enabled.
102
+ the specified name must be present in the web application deployment descriptor
103
+ (web.xml)
104
+ -->
105
+ <!ELEMENT servlet-name (#PCDATA)>
106
+
107
+ <!--
108
+ url-pattern element specifies the url pattern to which caching is to be enabled.
109
+ See Servlet 2.3 specification section SRV. 11.2 for the applicable patterns.
110
+ -->
111
+ <!ELEMENT url-pattern (#PCDATA)>
112
+
113
+ <!--
114
+ cache-helper-ref s a reference to the cache-helper used by this cache-mapping
115
+ -->
116
+ <!ELEMENT cache-helper-ref (#PCDATA)>
117
+
118
+ <!--
119
+ timeout element defines the cache timeout in seconds applicable for this mapping.
120
+ default is to use cache object's timeout. The timeout value is specified statically
121
+ ere (e.g. <timeout> 60 </timeout> or dynamically via fields in the relevant scope.
122
+
123
+ name Name of the field where this timeout could be found
124
+ scope Scope of the field. default scope is request attribute.
125
+ -->
126
+ <!ELEMENT timeout (#PCDATA)>
127
+ <!ATTLIST timeout name CDATA #REQUIRED
128
+ scope %scope; 'request.attribute'>
129
+
130
+ <!--
131
+ http-method specifies HTTP method eligible for caching default is GET.
132
+ -->
133
+ <!ELEMENT http-method (#PCDATA)>
134
+
135
+ <!--
136
+ specifies the request parameter name that triggers refresh. the cached entry
137
+ is refreshed when there such a request parameter is set to "true"
138
+ example:
139
+ <cache-mapping>
140
+ <url-pattern> /quote </url-pattern>
141
+ <refresh-field name="refresh" scope="request.parameter"/>
142
+ </cache-mapping>
143
+ -->
144
+ <!ELEMENT refresh-field EMPTY>
145
+ <!ATTLIST refresh-field name CDATA #REQUIRED
146
+ scope %key-scope; 'request.parameter'>
147
+ <!--
148
+ key-field specifies a component of the key; container looks for the named
149
+ field in the given scope to access the cached entry. Default is to use
150
+ the Servlet Path (the path section that corresponds to the servlet mapping
151
+ which activated this request). See Servlet 2.3 specification section SRV 4.4
152
+ on Servlet Path.
153
+
154
+ name Name of the field to look for in the given scope
155
+ scope Scope of the field. default scope is request parameter.
156
+ -->
157
+ <!ELEMENT key-field EMPTY>
158
+ <!ATTLIST key-field name CDATA #REQUIRED
159
+ scope %key-scope; 'request.parameter'>
160
+
161
+ <!--
162
+ constraint-field specifies a field whose value is used as a cacheability constraint.
163
+
164
+ name Name of the field to look for in the given scope
165
+ scope Scope of the field. Default scope is request parameter.
166
+ cache-on-match Should this constraint check pass, is the response cacheable?
167
+ Default is true (i.e. cache the response on success match).
168
+ Useful to turn off caching when there is an attribute in the
169
+ scope (e.g. don't cache when there is an attribute called UID
170
+ in the session.attribute scope).
171
+ cache-on-match-failure Should the constraint check fail, is response not cacheable?
172
+ Default is false (i.e. a failure in enforcing the constraint
173
+ would negate caching). Useful to turn on caching when the
174
+ an an attribute is not present (e.g. turn on caching
175
+ when there is no session or session attribute called UID).
176
+
177
+ Example 1: don't cache when there is a session attribute
178
+ <constraint-field name="UID" scope="session.attribute" cache-on-match="false">
179
+
180
+ Example 2: do cache only when there is no session attribute
181
+ <constraint-field name="UID" scope="session.attribute"
182
+ cache-on-match-failure="false">
183
+ -->
184
+ <!ELEMENT constraint-field (value*)>
185
+ <!ATTLIST constraint-field name CDATA #REQUIRED
186
+ scope %scope; 'request.parameter'
187
+ cache-on-match %boolean; 'true'
188
+ cache-on-match-failure %boolean; 'false'>
189
+
190
+ <!--
191
+ value element specifies the applicable value and a matching expression for a constraint-field
192
+ match-expr Expression used to match the value. Default is 'equals'.
193
+
194
+ Example 1: cache when the category matches with any value other than a specific value
195
+ <constraint-field name="category" scope="request.parameter>
196
+ <value match-expr="equals" cache-on-match-failure="true">
197
+ bogus
198
+ </value>
199
+ </constraint-field>
200
+ -->
201
+ <!ELEMENT value (#PCDATA)>
202
+ <!ATTLIST value match-expr %expr; 'equals'
203
+ cache-on-match %boolean; 'true'
204
+ cache-on-match-failure %boolean; 'false'>
205
+
206
+ <!ELEMENT class-loader EMPTY>
207
+ <!ATTLIST class-loader extra-class-path CDATA #IMPLIED
208
+ delegate %boolean; 'false'>
209
+
210
+ <!ELEMENT jsp-config (property*)>
211
+
212
+ <!ELEMENT locale-charset-info (locale-charset-map+, parameter-encoding?)>
213
+ <!ATTLIST locale-charset-info default-locale CDATA #REQUIRED>
214
+
215
+ <!ELEMENT locale-charset-map (description?)>
216
+ <!ATTLIST locale-charset-map locale CDATA #REQUIRED
217
+ agent CDATA #IMPLIED
218
+ charset CDATA #REQUIRED>
219
+
220
+ <!ELEMENT parameter-encoding EMPTY>
221
+ <!ATTLIST parameter-encoding form-hint-field CDATA #REQUIRED>
222
+
223
+ <!--
224
+ Syntax for supplying properties as name value pairs
225
+ -->
226
+ <!ELEMENT property (description?)>
227
+ <!ATTLIST property name CDATA #REQUIRED
228
+ value CDATA #REQUIRED>
229
+
230
+ <!ELEMENT description (#PCDATA)>
@@ -0,0 +1,230 @@
1
+
2
+ <!ENTITY % boolean "(yes | no | on | off | 1 | 0 | true | false)">
3
+
4
+ <!-- root element for vendor specific web application (module) configuration -->
5
+ <!ELEMENT sun-web-app (security-role-mapping*, servlet*, session-config?,
6
+ resource-env-ref*, resource-ref*,
7
+ ejb-ref*, cache?, class-loader?,
8
+ jsp-config?, locale-charset-info?, property*)>
9
+
10
+ <!ELEMENT security-role-mapping (role-name, (principal-name | group-name)+)>
11
+ <!ELEMENT role-name (#PCDATA)>
12
+
13
+ <!ELEMENT principal-name (#PCDATA)>
14
+ <!ELEMENT group-name (#PCDATA)>
15
+
16
+ <!ELEMENT servlet (servlet-name, principal-name)>
17
+
18
+ <!ELEMENT session-config (session-manager?, session-properties?, cookie-properties?)>
19
+
20
+ <!ENTITY % persistence-type "(memory | file | ha | custom)">
21
+
22
+ <!ELEMENT session-manager (manager-properties?, store-properties?)>
23
+ <!ATTLIST session-manager persistence-type %persistence-type; "memory">
24
+
25
+ <!ELEMENT manager-properties (property*)>
26
+ <!ELEMENT store-properties (property*)>
27
+ <!ELEMENT session-properties (property*)>
28
+ <!ELEMENT cookie-properties (property*)>
29
+
30
+ <!ELEMENT jndi-name (#PCDATA)>
31
+
32
+ <!ELEMENT resource-env-ref (resource-env-ref-name, jndi-name)>
33
+ <!ELEMENT resource-env-ref-name (#PCDATA)>
34
+
35
+ <!ELEMENT resource-ref (res-ref-name, jndi-name, default-resource-principal?)>
36
+ <!ELEMENT res-ref-name (#PCDATA)>
37
+
38
+ <!ELEMENT default-resource-principal ( name, password)>
39
+
40
+ <!--
41
+ This text nodes holds a name string.
42
+ -->
43
+ <!ELEMENT name (#PCDATA)>
44
+
45
+ <!--
46
+ This element holds password text.
47
+ -->
48
+ <!ELEMENT password (#PCDATA)>
49
+
50
+
51
+ <!ELEMENT ejb-ref (ejb-ref-name, jndi-name)>
52
+ <!ELEMENT ejb-ref-name (#PCDATA)>
53
+
54
+ <!ENTITY % scope "(context.attribute | request.header | request.parameter |
55
+ request.cookie | request.attribute | session.attribute)">
56
+ <!ENTITY % key-scope "(context.attribute | request.header | request.parameter |
57
+ request.cookie | session.id | session.attribute)">
58
+ <!ENTITY % expr "(equals | greater | lesser | not-equals | in-range)">
59
+
60
+ <!-- cache element configures the cache for web application. iAS 7.0 web container
61
+ supports one such cache object per application: i.e. <cache> is a sub element
62
+ of <ias-web-app>. A cache can have zero or more cache-mapping elements and
63
+ zero or more customizable cache-helper classes.
64
+
65
+ max-entries Maximum number of entries this cache may hold. [4096]
66
+ timeout-in-seconds Default timeout for the cache entries in seconds. [30]
67
+ enabled Is this cache enabled? [false]
68
+ -->
69
+ <!ELEMENT cache (cache-helper*, default-helper?, property*, cache-mapping*)>
70
+ <!ATTLIST cache max-entries CDATA "4096"
71
+ timeout-in-seconds CDATA "30"
72
+ enabled %boolean; "false">
73
+
74
+ <!-- cache-helper specifies customizable class which implements CacheHelper interface.
75
+
76
+ name Unique name for the helper class; this is referenced in
77
+ the cache-mapping elements (see below).
78
+ "default" is reserved for the built-in default helper.
79
+ class-name Fully qualified class name of the cache-helper; this class
80
+ must extend the com.sun.appserv.web.CacheHelper class.
81
+ -->
82
+ <!ELEMENT cache-helper (property*)>
83
+ <!ATTLIST cache-helper name CDATA #REQUIRED
84
+ class-name CDATA #REQUIRED>
85
+
86
+ <!--
87
+ Default, built-in cache-helper properties
88
+ -->
89
+ <!ELEMENT default-helper (property*)>
90
+
91
+ <!--
92
+ cache-mapping element defines what to be cached, the key to be used, any other
93
+ constraints to be applied and a customizable cache-helper to programmatically
94
+ hook this information.
95
+ -->
96
+ <!ELEMENT cache-mapping ((servlet-name | url-pattern),
97
+ (cache-helper-ref |
98
+ (timeout?, refresh-field?, http-method*, key-field*, constraint-field*)))>
99
+
100
+ <!--
101
+ servlet-name element defines a named servlet to which this caching is enabled.
102
+ the specified name must be present in the web application deployment descriptor
103
+ (web.xml)
104
+ -->
105
+ <!ELEMENT servlet-name (#PCDATA)>
106
+
107
+ <!--
108
+ url-pattern element specifies the url pattern to which caching is to be enabled.
109
+ See Servlet 2.3 specification section SRV. 11.2 for the applicable patterns.
110
+ -->
111
+ <!ELEMENT url-pattern (#PCDATA)>
112
+
113
+ <!--
114
+ cache-helper-ref s a reference to the cache-helper used by this cache-mapping
115
+ -->
116
+ <!ELEMENT cache-helper-ref (#PCDATA)>
117
+
118
+ <!--
119
+ timeout element defines the cache timeout in seconds applicable for this mapping.
120
+ default is to use cache object's timeout. The timeout value is specified statically
121
+ ere (e.g. <timeout> 60 </timeout> or dynamically via fields in the relevant scope.
122
+
123
+ name Name of the field where this timeout could be found
124
+ scope Scope of the field. default scope is request attribute.
125
+ -->
126
+ <!ELEMENT timeout (#PCDATA)>
127
+ <!ATTLIST timeout name CDATA #REQUIRED
128
+ scope %scope; 'request.attribute'>
129
+
130
+ <!--
131
+ http-method specifies HTTP method eligible for caching default is GET.
132
+ -->
133
+ <!ELEMENT http-method (#PCDATA)>
134
+
135
+ <!--
136
+ specifies the request parameter name that triggers refresh. the cached entry
137
+ is refreshed when there such a request parameter is set to "true"
138
+ example:
139
+ <cache-mapping>
140
+ <url-pattern> /quote </url-pattern>
141
+ <refresh-field name="refresh" scope="request.parameter"/>
142
+ </cache-mapping>
143
+ -->
144
+ <!ELEMENT refresh-field EMPTY>
145
+ <!ATTLIST refresh-field name CDATA #REQUIRED
146
+ scope %key-scope; 'request.parameter'>
147
+ <!--
148
+ key-field specifies a component of the key; container looks for the named
149
+ field in the given scope to access the cached entry. Default is to use
150
+ the Servlet Path (the path section that corresponds to the servlet mapping
151
+ which activated this request). See Servlet 2.3 specification section SRV 4.4
152
+ on Servlet Path.
153
+
154
+ name Name of the field to look for in the given scope
155
+ scope Scope of the field. default scope is request parameter.
156
+ -->
157
+ <!ELEMENT key-field EMPTY>
158
+ <!ATTLIST key-field name CDATA #REQUIRED
159
+ scope %key-scope; 'request.parameter'>
160
+
161
+ <!--
162
+ constraint-field specifies a field whose value is used as a cacheability constraint.
163
+
164
+ name Name of the field to look for in the given scope
165
+ scope Scope of the field. Default scope is request parameter.
166
+ cache-on-match Should this constraint check pass, is the response cacheable?
167
+ Default is true (i.e. cache the response on success match).
168
+ Useful to turn off caching when there is an attribute in the
169
+ scope (e.g. don't cache when there is an attribute called UID
170
+ in the session.attribute scope).
171
+ cache-on-match-failure Should the constraint check fail, is response not cacheable?
172
+ Default is false (i.e. a failure in enforcing the constraint
173
+ would negate caching). Useful to turn on caching when the
174
+ an an attribute is not present (e.g. turn on caching
175
+ when there is no session or session attribute called UID).
176
+
177
+ Example 1: don't cache when there is a session attribute
178
+ <constraint-field name="UID" scope="session.attribute" cache-on-match="false">
179
+
180
+ Example 2: do cache only when there is no session attribute
181
+ <constraint-field name="UID" scope="session.attribute"
182
+ cache-on-match-failure="false">
183
+ -->
184
+ <!ELEMENT constraint-field (value*)>
185
+ <!ATTLIST constraint-field name CDATA #REQUIRED
186
+ scope %scope; 'request.parameter'
187
+ cache-on-match %boolean; 'true'
188
+ cache-on-match-failure %boolean; 'false'>
189
+
190
+ <!--
191
+ value element specifies the applicable value and a matching expression for a constraint-field
192
+ match-expr Expression used to match the value. Default is 'equals'.
193
+
194
+ Example 1: cache when the category matches with any value other than a specific value
195
+ <constraint-field name="category" scope="request.parameter>
196
+ <value match-expr="equals" cache-on-match-failure="true">
197
+ bogus
198
+ </value>
199
+ </constraint-field>
200
+ -->
201
+ <!ELEMENT value (#PCDATA)>
202
+ <!ATTLIST value match-expr %expr; 'equals'
203
+ cache-on-match %boolean; 'true'
204
+ cache-on-match-failure %boolean; 'false'>
205
+
206
+ <!ELEMENT class-loader EMPTY>
207
+ <!ATTLIST class-loader extra-class-path CDATA #IMPLIED
208
+ delegate %boolean; 'false'>
209
+
210
+ <!ELEMENT jsp-config (property*)>
211
+
212
+ <!ELEMENT locale-charset-info (locale-charset-map+, parameter-encoding?)>
213
+ <!ATTLIST locale-charset-info default-locale CDATA #REQUIRED>
214
+
215
+ <!ELEMENT locale-charset-map (description?)>
216
+ <!ATTLIST locale-charset-map locale CDATA #REQUIRED
217
+ agent CDATA #IMPLIED
218
+ charset CDATA #REQUIRED>
219
+
220
+ <!ELEMENT parameter-encoding EMPTY>
221
+ <!ATTLIST parameter-encoding form-hint-field CDATA #REQUIRED>
222
+
223
+ <!--
224
+ Syntax for supplying properties as name value pairs
225
+ -->
226
+ <!ELEMENT property (description?)>
227
+ <!ATTLIST property name CDATA #REQUIRED
228
+ value CDATA #REQUIRED>
229
+
230
+ <!ELEMENT description (#PCDATA)>