1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
---|
2 | |
---|
3 | |
---|
4 | <!-- |
---|
5 | DTD for the Struts Application Configuration File, Version 1.0 |
---|
6 | |
---|
7 | To support validation of your configuration file, include the following |
---|
8 | DOCTYPE element at the beginning (after the "xml" declaration): |
---|
9 | |
---|
10 | <!DOCTYPE struts-config PUBLIC |
---|
11 | "-//Apache Software Foundation//DTD Struts Configuration 1.0//EN" |
---|
12 | "http://jakarta.apache.org/struts/dtds/struts-config_1_0.dtd"> |
---|
13 | |
---|
14 | $Id: struts-config_1_0.dtd,v 1.5 2001/06/02 18:20:47 craigmcc Exp $ |
---|
15 | --> |
---|
16 | |
---|
17 | |
---|
18 | <!-- ========== Defined Types ============================================= --> |
---|
19 | |
---|
20 | |
---|
21 | <!-- A "BeanName" is the identifier of a JavaBean, such as a form bean, |
---|
22 | and also serves as the name of the corresponding scripting variable |
---|
23 | and the name of the JSP attribute under which the bean is accessed. |
---|
24 | Therefore, it must conform to the rules for a Java identifier. |
---|
25 | --> |
---|
26 | <!ENTITY % BeanName "CDATA"> |
---|
27 | |
---|
28 | |
---|
29 | <!-- A "Boolean" is the string representation of a boolean (true or false) |
---|
30 | variable. |
---|
31 | --> |
---|
32 | <!ENTITY % Boolean "(true|false|yes|no)"> |
---|
33 | |
---|
34 | |
---|
35 | <!-- A "ClassName" is the fully qualified name of a Java class that is |
---|
36 | instantiated to provide the functionality of the enclosing element. |
---|
37 | --> |
---|
38 | <!ENTITY % ClassName "CDATA"> |
---|
39 | |
---|
40 | |
---|
41 | <!-- An "Integer" is a character string consisting solely of numeric digits, |
---|
42 | optionally preceeded by a minus sign, that can be converted to a |
---|
43 | 32-bit integer. |
---|
44 | --> |
---|
45 | <!ENTITY % Integer "CDATA"> |
---|
46 | |
---|
47 | |
---|
48 | <!-- A "Location" is a relative path, delimited by "/" characters, that |
---|
49 | defines the location of a resource relative to the location of the |
---|
50 | Struts configuration file itself. |
---|
51 | --> |
---|
52 | <!ENTITY % Location "#PCDATA"> |
---|
53 | |
---|
54 | |
---|
55 | <!-- A "PropName" is the name of a JavaBeans property, and must begin with |
---|
56 | a lower case letter and contain only characters that are legal in a |
---|
57 | Java identifier. |
---|
58 | --> |
---|
59 | <!ENTITY % PropName "CDATA"> |
---|
60 | |
---|
61 | |
---|
62 | <!-- A "RequestPath" is a context-relative URI path, beginning with a slash, |
---|
63 | that identifies a mapped resource (such as a JSP page or a servlet) |
---|
64 | within this web application. |
---|
65 | --> |
---|
66 | <!ENTITY % RequestPath "CDATA"> |
---|
67 | |
---|
68 | |
---|
69 | <!-- The name of a JSP bean scope within which such a form bean may be |
---|
70 | accessed. |
---|
71 | --> |
---|
72 | <!ENTITY % RequestScope "(request|session)"> |
---|
73 | |
---|
74 | |
---|
75 | <!-- ========== Top Level Elements ======================================== --> |
---|
76 | |
---|
77 | |
---|
78 | <!-- The "struts-config" element is the root of the configuration file |
---|
79 | hierarchy, and contains nested elements for all of the other |
---|
80 | configuration settings. |
---|
81 | --> |
---|
82 | <!ELEMENT struts-config (data-sources?, form-beans?, global-forwards?, action-mappings?)> |
---|
83 | <!ATTLIST struts-config id ID #IMPLIED> |
---|
84 | |
---|
85 | |
---|
86 | <!-- The "data-sources" element describes a set of JDBC 2.0 Standard Extension |
---|
87 | data source objects which will be configured according to the nested |
---|
88 | "data-source" elements found inside. |
---|
89 | --> |
---|
90 | |
---|
91 | <!ELEMENT data-sources (data-source*)> |
---|
92 | <!ATTLIST data-sources id ID #IMPLIED> |
---|
93 | |
---|
94 | |
---|
95 | <!-- The "data-source" element describes a JDBC 2.0 Standard Extension data |
---|
96 | source object (that implements javax.sql.DataSource) which will be |
---|
97 | configured according to the properties and nested elements found here, |
---|
98 | and made available as a servlet context attribute (i.e. application |
---|
99 | scope bean). The following attributes are required: |
---|
100 | |
---|
101 | key Servlet context attribute key under which this data |
---|
102 | source will be stored. Default is the value specified |
---|
103 | by string constant Action.DATA_SOURCE_KEY. |
---|
104 | |
---|
105 | type Fully qualified Java class name of the implementation |
---|
106 | class (must implement javax.sql.DataSource). Default |
---|
107 | value is 'org.apache.struts.util.GenericDataSource'. |
---|
108 | |
---|
109 | NOTE: The following attributes are defined by the default data source |
---|
110 | implementation, and only take effect for that class or subclasses of |
---|
111 | that class. |
---|
112 | |
---|
113 | WARNING: The use of these attributes is deprecated. You should use |
---|
114 | nested <set-property> elements to configure *all* properties of |
---|
115 | your data source implementation. |
---|
116 | |
---|
117 | autoCommit The default auto-commit state for newly created |
---|
118 | connections. |
---|
119 | |
---|
120 | description The description of this data source. |
---|
121 | |
---|
122 | driverClass The Java class name of the JDBC driver to be used. |
---|
123 | [REQUIRED] |
---|
124 | |
---|
125 | loginTimeout The maximum number of seconds to wait for a connection |
---|
126 | to be created or returned. Default is driver dependent. |
---|
127 | |
---|
128 | maxCount The maximum number of connections to be created. |
---|
129 | |
---|
130 | minCount The minimum number of connections to be created. |
---|
131 | |
---|
132 | password The database password to use when connecting. [REQUIRED] |
---|
133 | |
---|
134 | readOnly The default read-only state for newly created |
---|
135 | connections. |
---|
136 | |
---|
137 | url The JDBC URL to use when connecting. [REQUIRED] |
---|
138 | |
---|
139 | user The database username to use when connecting. [REQUIRED] |
---|
140 | |
---|
141 | --> |
---|
142 | <!ELEMENT data-source (set-property*)> |
---|
143 | <!ATTLIST data-source id ID #IMPLIED> |
---|
144 | <!ATTLIST data-source key %BeanName; #IMPLIED> |
---|
145 | <!ATTLIST data-source type %ClassName; #IMPLIED> |
---|
146 | <!-- All of the following attributes are deprecated. Use a nested --> |
---|
147 | <!-- set-property element to configure data source properties. --> |
---|
148 | <!ATTLIST data-source autoCommit %Boolean; #IMPLIED> |
---|
149 | <!ATTLIST data-source description CDATA #IMPLIED> |
---|
150 | <!ATTLIST data-source driverClass %ClassName; #IMPLIED> |
---|
151 | <!ATTLIST data-source loginTimeout %Integer; #IMPLIED> |
---|
152 | <!ATTLIST data-source maxCount %Integer; #IMPLIED> |
---|
153 | <!ATTLIST data-source minCount %Integer; #IMPLIED> |
---|
154 | <!ATTLIST data-source password CDATA #IMPLIED> |
---|
155 | <!ATTLIST data-source readOnly %Boolean; #IMPLIED> |
---|
156 | <!ATTLIST data-source url CDATA #IMPLIED> |
---|
157 | <!ATTLIST data-source user CDATA #IMPLIED> |
---|
158 | |
---|
159 | |
---|
160 | <!-- The "form-beans" element is the root of the set of form bean descriptors |
---|
161 | for this application. The following attributes are defined: |
---|
162 | |
---|
163 | type Fully qualified Java class name of the implementation |
---|
164 | class used for ActionFormBean objects. DEPRECATED. |
---|
165 | |
---|
166 | WARNING: For Struts 1.0, this value is ignored. You |
---|
167 | can set the default implementation class name with the |
---|
168 | "formBean" initialization parameter to the Struts |
---|
169 | controller servlet. |
---|
170 | --> |
---|
171 | <!ELEMENT form-beans (form-bean*)> |
---|
172 | <!ATTLIST form-beans id ID #IMPLIED> |
---|
173 | <!ATTLIST form-beans type %ClassName; "org.apache.struts.action.ActionFormBean"> |
---|
174 | |
---|
175 | |
---|
176 | <!-- The "form-bean" element describes a particular form bean, which is a |
---|
177 | JavaBean that implements the org.apache.struts.action.ActionForm |
---|
178 | class. The following attributes are defined: |
---|
179 | |
---|
180 | className Fully qualified Java class name of the ActionFormBean |
---|
181 | implementation class to use. Defaults to the value |
---|
182 | configured as the "formBean" initialization parameter |
---|
183 | to the Struts controller servlet. |
---|
184 | |
---|
185 | name Unique identifier of this bean, used to reference it |
---|
186 | in corresponding action mappings. |
---|
187 | |
---|
188 | type Fully qualified Java class name of the implementation |
---|
189 | class to be used or generated |
---|
190 | --> |
---|
191 | <!ELEMENT form-bean (icon?, display-name?, description?, set-property*)> |
---|
192 | <!ATTLIST form-bean id ID #IMPLIED> |
---|
193 | <!ATTLIST form-bean className %ClassName; #IMPLIED> |
---|
194 | <!ATTLIST form-bean name %BeanName; #REQUIRED> |
---|
195 | <!ATTLIST form-bean type %ClassName; #REQUIRED> |
---|
196 | |
---|
197 | |
---|
198 | <!-- The "global-forwards" element configures the global mappings of logical |
---|
199 | names (used within the application) to mappable resources (identified |
---|
200 | by context-relative URI paths). A global "forward" with a particular name |
---|
201 | can be locally overridden by defining a "forward" of the same name within |
---|
202 | an "action" element. The following attribute are defined: |
---|
203 | |
---|
204 | type Fully qualified Java class name of the implementation |
---|
205 | class used for ActionForward objects. DEPRECATED. |
---|
206 | |
---|
207 | WARNING: For Struts 1.0, this value is ignored. You |
---|
208 | can set the default implementation class name with the |
---|
209 | "forward" initialization parameter to the Struts |
---|
210 | controller servlet. |
---|
211 | --> |
---|
212 | <!ELEMENT global-forwards (forward*)> |
---|
213 | <!ATTLIST global-forwards id ID #IMPLIED> |
---|
214 | <!ATTLIST global-forwards type %ClassName; "org.apache.struts.action.ActionForward"> |
---|
215 | |
---|
216 | |
---|
217 | <!-- The "forward" element describes a mapping of a logical name (used within |
---|
218 | the application) to a mappable resource identified by a context-relative |
---|
219 | URI path. The following attributes are defined: |
---|
220 | |
---|
221 | className Fully qualified Java class name of the ActionForward |
---|
222 | implementation class to use. Defaults to the value |
---|
223 | configured as the "forward" initialization parameter |
---|
224 | to the Struts controller servlet. |
---|
225 | |
---|
226 | name Unique identifier of this forward, used to reference it |
---|
227 | in application action classes. |
---|
228 | |
---|
229 | path The context-relative path of the mapped resource. |
---|
230 | |
---|
231 | redirect Set to "true" if sendRedirect() should be used to forward |
---|
232 | to this resource, or "false" in order to use |
---|
233 | RequestDispatcher.forward() instead. |
---|
234 | --> |
---|
235 | <!ELEMENT forward (icon?, display-name?, description?, set-property*)> |
---|
236 | <!ATTLIST forward id ID #IMPLIED> |
---|
237 | <!ATTLIST forward className %ClassName; #IMPLIED> |
---|
238 | <!ATTLIST forward name CDATA #REQUIRED> |
---|
239 | <!ATTLIST forward path %RequestPath; #REQUIRED> |
---|
240 | <!ATTLIST forward redirect %Boolean; #IMPLIED> |
---|
241 | |
---|
242 | |
---|
243 | <!-- The "action-mappings" element configures the mappings from submitted |
---|
244 | request paths to the corresponding Action classes that should be |
---|
245 | used to process these requests. The following attributes are |
---|
246 | defined: |
---|
247 | |
---|
248 | type Fully qualified Java class name of the ActionMapping |
---|
249 | implementation class to be used. DEPRECATED. |
---|
250 | |
---|
251 | WARNING: For Struts 1.0, this value is ignored. You |
---|
252 | can set the default implementation class name with the |
---|
253 | "mapping" initialization parameter to the Struts |
---|
254 | controller servlet. |
---|
255 | --> |
---|
256 | <!ELEMENT action-mappings (action*)> |
---|
257 | <!ATTLIST action-mappings id ID #IMPLIED> |
---|
258 | <!ATTLIST action-mappings type %ClassName; "org.apache.struts.action.ActionMapping"> |
---|
259 | |
---|
260 | |
---|
261 | <!-- The "action" element describes a mapping from a request paths to the |
---|
262 | corresponding Action classes that should be used to process these |
---|
263 | requests. The following attributes are defined: |
---|
264 | |
---|
265 | attribute Name of the request-scope or session-scope attribute |
---|
266 | under which our form bean is accessed, if it is other |
---|
267 | than the bean's specified "name". Optional if |
---|
268 | "name" is specified, else not allowed. |
---|
269 | |
---|
270 | className Fully qualified Java class name of the ActionMapping |
---|
271 | implementation class to use. Defaults to the value |
---|
272 | configured as the "mapping" initialization parameter |
---|
273 | to the Struts controller servlet. |
---|
274 | |
---|
275 | forward Context-relative path of the servlet or JSP resource that |
---|
276 | will process this request, instead of instantiating and |
---|
277 | calling the Action class specified by "type". Exactly one |
---|
278 | of "forward", "include", or "type" must be specified. |
---|
279 | |
---|
280 | include Context-relative path of the servlet or JSP resource that |
---|
281 | will process this request, instead of instantiating and |
---|
282 | calling the Action class specified by "type". Exactly one |
---|
283 | of "forward", "include", or "type" must be specified. |
---|
284 | |
---|
285 | input Context-relative path of the input form to which control |
---|
286 | should be returned if a validation error is encountered. |
---|
287 | Required if "name" is specified and the input bean |
---|
288 | returns validation errors. Optional if "name" is |
---|
289 | specified and the input bean does not return validation |
---|
290 | errors. Not allowed if "name" is not specified. |
---|
291 | |
---|
292 | name Name of the form bean, if any, that is associated |
---|
293 | with this action. |
---|
294 | |
---|
295 | path The context-relative path of the submitted request, |
---|
296 | starting with a "/" character, and without the |
---|
297 | filename extension if extension mapping is used. |
---|
298 | |
---|
299 | parameter General purpose configuration parameter that can be used |
---|
300 | to pass extra information to the Action selected by this |
---|
301 | mapping. |
---|
302 | |
---|
303 | prefix Prefix used to match request parameter names to form bean |
---|
304 | property names, if any. Optional if "name" is specified, |
---|
305 | else not allowed. |
---|
306 | |
---|
307 | scope Identifier of the scope ("request" or "session") within |
---|
308 | which our form bean is accessed, if any. Optional if |
---|
309 | "name" is specified, else not allowed. |
---|
310 | |
---|
311 | suffix Suffix used to match request parameter names to form bean |
---|
312 | property names, if any. Optional if "name" is specified, |
---|
313 | else not allowed. |
---|
314 | |
---|
315 | type Fully qualified Java class name of the Action class |
---|
316 | (implements org.apache.struts.action.Action) to be |
---|
317 | used to process requests for this mapping if the "forward" |
---|
318 | or "include" attribute is not included. Exactly one |
---|
319 | of "forward", "include", or "type" must be specified. |
---|
320 | |
---|
321 | unknown Set to "true" if this action should be configured as the |
---|
322 | default for this application, to handle all requests |
---|
323 | not handled by another action. Only one action can be |
---|
324 | defined as a default within a single application. |
---|
325 | |
---|
326 | validate Set to "true" if the validate() method of the form bean |
---|
327 | should be called prior to calling this action, or set to |
---|
328 | "false" if you do not want validation performed. |
---|
329 | --> |
---|
330 | <!ELEMENT action (icon?, display-name?, description?, set-property*, forward*)> |
---|
331 | <!ATTLIST action id ID #IMPLIED> |
---|
332 | <!ATTLIST action attribute %BeanName; #IMPLIED> |
---|
333 | <!ATTLIST action className %ClassName; #IMPLIED> |
---|
334 | <!ATTLIST action forward %RequestPath; #IMPLIED> |
---|
335 | <!ATTLIST action include %RequestPath; #IMPLIED> |
---|
336 | <!ATTLIST action input %RequestPath; #IMPLIED> |
---|
337 | <!ATTLIST action name %BeanName; #IMPLIED> |
---|
338 | <!ATTLIST action parameter CDATA #IMPLIED> |
---|
339 | <!ATTLIST action path %RequestPath; #REQUIRED> |
---|
340 | <!ATTLIST action prefix CDATA #IMPLIED> |
---|
341 | <!ATTLIST action scope %RequestScope; #IMPLIED> |
---|
342 | <!ATTLIST action suffix CDATA #IMPLIED> |
---|
343 | <!ATTLIST action type %ClassName; #IMPLIED> |
---|
344 | <!ATTLIST action unknown %Boolean; #IMPLIED> |
---|
345 | <!ATTLIST action validate %Boolean; #IMPLIED> |
---|
346 | |
---|
347 | |
---|
348 | <!-- The "set-property" element specifies the name and value of an additional |
---|
349 | JavaBeans configuration property whose setter method will be called |
---|
350 | on the object that represents our surrounding element. This is especially |
---|
351 | useful when an extended implementation class (with additional properties) |
---|
352 | is configured on the <global-forwards> or <action-mappings> elements. |
---|
353 | The following attributes are defined: |
---|
354 | |
---|
355 | property Name of the JavaBeans property whose setter method |
---|
356 | will be called. |
---|
357 | |
---|
358 | value String representation of the value to which this |
---|
359 | property will be set, after suitable type conversion |
---|
360 | --> |
---|
361 | <!ELEMENT set-property EMPTY> |
---|
362 | <!ATTLIST set-property id ID #IMPLIED> |
---|
363 | <!ATTLIST set-property property %PropName; #REQUIRED> |
---|
364 | <!ATTLIST set-property value CDATA #REQUIRED> |
---|
365 | |
---|
366 | |
---|
367 | |
---|
368 | <!-- ========== Subordinate Elements ====================================== --> |
---|
369 | |
---|
370 | |
---|
371 | <!-- The "description" element contains descriptive (paragraph length) text |
---|
372 | about the surrounding element, suitable for use in GUI tools. |
---|
373 | --> |
---|
374 | <!ELEMENT description (#PCDATA)> |
---|
375 | <!ATTLIST description id ID #IMPLIED> |
---|
376 | |
---|
377 | |
---|
378 | |
---|
379 | <!-- The "display-name" element contains a short (one line) description of |
---|
380 | the surrounding element, suitable for use in GUI tools. |
---|
381 | --> |
---|
382 | <!ELEMENT display-name (#PCDATA)> |
---|
383 | <!ATTLIST display-name id ID #IMPLIED> |
---|
384 | |
---|
385 | |
---|
386 | <!-- The "icon" element contains a small-icon and large-icon element which |
---|
387 | specify the location, relative to the Struts configuration file, for small |
---|
388 | and large images used to represent the surrounding element in GUI tools. |
---|
389 | --> |
---|
390 | <!ELEMENT icon (small-icon?, large-icon?)> |
---|
391 | <!ATTLIST icon id ID #IMPLIED> |
---|
392 | |
---|
393 | |
---|
394 | <!-- The "large-icon" element specifies the location, relative to the Struts |
---|
395 | configuration file, of a resource containing a large (32x32 pixel) |
---|
396 | icon image. |
---|
397 | --> |
---|
398 | <!ELEMENT large-icon (%Location;)> |
---|
399 | <!ATTLIST large-icon id ID #IMPLIED> |
---|
400 | |
---|
401 | |
---|
402 | <!-- The "small-icon" element specifies the location, relative to the Struts |
---|
403 | configuration file, of a resource containing a small (16x16 pixel) |
---|
404 | icon image. |
---|
405 | --> |
---|
406 | <!ELEMENT small-icon (%Location;)> |
---|
407 | <!ATTLIST small-icon id ID #IMPLIED> |
---|
408 | |
---|