struts-jericho-config_2_0.dtd

jakarta-struts-1.2.4-src

<!-- The <mapping> element describes an Mapping object that is to be used
     to process a request. The following attributes are defined:

     name            A unique identifier for this exception element so that it
                     can be referenced by an "extends" attribute. (This is *not*
                     a reference to an <input> element!)

     extends         Name of an <mapping> 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.

     config          The fully qualified class name of the Mapping object to use
                     with this instance. Defaults to the type specified by the
                     enclosing <mappings> element or to
                     "org.apache.struts.core.MappingBase" if not specified.
                     ["org.apache.struts.core.MappingBase"]

     command         Name of a Command to execute in order to process this
                     request. The Command is passed a StrutsContext object wrapping
                     the request. If the Command returns "false", the Location
                     object is processed to complete the response.
                     (org.apache.struts.action.Action now implements Command
                     and provides default behavior for backward compatibility.)

     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
                     if extension mapping is used.

                     NOTE:  Do *not* include a period in your path name,
                     because it will look like a filename extension and
                     may cause your Mapping not to found.

    processor        Name of a Processor object to use when handling this request.
                     If not specified, the "unnamed" processor is used.

    default          Set to "true" if this object should be configured as the
                     default mapping. If a request does not match another mapping,
                     it will be passed to the Mapping object with default set to
                     "true". Only one Mapping can be marked as "default" within a
                     module.
                     [false]

     secure          whether to force secure access to this mapping (via SSL).

     roles           Comma-delimited list of security role names that are allowed
                     access to this Mapping object.

     parameter       General-purpose configuration parameter that can be used to
                     pass extra information to the Command object selected by
                     this mapping.

     attribute       Name of the request-scope or session-scope attribute that
                     is used to access our InputHandler object, if it is other than
                     the object's default "input". Optional if "input" is specified,
                     else not valid.

     input           Name of the input descriptor, if any, to use with this mapping.
                     (This is *not* the dispatch Location if validate fails.)

     scope           The scope ("request" or "session") that is used to
                     access our InputHandler, if any. Optional if <input> is
                     specified, else not valid.

     populate        Set to "false" if the populate method of the InputHandler
                     should not be called prior to calling the MappingHandler for
                     this request. If "false", the reset method is also bypassed.
                     [true]

     validate        Set to "false" if the validate method of the InputHandler
                     should not be called prior to calling the MappingHandler for
                     this request.
                     [true]

     onInvalid       Name of a local or global Location that should handle the
                     response if a validation message is generated.
                     Valid only when "input" is specified.
                     Required if "input" is specified and the InputHandler returns
                     validation messages.
                     Optional if "input" is specified and the
                     InputHandler does not return validation messages.

     onCancel        Name of a local or global Location that should handle the
                     response if "cancel" is signaled in the request.
 -->
<!ELEMENT mapping (icon?, display-name?, description?, set-property*, exception*, location*)>
<!ATTLIST mapping         id             ID              #IMPLIED>
<!ATTLIST mapping         name           CDATA           #IMPLIED>
<!ATTLIST mapping         extends        CDATA           #IMPLIED>
<!ATTLIST mapping         config         %ClassName;     #IMPLIED>
<!ATTLIST mapping         command        CDATA           #IMPLIED>
<!ATTLIST mapping         forward        %RequestPath;   #IMPLIED>
<!ATTLIST mapping         include        %RequestPath;   #IMPLIED>
<!ATTLIST mapping         matches        %RequestPath;   #REQUIRED>
<!ATTLIST mapping         processor      CDATA           #IMPLIED>
<!ATTLIST mapping         default        %Boolean;       #IMPLIED>
<!ATTLIST mapping         secure         %Boolean;       #IMPLIED>
<!ATTLIST mapping         roles          CDATA           #IMPLIED>
<!ATTLIST mapping         parameter      CDATA           #IMPLIED>
<!ATTLIST mapping         attribute      %PropName;      #IMPLIED>
<!ATTLIST mapping         input          CDATA;          #IMPLIED>
<!ATTLIST mapping         scope          %Scope;         #IMPLIED>
<!ATTLIST mapping         populate       %Boolean;       #IMPLIED>
<!ATTLIST mapping         validate       %Boolean;       #IMPLIED>
<!ATTLIST mapping         onInvalid      CDATA           #IMPLIED>
<!ATTLIST mapping         onCancel       CDATA           #IMPLIED>


