husted 2003/12/18 09:59:30 Modified: contrib/struts-jericho/src/conf struts-jericho-config_2_0.dtd Log: Move forward and include behaviors into Location. Revision Changes Path 1.3 +70 -65 jakarta-struts/contrib/struts-jericho/src/conf/struts-jericho-config_2_0.dtd Index: struts-jericho-config_2_0.dtd =================================================================== RCS file: /home/cvs/jakarta-struts/contrib/struts-jericho/src/conf/struts-jericho-config_2_0.dtd,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- struts-jericho-config_2_0.dtd 18 Dec 2003 13:20:25 -0000 1.2 +++ struts-jericho-config_2_0.dtd 18 Dec 2003 17:59:29 -0000 1.3 @@ -80,6 +80,12 @@ <!ENTITY % Scope "(request|session|application)"> +<!-- A "LocationType" is the string representation of the alternate ways a response + can be rendered +--> +<!ENTITY % LocationType "(forward|include|redirect)"> + + <!-- ========== Top Level Elements ======================================== --> @@ -214,7 +220,7 @@ initial String representation of the initial value for this property. If not specified, primitives will be initialized to zero and objects initialized to the zero-argument instantiation of that - object class. For example, Strings will be initialized to "" + object class. For example, Strings will be initialized to "" size The number of array elements to create if the value of the "handler" attribute specifies an array, but there is no value @@ -229,7 +235,7 @@ <!ATTLIST form-property size %Integer; #IMPLIED> -<!-- The "locations" element describes a set of Location objects +<!-- The <locations> element describes a set of Location objects (org.apache.struts.core.Location) that may be referenced by other elements and returned by an MappingHandler's execute method. The individual Locations are configured through nested <location> elements. Other elements, such @@ -257,14 +263,14 @@ other elements and by the MappingHandler object at runtime to select - by its logical name - the resource that should complete the request/response. May also be referenced by - an "extends" attribute of anohter <location> element. + an "extends" attribute of another <location> element. extends Name of a form descriptor that is used as a value template for this element. All attributes from the template are available to the new element. Any attribute inherited from the template can be overridden by providing a new value. - command Name of a Command to execute before forwarding control to + command Name of a Command to execute before dispatching control to the resource for this element. The Command can be used to prepare the contexts for the resource. @@ -276,25 +282,23 @@ a slash ("/") character. mappingRef Set to "true" if the path specified for "resource" is a reference - to a Mapping. If "true", calling getResource will return a URI to + to a Mapping. If "true", calling "getResource" will return a URI to the Mapping with the appropriate prefix or extension resolved. ["false"] appRelative Set to "true" if, in a modular application, the resource attribute starts with a slash "/" and should be considered - relative to application root rather than the current module. + relative to the application root rather than the current module. ["false"] merge Set to "true" if the resource path should be scanned for replacement - parameters {[scope:]xyz}. Replacement parameters must begin + parameters: {[scope:]xyz}. Replacement parameters must begin with a letter. If a scope is not specified, all scopes are checked in turn (request, session, application). - redirect Set to "true" if a redirect instruction should be issued to - the user-agent so that a new request is issued for this - Location's resource. If "true", RequestDispatcher.Redirect is - called. If "false", RequestDispatcher.forward is called instead. - ["false"] + type May be set to "forward", "include", or "redirect" to indicate + what approach is to be taken to render response. + ["forward"] --> <!ELEMENT location (icon?, display-name?, description?, set-property*)> <!ATTLIST location id ID #IMPLIED> @@ -306,6 +310,7 @@ <!ATTLIST location appRelative %Boolean; #IMPLIED> <!ATTLIST location merge %Boolean; #IMPLIED> <!ATTLIST location redirect %Boolean; #IMPLIED> +<!ATTLIST location type %LocationType; #IMPLIED> <!-- The <exceptions> element describes a set of exceptions that might be @@ -399,7 +404,7 @@ name A unique identifier for this <processor> element so that it can be referenced by an "extends" attribute. - extends Name of an <processor> element that is used as a value template + extends Name of a <processor> element that is used as a value template for this element. All attributes from the template are available to the new element. Any attribute inherited from the template can be overridden by providing a new value. @@ -413,16 +418,11 @@ RequestHandler subclass to be used with this module. ["org.apache.struts.core.RequestHandler"] - bufferSize The size of the input buffer used when processing - file uploads. - ["4096"] - - contentType Default content type (and optional character encoding) to - be set on each response. May be overridden by the Action, - server page, or other resource to which the request is forwarded. - ["text/html"] + locale Set to "false" if you do not want a Locale object stored in the + user's session. + ["true"] - forwardPattern Replacement pattern defining how the "resource" attribute of a + pathPattern Replacement pattern defining how the "resource" attribute of a <location> element is mapped to a context-relative URL when it starts with a slash (and when the appRelative property is false). This value may consist of any @@ -436,9 +436,30 @@ Silently swallowed, reserved for future use ["$M$R"] - locale Set to "false" if you do not want a Locale object stored in the - user's session. - ["true"] + pagePattern Replacement pattern defining how the "page" attribute of + custom tags using it is mapped to a context-relative URL + of the corresponding resource. This value may consist of + any combination of the following: + - "$M" - Replaced by the module prefix of this module + - "$P" - Replaced by the value of the "page" attribute + - "$$" - Causes a literal dollar sign to be rendered + - "$x" - (Where "x" is any character not defined above) + Silently swallowed, reserved for future use + ["$M$P"] + + contentType Default content type (and optional character encoding) to + be set on each response. May be overridden by the Action, + server page, or other resource to which the request is forwarded. + ["text/html"] + + nocache Set to "true" if you want the controller to add HTTP + headers for defeating caching to every response from + this module. + ["false"] + + bufferSize The size of the input buffer used when processing + file uploads. + ["4096"] maxFileSize The maximum size (in bytes) of a file to be accepted as a file upload. Can be expressed as a number followed by a @@ -458,22 +479,6 @@ request handler class to be used with this module. ["org.apache.struts.upload.CommonsMultipartRequestHandler"] - nocache Set to "true" if you want the controller to add HTTP - headers for defeating caching to every response from - this module. - ["false"] - - pagePattern Replacement pattern defining how the "page" attribute of - custom tags using it is mapped to a context-relative URL - of the corresponding resource. This value may consist of - any combination of the following: - - "$M" - Replaced by the module prefix of this module - - "$P" - Replaced by the value of the "page" attribute - - "$$" - Causes a literal dollar sign to be rendered - - "$x" - (Where "x" is any character not defined above) - Silently swallowed, reserved for future use - ["$M$P"] - tempDir Temporary working directory to use when processing file uploads. [{Directory provided by servlet container}] @@ -484,15 +489,15 @@ <!ATTLIST processor extends CDATA #IMPLIED> <!ATTLIST processor config %ClassName; #IMPLIED> <!ATTLIST processor handler %ClassName; #IMPLIED> -<!ATTLIST processor bufferSize %Integer; #IMPLIED> -<!ATTLIST processor contentType CDATA #IMPLIED> -<!ATTLIST processor forwardPattern CDATA #IMPLIED> <!ATTLIST processor locale %Boolean; #IMPLIED> +<!ATTLIST processor pathPattern CDATA #IMPLIED> +<!ATTLIST processor pagePattern CDATA #IMPLIED> +<!ATTLIST processor contentType CDATA #IMPLIED> +<!ATTLIST processor nocache %Boolean; #IMPLIED> +<!ATTLIST processor bufferSize %Integer; #IMPLIED> <!ATTLIST processor maxFileSize CDATA #IMPLIED> <!ATTLIST processor memFileSize CDATA #IMPLIED> <!ATTLIST processor multipartClass %ClassName; #IMPLIED> -<!ATTLIST processor nocache %Boolean; #IMPLIED> -<!ATTLIST processor pagePattern CDATA #IMPLIED> <!ATTLIST processor tempDir CDATA #IMPLIED> @@ -536,15 +541,10 @@ (org.apache.struts.action.Action now implements Command and provides default behavior for backward compatibility.) - forward Location indicating some other resource that will process this - request, instead of a FormHandler class specified by "handler". - Exactly one of "command", "forward", or "include" must be - specified. - - include Location indicating some other resource that will process this - request, instead of a FormHandler class specified by "handler". - Exactly one of "command", "forward", or "include" must be - specified. + location The default location to set in the Context for this Mapping. + If not changed by a Command, this Location will be used to render + the reponse. + [null] matches The path to match against the submitted request, starting with a "/" character, and without the filename extension @@ -581,13 +581,17 @@ form Name of the form, if any, to use with this mapping. scope The scope ("request" or "session") that is used to - access our FormHandler, if any. Optional if "name" is + access our FormHandler, if any. Optional if "form" is specified, else not valid. - validate Set to "true" if the validate method of the FormHandler - should be called prior to calling the MappingHandler for this - request, or set to "false" if you do not want the - validate method called. + populate Set to "false" if the populate method of the FormHandler + should not be called prior to calling the MappingHandler for + this request. + [true] + + validate Set to "false" if the validate method of the FormHandler + should not be called prior to calling the MappingHandler for + this request. [true] invalid Name of a local or global Location that should handle the @@ -618,13 +622,14 @@ <!ATTLIST mapping attribute %PropName; #IMPLIED> <!ATTLIST mapping form CDATA; #IMPLIED> <!ATTLIST mapping scope %Scope; #IMPLIED> +<!ATTLIST mapping populate %Boolean; #IMPLIED> <!ATTLIST mapping validate %Boolean; #IMPLIED> <!ATTLIST mapping invalid CDATA #IMPLIED> <!ATTLIST mapping cancel CDATA #IMPLIED> <!-- The <bundles> element describes a set of Bundle objects - (org.apache.struts.core.Bundle) that are available to provide + (org.apache.struts.core.MessageBundle) that are available to provide message bundles. The individual Bundles are configured through nested <bundle> elements. The following attributes are defined: @@ -688,8 +693,8 @@ <!ATTLIST bundle parameter CDATA #REQUIRED> -<!-- The "plug-in" element specifies the fully qualified class name of a - general-purpose application plug-in module that receives notification of +<!-- The <plug-in> element specifies the fully qualified class name of a + general-purpose application plug-in component that receives notification of application startup and shutdown events. An instance of the specified class is created for each element, and can be configured with nested <set-property> elements. The following attributes are supported: @@ -740,7 +745,7 @@ the surrounding element is instantiated, the accessor for the indicated property is called and passed the indicated value. The "set-property" element is especially useful when a custom subclass is used with - <data-source>, <forward>, <action>, or <plug-in> elements. The subclass + <location>, <mapping>, or <plug-in> elements. The subclass can be passed whatever other properties may be required to configure the object without changing how the struts-config is parsed.
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]