1 | <!-- |
---|
2 | DTD for the Struts Application Configuration File |
---|
3 | |
---|
4 | To support validation of your configuration file, include the following |
---|
5 | DOCTYPE element at the beginning (after the "xml" declaration): |
---|
6 | |
---|
7 | <!DOCTYPE struts-config PUBLIC |
---|
8 | "-//Apache Software Foundation//DTD Struts Configuration 1.2//EN" |
---|
9 | "http://struts.apache.org/dtds/struts-config_1_2.dtd"> |
---|
10 | |
---|
11 | $Id: struts-config_1_2.dtd,v 1.8 2004/04/06 23:30:23 husted Exp $ |
---|
12 | --> |
---|
13 | |
---|
14 | |
---|
15 | <!-- ========== Defined Types ============================================= --> |
---|
16 | |
---|
17 | |
---|
18 | <!-- An "AttributeName" is the identifier of a page, request, session, or |
---|
19 | application scope attribute. |
---|
20 | --> |
---|
21 | <!ENTITY % AttributeName "CDATA"> |
---|
22 | |
---|
23 | |
---|
24 | <!-- A "BeanName" is the identifier of a JavaBean, such as a form bean, |
---|
25 | and also serves as the name of the corresponding scripting variable |
---|
26 | and the name of the JSP attribute under which the bean is accessed. |
---|
27 | Therefore, it must conform to the rules for a Java identifier. |
---|
28 | --> |
---|
29 | <!ENTITY % BeanName "CDATA"> |
---|
30 | |
---|
31 | |
---|
32 | <!-- A "Boolean" is the string representation of a boolean (true or false) |
---|
33 | variable. |
---|
34 | --> |
---|
35 | <!ENTITY % Boolean "(true|false|yes|no)"> |
---|
36 | |
---|
37 | |
---|
38 | <!-- A "ClassName" is the fully qualified name of a Java class that is |
---|
39 | instantiated to provide the functionality of the enclosing element. |
---|
40 | --> |
---|
41 | <!ENTITY % ClassName "CDATA"> |
---|
42 | |
---|
43 | |
---|
44 | <!-- An "Integer" is a character string consisting solely of numeric digits, |
---|
45 | optionally preceeded by a minus sign, that can be converted to a |
---|
46 | 32-bit integer. |
---|
47 | --> |
---|
48 | <!ENTITY % Integer "CDATA"> |
---|
49 | |
---|
50 | |
---|
51 | <!-- A "Location" is a relative path, delimited by "/" characters, that |
---|
52 | defines the location of a resource relative to the location of the |
---|
53 | Struts configuration file itself. |
---|
54 | --> |
---|
55 | <!ENTITY % Location "#PCDATA"> |
---|
56 | |
---|
57 | |
---|
58 | <!-- A "PropName" is the name of a JavaBeans property, and must begin with |
---|
59 | a lower case letter and contain only characters that are legal in a |
---|
60 | Java identifier. |
---|
61 | --> |
---|
62 | <!ENTITY % PropName "CDATA"> |
---|
63 | |
---|
64 | |
---|
65 | <!-- A "RequestPath" is an module-relative URI path, beginning with a |
---|
66 | slash, that identifies a mapped resource (such as a JSP page or a servlet) |
---|
67 | within this web application. |
---|
68 | --> |
---|
69 | <!ENTITY % RequestPath "CDATA"> |
---|
70 | |
---|
71 | |
---|
72 | <!-- The name of a JSP bean scope within which such a form bean may be |
---|
73 | accessed. |
---|
74 | --> |
---|
75 | <!ENTITY % RequestScope "(request|session)"> |
---|
76 | |
---|
77 | |
---|
78 | <!-- ========== Top Level Elements ======================================== --> |
---|
79 | |
---|
80 | |
---|
81 | <!-- The "struts-config" element is the root of the configuration file |
---|
82 | hierarchy, and contains nested elements for all of the other |
---|
83 | configuration settings. |
---|
84 | --> |
---|
85 | <!ELEMENT struts-config (display-name?, description?, data-sources?, form-beans?, global-exceptions?, global-forwards?, action-mappings?, controller?, message-resources*, plug-in*)> |
---|
86 | <!ATTLIST struts-config id ID #IMPLIED> |
---|
87 | |
---|
88 | |
---|
89 | <!-- The "data-sources" element describes a set of DataSource objects [JDBC 2.0 |
---|
90 | Standard Extension]. The individual DataSource objects are configured through |
---|
91 | nested <data-source> elements. |
---|
92 | --> |
---|
93 | <!ELEMENT data-sources (data-source*)> |
---|
94 | <!ATTLIST data-sources id ID #IMPLIED> |
---|
95 | |
---|
96 | |
---|
97 | <!-- The "data-source" element describes a DataSource object [JDBC 2.0 Standard |
---|
98 | Extension] that will be instantiated, configured, and made available as a |
---|
99 | servlet context attribute (or "application-scope bean"). Any object can be |
---|
100 | specified so long as it implements [javax.sql.DataSource] and can be |
---|
101 | configured entirely from JavaBean properties. The following attributes |
---|
102 | are required: |
---|
103 | |
---|
104 | className The configuration bean for this DataSource object. If |
---|
105 | specified, the object must be a subclass of the default |
---|
106 | configuration bean. |
---|
107 | ["org.apache.struts.config.DataSourceConfig"] |
---|
108 | |
---|
109 | key Servlet context attribute key under which this data source |
---|
110 | will be stored. Default is the value specified by string |
---|
111 | constant defined by Globals.DATA_SOURCE_KEY. The application |
---|
112 | module prefix (if any) is appended to the key |
---|
113 | (${key}$prefix}). |
---|
114 | [org.apache.struts.Globals.DATA_SOURCE_KEY] |
---|
115 | |
---|
116 | NOTE: The application module prefix includes the leading |
---|
117 | slash, so the default datasource for a module named "foo" is |
---|
118 | stored under "org.apache.struts.action.DATA_SOURCE/foo". |
---|
119 | |
---|
120 | type Fully qualified Java class name for this data source object. |
---|
121 | The class must implement DataSource [javax.sql.DataSource], |
---|
122 | and the object must be configurable entirely from JavaBean |
---|
123 | properties. |
---|
124 | --> |
---|
125 | <!ELEMENT data-source (set-property*)> |
---|
126 | <!ATTLIST data-source id ID #IMPLIED> |
---|
127 | <!ATTLIST data-source className %ClassName; #IMPLIED> |
---|
128 | <!ATTLIST data-source key %AttributeName; #IMPLIED> |
---|
129 | <!ATTLIST data-source type %ClassName; #REQUIRED> |
---|
130 | |
---|
131 | |
---|
132 | <!-- The "form-beans" element describes the set of form bean descriptors for this |
---|
133 | module. The following attributes are defined: |
---|
134 | |
---|
135 | type Fully qualified Java class to use when instantiating |
---|
136 | ActionFormBean objects. If specified, the object must be a |
---|
137 | subclass of the default class type. |
---|
138 | |
---|
139 | WARNING: For Struts 1.0, this value is ignored. You |
---|
140 | can set the default implementation class name with the |
---|
141 | "formBean" initialization parameter to the Struts |
---|
142 | controller servlet. |
---|
143 | --> |
---|
144 | <!ELEMENT form-beans (form-bean*)> |
---|
145 | <!ATTLIST form-beans id ID #IMPLIED> |
---|
146 | <!ATTLIST form-beans type %ClassName; #IMPLIED> |
---|
147 | |
---|
148 | |
---|
149 | <!-- The "form-bean" element describes an ActionForm subclass |
---|
150 | [org.apache.struts.action.ActionForm] that can be referenced by an "action" |
---|
151 | element. |
---|
152 | |
---|
153 | |
---|
154 | The "form-bean" element describes a particular form bean, which is a |
---|
155 | JavaBean that implements the org.apache.struts.action.ActionForm |
---|
156 | class. The following attributes are defined: |
---|
157 | |
---|
158 | className The configuration bean for this form bean object. If |
---|
159 | specified, the object must be a subclass of the default |
---|
160 | configuration bean. |
---|
161 | ["org.apache.struts.config.FormBeanConfig"] |
---|
162 | |
---|
163 | name The unique identifier for this form bean. Referenced by the |
---|
164 | <action> element to specify which form bean to use with its |
---|
165 | request. |
---|
166 | |
---|
167 | type Fully qualified Java class name of the ActionForm subclass |
---|
168 | to use with this form bean. |
---|
169 | --> |
---|
170 | <!ELEMENT form-bean (icon?, display-name?, description?, set-property*, form-property*)> |
---|
171 | <!ATTLIST form-bean id ID #IMPLIED> |
---|
172 | <!ATTLIST form-bean className %ClassName; #IMPLIED> |
---|
173 | <!ATTLIST form-bean dynamic %Boolean; #IMPLIED> |
---|
174 | <!ATTLIST form-bean name %BeanName; #REQUIRED> |
---|
175 | <!ATTLIST form-bean type %ClassName; #REQUIRED> |
---|
176 | |
---|
177 | |
---|
178 | <!-- The "form-property" element describes a JavaBean property that can be used to |
---|
179 | configure an instance of a DynaActionForm or a subclass thereof. This element |
---|
180 | is only utilized when the "type" attribute of the enclosing "form-bean" element |
---|
181 | is [org.apache.struts.action.DynaActionForm] or a subclass of DynaActionForm. If |
---|
182 | a custom DynaActionForm subclass is used, then the "dynamic" attribute of the |
---|
183 | enclosing <form-bean> element must be set to "true". Since Struts 1.1. |
---|
184 | |
---|
185 | className The configuration bean for this form property object. If |
---|
186 | specified, the object must be a subclass of the default |
---|
187 | configuration bean. |
---|
188 | ["org.apache.struts.config.FormPropertyConfig"] |
---|
189 | |
---|
190 | initial String representation of the initial value for this property. |
---|
191 | If not specified, primitives will be initialized to zero and |
---|
192 | objects initialized to the zero-argument instantiation of that |
---|
193 | object class. For example, Strings will be initialized to "" |
---|
194 | |
---|
195 | |
---|
196 | name The name of the JavaBean property described by this element. |
---|
197 | |
---|
198 | size The number of array elements to create if the value of the |
---|
199 | "type" attribute specifies an array, but there is no value |
---|
200 | specified for the "initial" attribute. |
---|
201 | |
---|
202 | type Fully qualified Java class name of the field underlying this |
---|
203 | property, optionally followed by "[]" to indicate that the |
---|
204 | field is indexed. |
---|
205 | --> |
---|
206 | <!ELEMENT form-property (set-property*)> |
---|
207 | <!ATTLIST form-property className %ClassName; #IMPLIED> |
---|
208 | <!ATTLIST form-property initial CDATA #IMPLIED> |
---|
209 | <!ATTLIST form-property name %PropName; #REQUIRED> |
---|
210 | <!ATTLIST form-property size %Integer; #IMPLIED> |
---|
211 | <!ATTLIST form-property type %ClassName; #REQUIRED> |
---|
212 | |
---|
213 | |
---|
214 | <!-- The "global-exceptions" element describes a set of exceptions that might be |
---|
215 | thrown by an Action object. The handling of individual exception types is |
---|
216 | configured through nested exception elements. An <action> element may |
---|
217 | override a global exception handler by registering a local exception handler |
---|
218 | for the same exception type. Since Struts 1.1. |
---|
219 | --> |
---|
220 | <!ELEMENT global-exceptions (exception*)> |
---|
221 | <!ATTLIST global-exceptions id ID #IMPLIED> |
---|
222 | |
---|
223 | |
---|
224 | <!-- The "exception" element registers an ExceptionHandler for an exception type. |
---|
225 | The following attributes are defined: |
---|
226 | |
---|
227 | bundle Servlet context attribute for the message resources bundle |
---|
228 | associated with this handler. The default attribute is the |
---|
229 | value specified by the string constant declared at |
---|
230 | Globals.MESSAGES_KEY. |
---|
231 | [org.apache.struts.Globals.MESSAGES_KEY] |
---|
232 | |
---|
233 | className The configuration bean for this ExceptionHandler object. |
---|
234 | If specified, className must be a subclass of the default |
---|
235 | configuration bean |
---|
236 | ["org.apache.struts.config.ExceptionConfig"] |
---|
237 | |
---|
238 | handler Fully qualified Java class name for this exception handler. |
---|
239 | ["org.apache.struts.action.ExceptionHandler"] |
---|
240 | |
---|
241 | key The key to use with this handler's message resource bundle |
---|
242 | that will retrieve the error message template for this |
---|
243 | exception. |
---|
244 | |
---|
245 | path The module-relative URI to the resource that will complete |
---|
246 | the request/response if this exception occurs. |
---|
247 | |
---|
248 | scope The context ("request" or "session") that is used to access |
---|
249 | the ActionError object [org.apache.struts.action.ActionError] |
---|
250 | for this exception. |
---|
251 | |
---|
252 | type Fully qualified Java class name of the exception type to |
---|
253 | register with this handler. |
---|
254 | --> |
---|
255 | <!ELEMENT exception (icon?, display-name?, description?, set-property*)> |
---|
256 | <!ATTLIST exception id ID #IMPLIED> |
---|
257 | <!ATTLIST exception bundle %AttributeName; #IMPLIED> |
---|
258 | <!ATTLIST exception className %ClassName; #IMPLIED> |
---|
259 | <!ATTLIST exception handler %ClassName; #IMPLIED> |
---|
260 | <!ATTLIST exception key CDATA #REQUIRED> |
---|
261 | <!ATTLIST exception path %RequestPath; #IMPLIED> |
---|
262 | <!ATTLIST exception scope CDATA #IMPLIED> |
---|
263 | <!ATTLIST exception type %ClassName; #REQUIRED> |
---|
264 | |
---|
265 | |
---|
266 | <!-- The "global-forwards" element describes a set of ActionForward objects |
---|
267 | [org.apache.struts.action.ActionForward] that are available to all Action |
---|
268 | objects as a return value. The individual ActionForwards are configured |
---|
269 | through nested <forward> elements. An <action> element may override a global |
---|
270 | forward by defining a local <forward> of the same name. |
---|
271 | |
---|
272 | type Fully qualified Java class to use when instantiating |
---|
273 | ActionForward objects. If specified, the object must be a |
---|
274 | subclass of the default class type. |
---|
275 | |
---|
276 | WARNING: For Struts 1.0, this value is ignored. You |
---|
277 | can set the default implementation class name with the |
---|
278 | "forward" initialization parameter to the Struts |
---|
279 | controller servlet. |
---|
280 | --> |
---|
281 | <!ELEMENT global-forwards (forward*)> |
---|
282 | <!ATTLIST global-forwards id ID #IMPLIED> |
---|
283 | <!ATTLIST global-forwards type %ClassName; #IMPLIED> |
---|
284 | |
---|
285 | |
---|
286 | <!-- The "forward" element describes an ActionForward that is to be made |
---|
287 | available to an Action as a return value. An ActionForward is referenced by |
---|
288 | a logical name and encapsulates a URI. A "forward" element may be used to |
---|
289 | describe both global and local ActionForwards. Global forwards are available |
---|
290 | to all the Action objects in the module. Local forwards can be |
---|
291 | nested within an <action> element and only available to an Action object |
---|
292 | when it is invoked through that ActionMapping. |
---|
293 | |
---|
294 | className Fully qualified Java class name of ActionForward |
---|
295 | subclass to use for this object. |
---|
296 | ["org.apache.struts.action.ActionForward"] |
---|
297 | |
---|
298 | contextRelative Set this to "true" if, in a modular application, the path |
---|
299 | attribute starts with a slash "/" and should be considered |
---|
300 | relative to the entire web application rather than the module. |
---|
301 | Since Struts 1.1. |
---|
302 | DEPRECATED. |
---|
303 | [false] |
---|
304 | |
---|
305 | module The module prefix to use with this path. This value should |
---|
306 | begin with a slash ("/"). |
---|
307 | |
---|
308 | name The unique identifier for this forward. Referenced by the |
---|
309 | Action object at runtime to select - by its logical name - |
---|
310 | the resource that should complete the request/response. |
---|
311 | |
---|
312 | path The module-relative or context-relative path to the resources |
---|
313 | that is encapsulated by the logical name of this ActionForward. |
---|
314 | If the path is to be considered context-relative when used in |
---|
315 | a modular application, then the contextRelative attribute |
---|
316 | should be set to "true". This value should begin with a slash |
---|
317 | ("/") character. |
---|
318 | |
---|
319 | redirect Set to "true" if a redirect instruction should be issued to |
---|
320 | the user-agent so that a new request is issued for this |
---|
321 | forward's resource. If true, RequestDispatcher.Redirect is |
---|
322 | called. If "false", RequestDispatcher.forward is called instead. |
---|
323 | [false] |
---|
324 | --> |
---|
325 | <!ELEMENT forward (icon?, display-name?, description?, set-property*)> |
---|
326 | <!ATTLIST forward id ID #IMPLIED> |
---|
327 | <!ATTLIST forward className %ClassName; #IMPLIED> |
---|
328 | <!ATTLIST forward contextRelative %Boolean; #IMPLIED> |
---|
329 | <!ATTLIST forward module %RequestPath; #IMPLIED> |
---|
330 | <!ATTLIST forward name CDATA #REQUIRED> |
---|
331 | <!ATTLIST forward path %RequestPath; #REQUIRED> |
---|
332 | <!ATTLIST forward redirect %Boolean; #IMPLIED> |
---|
333 | |
---|
334 | |
---|
335 | <!-- The "action-mappings" element describes a set of ActionMapping objects |
---|
336 | [org.apache.struts.action.ActionMapping] that are available to process |
---|
337 | requests matching the url-pattern our ActionServlet registered with the |
---|
338 | container. The individual ActionMappings are configured through nested |
---|
339 | <action> elements. The following attributes are defined: |
---|
340 | |
---|
341 | type Fully qualified Java class to use when instantiating |
---|
342 | ActionMapping objects. If specified, the object must be a |
---|
343 | subclass of the default class type. |
---|
344 | |
---|
345 | WARNING: For Struts 1.0, this value is ignored. You |
---|
346 | can set the default implementation class name with the |
---|
347 | "mapping" initialization parameter to the Struts |
---|
348 | controller servlet. |
---|
349 | --> |
---|
350 | <!ELEMENT action-mappings (action*)> |
---|
351 | <!ATTLIST action-mappings id ID #IMPLIED> |
---|
352 | <!ATTLIST action-mappings type %ClassName; #IMPLIED> |
---|
353 | |
---|
354 | |
---|
355 | <!-- The "action" element describes an ActionMapping object that is to be used |
---|
356 | to process a request for a specific module-relative URI. The following |
---|
357 | attributes are defined: |
---|
358 | |
---|
359 | attribute Name of the request-scope or session-scope attribute that |
---|
360 | is used to access our ActionForm bean, if it is other than |
---|
361 | the bean's specified "name". Optional if "name" is specified, |
---|
362 | else not valid. |
---|
363 | |
---|
364 | className The fully qualified Java class name of the ActionMapping |
---|
365 | subclass to use for this action mapping object. Defaults to |
---|
366 | the type specified by the enclosing <action-mappings> |
---|
367 | element or to "org.apache.struts.action.ActionMapping" if |
---|
368 | not specified. |
---|
369 | ["org.apache.struts.action.ActionMapping"] |
---|
370 | |
---|
371 | forward Module-relative path of the servlet or other resource that |
---|
372 | will process this request, instead of the Action class |
---|
373 | specified by "type". The path WILL NOT be processed |
---|
374 | through the "forwardPattern" attribute that is configured |
---|
375 | on the "controller" element for this module. |
---|
376 | Exactly one of "forward", "include", or "type" must be |
---|
377 | specified. |
---|
378 | |
---|
379 | include Module-relative path of the servlet or other resource that |
---|
380 | will process this request, instead of the Action class |
---|
381 | specified by "type". The path WILL NOT be processed |
---|
382 | through the "forwardPattern" attribute that is configured |
---|
383 | on the "controller" element for this module. |
---|
384 | Exactly one of "forward", "include", or "type" must be |
---|
385 | specified. |
---|
386 | |
---|
387 | input Module-relative path of the action or other resource to |
---|
388 | which control should be returned if a validation error is |
---|
389 | encountered. Valid only when "name" is specified. Required |
---|
390 | if "name" is specified and the input bean returns |
---|
391 | validation errors. Optional if "name" is specified and the |
---|
392 | input bean does not return validation errors. |
---|
393 | |
---|
394 | name Name of the form bean, if any, that is associated with this |
---|
395 | action mapping. |
---|
396 | |
---|
397 | path The module-relative path of the submitted request, starting |
---|
398 | with a "/" character, and without the filename extension if |
---|
399 | extension mapping is used. |
---|
400 | |
---|
401 | NOTE: Do *not* include a period in your path name, |
---|
402 | because it will look like a filename extension and |
---|
403 | cause your Action to not be located. |
---|
404 | |
---|
405 | parameter General-purpose configuration parameter that can be used to |
---|
406 | pass extra information to the Action object selected by |
---|
407 | this action mapping. |
---|
408 | |
---|
409 | prefix Prefix used to match request parameter names to ActionForm |
---|
410 | property names, if any. Optional if "name" is specified, |
---|
411 | else not allowed. |
---|
412 | |
---|
413 | roles Comma-delimited list of security role names that are allowed |
---|
414 | access to this ActionMapping object. Since Struts 1.1. |
---|
415 | |
---|
416 | scope The context ("request" or "session") that is used to |
---|
417 | access our ActionForm bean, if any. Optional if "name" is |
---|
418 | specified, else not valid. |
---|
419 | |
---|
420 | suffix Suffix used to match request parameter names to ActionForm |
---|
421 | bean property names, if any. Optional if "name" is |
---|
422 | specified, else not valid. |
---|
423 | |
---|
424 | type Fully qualified Java class name of the Action subclass |
---|
425 | [org.apache.struts.action.Action] that will process requests |
---|
426 | for this action mapping. Not valid if either the "forward" |
---|
427 | or "include" attribute is specified. Exactly one of |
---|
428 | "forward", "include", or "type" must be specified. |
---|
429 | |
---|
430 | unknown Set to "true" if this object should be configured as the |
---|
431 | default action mapping for this module. If a request does not |
---|
432 | match another object, it will be passed to the ActionMapping |
---|
433 | object with unknown set to "true". Only one ActionMapping |
---|
434 | can be marked as "unknown" within a module. |
---|
435 | [false] |
---|
436 | |
---|
437 | validate Set to "true" if the validate method of the ActionForm bean |
---|
438 | should be called prior to calling the Action object for this |
---|
439 | action mapping, or set to "false" if you do not want the |
---|
440 | validate method called. |
---|
441 | [true] |
---|
442 | --> |
---|
443 | <!ELEMENT action (icon?, display-name?, description?, set-property*, exception*, forward*)> |
---|
444 | <!ATTLIST action id ID #IMPLIED> |
---|
445 | <!ATTLIST action attribute %BeanName; #IMPLIED> |
---|
446 | <!ATTLIST action className %ClassName; #IMPLIED> |
---|
447 | <!ATTLIST action forward %RequestPath; #IMPLIED> |
---|
448 | <!ATTLIST action include %RequestPath; #IMPLIED> |
---|
449 | <!ATTLIST action input %RequestPath; #IMPLIED> |
---|
450 | <!ATTLIST action name %BeanName; #IMPLIED> |
---|
451 | <!ATTLIST action parameter CDATA #IMPLIED> |
---|
452 | <!ATTLIST action path %RequestPath; #REQUIRED> |
---|
453 | <!ATTLIST action prefix CDATA #IMPLIED> |
---|
454 | <!ATTLIST action roles CDATA #IMPLIED> |
---|
455 | <!ATTLIST action scope %RequestScope; #IMPLIED> |
---|
456 | <!ATTLIST action suffix CDATA #IMPLIED> |
---|
457 | <!ATTLIST action type %ClassName; #IMPLIED> |
---|
458 | <!ATTLIST action unknown %Boolean; #IMPLIED> |
---|
459 | <!ATTLIST action validate %Boolean; #IMPLIED> |
---|
460 | |
---|
461 | |
---|
462 | <!-- The "controller" element describes the ControllerConfig bean |
---|
463 | [org.apache.struts.config.ControllerConfig] that encapsulates |
---|
464 | a module's runtime configuration. The following |
---|
465 | attributes are defined: |
---|
466 | |
---|
467 | bufferSize The size of the input buffer used when processing |
---|
468 | file uploads. |
---|
469 | [4096] |
---|
470 | |
---|
471 | className Fully qualified Java class name of the |
---|
472 | ControllerConfig subclass for this controller object. |
---|
473 | If specified, the object must be a subclass of the |
---|
474 | default class. |
---|
475 | ["org.apache.struts.config.ControllerConfig"] |
---|
476 | |
---|
477 | contentType Default content type (and optional character encoding) to |
---|
478 | be set on each response. May be overridden by the Action, |
---|
479 | JSP, or other resource to which the request is forwarded. |
---|
480 | ["text/html"] |
---|
481 | |
---|
482 | forwardPattern Replacement pattern defining how the "path" attribute of a |
---|
483 | <forward> element is mapped to a context-relative URL when |
---|
484 | it starts with a slash (and when the contextRelative |
---|
485 | property is false). This value may consist of any |
---|
486 | combination of the following: |
---|
487 | - "$M" - Replaced by the module prefix of this module |
---|
488 | - "$P" - Replaced by the "path" attribute of the selected |
---|
489 | "forward" element |
---|
490 | - "$$" - Causes a literal dollar sign to be rendered |
---|
491 | - "$x" - (Where "x" is any character not defined above) |
---|
492 | Silently swallowed, reserved for future use |
---|
493 | If not specified, the default forwardPattern is "$M$P", |
---|
494 | which is consistent with the previous behavior of |
---|
495 | forwards. Since Struts 1.1. ["$M$P"] |
---|
496 | |
---|
497 | inputForward Set to "true" if you want the "input" attribute of |
---|
498 | <action> elements to be the name of a local or global |
---|
499 | ActionForward, which will then be used to calculate the |
---|
500 | ultimate URL. Set to "false" (the default) to treat the |
---|
501 | "input" parameter of <action> elements as a |
---|
502 | module-relative path to the resource |
---|
503 | to be used as the input form. Since Struts 1.1. |
---|
504 | [false] |
---|
505 | |
---|
506 | locale Set to "true" if you want a Locale object stored in the |
---|
507 | user's session if not already present. |
---|
508 | [true] |
---|
509 | |
---|
510 | maxFileSize The maximum size (in bytes) of a file to be accepted as a |
---|
511 | file upload. Can be expressed as a number followed by a |
---|
512 | "K", "M", or "G", which are interpreted to mean kilobytes, |
---|
513 | megabytes, or gigabytes, respectively. |
---|
514 | ["250M"] |
---|
515 | |
---|
516 | memFileSize The maximum size (in bytes) of a file whose contents will |
---|
517 | be retained in memory after uploading. Files larger than |
---|
518 | this threshold will be written to some alternative storage |
---|
519 | medium, typically a hard disk. Can be expressed as a number |
---|
520 | followed by a "K", "M", or "G", which are interpreted to |
---|
521 | mean kilobytes, megabytes, or gigabytes, respectively. |
---|
522 | ["256K"] |
---|
523 | |
---|
524 | multipartClass The fully qualified Java class name of the multipart |
---|
525 | request handler class to be used with this module. |
---|
526 | ["org.apache.struts.upload.CommonsMultipartRequestHandler"] |
---|
527 | |
---|
528 | nocache Set to "true" if you want the controller to add HTTP |
---|
529 | headers for defeating caching to every response from |
---|
530 | this module. [false] |
---|
531 | |
---|
532 | pagePattern Replacement pattern defining how the "page" attribute of |
---|
533 | custom tags using it is mapped to a context-relative URL |
---|
534 | of the corresponding resource. This value may consist of |
---|
535 | any combination of the following: |
---|
536 | - "$M" - Replaced by the module prefix of this module |
---|
537 | - "$P" - Replaced by the value of the "page" attribute |
---|
538 | - "$$" - Causes a literal dollar sign to be rendered |
---|
539 | - "$x" - (Where "x" is any character not defined above) |
---|
540 | Silently swallowed, reserved for future use |
---|
541 | If not specified, the default forwardPattern is |
---|
542 | "$M$P", which is consistent with previous hard coded |
---|
543 | behavior of URL evaluation for "page" attributes. |
---|
544 | ["$M$P"] |
---|
545 | |
---|
546 | processorClass The fully qualified Java class name of the |
---|
547 | RequestProcessor subclass to be used with this module. |
---|
548 | ["org.apache.struts.action.RequestProcessor"] |
---|
549 | |
---|
550 | tempDir Temporary working directory to use when processing |
---|
551 | file uploads. |
---|
552 | [{Directory provided by servlet container}] |
---|
553 | --> |
---|
554 | <!ELEMENT controller (set-property*)> |
---|
555 | <!ATTLIST controller id ID #IMPLIED> |
---|
556 | <!ATTLIST controller bufferSize %Integer; #IMPLIED> |
---|
557 | <!ATTLIST controller className %ClassName; #IMPLIED> |
---|
558 | <!ATTLIST controller contentType CDATA #IMPLIED> |
---|
559 | <!ATTLIST controller forwardPattern CDATA #IMPLIED> |
---|
560 | <!ATTLIST controller inputForward %Boolean; #IMPLIED> |
---|
561 | <!ATTLIST controller locale %Boolean; #IMPLIED> |
---|
562 | <!ATTLIST controller maxFileSize CDATA #IMPLIED> |
---|
563 | <!ATTLIST controller memFileSize CDATA #IMPLIED> |
---|
564 | <!ATTLIST controller multipartClass %ClassName; #IMPLIED> |
---|
565 | <!ATTLIST controller nocache %Boolean; #IMPLIED> |
---|
566 | <!ATTLIST controller pagePattern CDATA #IMPLIED> |
---|
567 | <!ATTLIST controller processorClass %ClassName; #IMPLIED> |
---|
568 | <!ATTLIST controller tempDir CDATA #IMPLIED> |
---|
569 | |
---|
570 | |
---|
571 | <!-- The "message-resources" element describes a MessageResources object with |
---|
572 | message templates for this module. The following attributes are defined: |
---|
573 | |
---|
574 | className The configuration bean for this message resources object. |
---|
575 | If specified, the object must be a subclass of the default |
---|
576 | configuration bean. |
---|
577 | ["org.apache.struts.config.MessageResourcesConfig"] |
---|
578 | |
---|
579 | factory Fully qualified Java class name of the |
---|
580 | MessageResourcesFactory subclass to use for this message |
---|
581 | resources object. |
---|
582 | ["org.apache.struts.util.PropertyMessageResourcesFactory"] |
---|
583 | |
---|
584 | key Servlet context attribute under which this message |
---|
585 | resources bundle will be stored. The default attribute is |
---|
586 | the value specified by the string constant at |
---|
587 | [Globals.MESSAGES_KEY]. The module prefix (if |
---|
588 | any) is appended to the key (${key}${prefix}). |
---|
589 | [org.apache.struts.Globals.MESSAGES_KEY] |
---|
590 | |
---|
591 | NOTE: The module prefix includes the leading |
---|
592 | slash, so the default message resource bundle for a module |
---|
593 | named "foo" is stored under |
---|
594 | "org.apache.struts.action.MESSAGE/foo". |
---|
595 | |
---|
596 | null Set to "true" if you want our message resources to return a |
---|
597 | null string for unknown message keys, or "false" to return a |
---|
598 | message with the bad key value. |
---|
599 | |
---|
600 | parameter Configuration parameter to be passed to the createResources |
---|
601 | method of our factory object. |
---|
602 | --> |
---|
603 | <!ELEMENT message-resources (set-property*)> |
---|
604 | <!ATTLIST message-resources id ID #IMPLIED> |
---|
605 | <!ATTLIST message-resources className %ClassName; #IMPLIED> |
---|
606 | <!ATTLIST message-resources factory %ClassName; #IMPLIED> |
---|
607 | <!ATTLIST message-resources key %AttributeName; #IMPLIED> |
---|
608 | <!ATTLIST message-resources null %Boolean; #IMPLIED> |
---|
609 | <!ATTLIST message-resources parameter CDATA #REQUIRED> |
---|
610 | |
---|
611 | |
---|
612 | <!-- The "plug-in" element specifies the fully qualified class name of a |
---|
613 | general-purpose application plug-in module that receives notification of |
---|
614 | application startup and shutdown events. An instance of the specified class |
---|
615 | is created for each element, and can be configured with nested <set-property> |
---|
616 | elements. The following attributes are supported: |
---|
617 | |
---|
618 | className Fully qualified Java class name of the plug-in class; must |
---|
619 | implement [org.apache.struts.action.PlugIn]. |
---|
620 | --> |
---|
621 | <!ELEMENT plug-in (set-property*)> |
---|
622 | <!ATTLIST plug-in id ID #IMPLIED> |
---|
623 | <!ATTLIST plug-in className %ClassName; #REQUIRED> |
---|
624 | |
---|
625 | |
---|
626 | <!-- ========== Subordinate Elements ====================================== --> |
---|
627 | |
---|
628 | |
---|
629 | <!-- The "description" element contains descriptive (paragraph length) text |
---|
630 | about the surrounding element, suitable for use in GUI tools. |
---|
631 | --> |
---|
632 | <!ELEMENT description (#PCDATA)> |
---|
633 | <!ATTLIST description id ID #IMPLIED> |
---|
634 | |
---|
635 | |
---|
636 | <!-- The "display-name" element contains a short (one line) description of |
---|
637 | the surrounding element, suitable for use in GUI tools. |
---|
638 | --> |
---|
639 | <!ELEMENT display-name (#PCDATA)> |
---|
640 | <!ATTLIST display-name id ID #IMPLIED> |
---|
641 | |
---|
642 | |
---|
643 | <!-- The "icon" element contains a small-icon and large-icon element which |
---|
644 | specify the location, relative to the Struts configuration file, for small |
---|
645 | and large images used to represent the surrounding element in GUI tools. |
---|
646 | --> |
---|
647 | <!ELEMENT icon (small-icon?, large-icon?)> |
---|
648 | <!ATTLIST icon id ID #IMPLIED> |
---|
649 | |
---|
650 | |
---|
651 | <!-- The "large-icon" element specifies the location, relative to the Struts |
---|
652 | configuration file, of a resource containing a large (32x32 pixel) |
---|
653 | icon image. |
---|
654 | --> |
---|
655 | <!ELEMENT large-icon (%Location;)> |
---|
656 | <!ATTLIST large-icon id ID #IMPLIED> |
---|
657 | |
---|
658 | |
---|
659 | <!-- The "set-property" element specifies the method name and initial value of |
---|
660 | an additional JavaBean configuration property. When the object representing |
---|
661 | the surrounding element is instantiated, the accessor for the indicated |
---|
662 | property is called and passed the indicated value. The "set-property" |
---|
663 | element is especially useful when a custom subclass is used with |
---|
664 | <data-source>, <forward>, <action>, or <plug-in> elements. The subclass |
---|
665 | can be passed whatever other properties may be required to configure the |
---|
666 | object without changing how the struts-config is parsed. |
---|
667 | |
---|
668 | property Name of the JavaBeans property whose setter method |
---|
669 | will be called. |
---|
670 | |
---|
671 | value String representation of the value to which this |
---|
672 | property will be set, after suitable type conversion |
---|
673 | --> |
---|
674 | <!ELEMENT set-property EMPTY> |
---|
675 | <!ATTLIST set-property id ID #IMPLIED> |
---|
676 | <!ATTLIST set-property property %PropName; #REQUIRED> |
---|
677 | <!ATTLIST set-property value CDATA #REQUIRED> |
---|
678 | |
---|
679 | |
---|
680 | <!-- The "small-icon" element specifies the location, relative to the Struts |
---|
681 | configuration file, of a resource containing a small (16x16 pixel) |
---|
682 | icon image. |
---|
683 | --> |
---|
684 | <!ELEMENT small-icon (%Location;)> |
---|
685 | <!ATTLIST small-icon id ID #IMPLIED> |
---|
686 | |
---|