<!-- The <bundles> element describes a set of Bundle objects
     (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:

     config         Fully qualified class name to use when instantiating
                    Bundle objects. If specified, the object must implement
                    org.apache.struts.core.MessageBundle.
                    ["org.apache.struts.core.MessageBundleBase"]
-->
<!ELEMENT bundles (processor*)>
<!ATTLIST bundles id             ID              #IMPLIED>
<!ATTLIST bundles config         %ClassName;     #IMPLIED>


<!-- The <bundle> element describes a MessageBundle object with
     message templates for this module. The following attributes are defined:

     name            A unique identifier for this bundle element so that it
                     can be referenced by an "extends" attribute.

     extends         Name of an <bundle> 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.

     config          The fully qualified class name of the MessageBundle object to use
                     with this instance. Defaults to the type specified by the
                     enclosing <bundles> element or to
                     "org.apache.struts.core.MessageBundleBase" if not specified.
                     ["org.apache.struts.core.MappingBase"]

     factory         Fully qualified Java class name of the
                     MessageBundleFactory subclass to use for this message
                     bundle object.
                     ["org.apache.struts.util.PropertyMessageBundleFactory"]

     key             Servlet context attribute under which this message
                     bundle will be stored. The default attribute is
                     the value specified by the string constant at
                     [Keys.BUNDLE_KEY]. The application module prefix (if
                     any) is appended to the key (${key}${prefix}).
                     [org.apache.struts.core.Keys.BUNDLE_KEY]

                     NOTE: The application module prefix includes the leading
                     slash, so the default message resource bundle for a module
                     named "foo" is stored under
                     "org.apache.struts.core.BUNDLE/foo".

     null            Set to "true" if you want this message bundle to return a
                     null string for unknown message keys, or "false" to return a
                     message with the bad key value.

     parameter       Configuration parameter to be passed to the createBundle
                     method of our factory object.
-->
<!ELEMENT bundle (set-property*)>
<!ATTLIST bundle id          ID              #IMPLIED>
<!ATTLIST bundle handler     %ClassName;     #IMPLIED>
<!ATTLIST bundle factory     %ClassName;     #IMPLIED>
<!ATTLIST bundle key         %AttributeName; #IMPLIED>
<!ATTLIST bundle null        %Boolean;       #IMPLIED>
<!ATTLIST bundle parameter   CDATA           #REQUIRED>


<!-- 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:

     handler         Fully qualified Java class name of the plug-in class; must
                     implement [org.apache.struts.action.PlugIn].
-->
<!ELEMENT plug-in           (set-property*)>
<!ATTLIST plug-in           id          ID              #IMPLIED>
<!ATTLIST plug-in           handler     %ClassName;     #REQUIRED>


<!-- ========== Subordinate Elements ====================================== -->


<!-- The "description" element contains descriptive (paragraph length) text
     about the surrounding element, suitable for use in GUI tools.
-->
<!ELEMENT description    (#PCDATA)>
<!ATTLIST description    id             ID              #IMPLIED>


<!-- The "display-name" element contains a short (one line) description of
     the surrounding element, suitable for use in GUI tools.
-->
<!ELEMENT display-name (#PCDATA)>
<!ATTLIST display-name   id             ID              #IMPLIED>


<!-- The "icon" element contains a small-icon and large-icon element which
     specify the location, relative to the Struts configuration file, for small
     and large images used to represent the surrounding element in GUI tools.
-->
<!ELEMENT icon           (small-icon?, large-icon?)>
<!ATTLIST icon           id             ID              #IMPLIED>


<!-- The "large-icon" element specifies the location, relative to the Struts
     configuration file, of a resource containing a large (32x32 pixel)
     icon image.
-->
<!ELEMENT large-icon     (%Location;)>
<!ATTLIST large-icon     id             ID              #IMPLIED>


<!-- The "set-property" element specifies the method name and initial value of
     an additional JavaBean configuration property. When the object representing
     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
     <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.

     property        Name of the JavaBeans property whose setter method
                     will be called.

     value           String representation of the value to which this
                     property will be set, after suitable type conversion
-->
<!ELEMENT set-property   EMPTY>
<!ATTLIST set-property   id             ID              #IMPLIED>
<!ATTLIST set-property   property       %PropName;      #REQUIRED>
<!ATTLIST set-property   value          CDATA           #REQUIRED>


<!-- The "small-icon" element specifies the location, relative to the Struts
     configuration file, of a resource containing a small (16x16 pixel)
     icon image.
-->
<!ELEMENT small-icon     (%Location;)>
<!ATTLIST small-icon     id             ID              #IMPLIED>