struts-jericho-config_2_0.dtd

jakarta-struts-1.2.4-src

     nested within an <exception> or <mapping> element and only available when it
     is invoked in that context.

     name            The unique identifier for this location. Referenced by
                     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 another <location> element.

     extends         Name of a location 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 dispatching control to
                     the resource for this element. The Command can be used to
                     prepare the contexts for the resource.

     resource        The module-relative or context-relative path to the resource
                     that is encapsulated by the logical name of this Location.
                     If the path is to be considered relative to the root application
                     context when used in a modular application, then the "appRelative"
                     attribute should be set to "true". This value should begin with
                     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
                     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 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
                     with a letter. If a scope is not specified, all scopes are
                     checked in turn (request, session, application).

     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>
<!ATTLIST location        name           CDATA           #IMPLIED>
<!ATTLIST location        extends        CDATA           #IMPLIED>
<!ATTLIST location        command        CDATA           #IMPLIED>
<!ATTLIST location        resource       %RequestPath;   #REQUIRED>
<!ATTLIST location        mappingRef     %Boolean;       #IMPLIED>
<!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
     thrown by an MappingHandler object. The handling of individual exception
     classes can be configured through nested exception elements.
     If a <mapping> element registers a local exception handler for the same
     exception type, the local handler overrides the global exception handler.
     The following attribute is defined:

     handler        Fully qualified Java class to use when instantiating
                    ExceptionConfig objects. If specified, the object must implement
                    org.apache.struts.core.ExceptionConfig.
-->
<!ELEMENT exceptions (exception*)>
<!ATTLIST exceptions id          ID              #IMPLIED>


<!-- The <exception> element registers an ExceptionHandler
    (org.apache.struts.core.ExceptionHandler) for an exception class.
     The following attributes are defined:

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

     extends         Name of an <exception> 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          Fully qualified class name to use when instantiating
                     ExceptionConfig objects. If specified, the object must implement
                     org.apache.struts.core.ExceptionConfig.
                     ["org.apache.struts.core.ExceptionConfigBase"]

     handler         Fully qualified class name of the exception handler to use
                     with this exception.
                     ["org.apache.struts.core.ExceptionHandlerBase"]

     location        The name of the <location> element (local or global) that will
                     complete the request/response if the Exception specified by the
                     "trigger" attribute is thrown.

     scope           The scope ("request" or "session") that is used to access
                     the Message object (org.apache.struts.core.Message)
                     for this exception.

     bundleName      Attribute name for the message bundle associated with this
                     handler. [org.apache.struts.core.Keys.BUNDLE_KEY]

     key             The key to use with this handler's message bundle
                     that will retrieve the message template to use with this
                     exception.

     trigger         Fully qualified class name of the Exception class to
                     register with this handler.
-->
<!ELEMENT exception (icon?, display-name?, description?, set-property*, location*)>
<!ATTLIST exception      id             ID              #IMPLIED>
<!ATTLIST exception      name           CDATA           #IMPLIED>
<!ATTLIST exception      extends        CDATA           #IMPLIED>
<!ATTLIST exception      config         %ClassName;     #IMPLIED>
<!ATTLIST exception      handler        %ClassName;     #IMPLIED>
<!ATTLIST exception      location       CDATA           #IMPLIED>
<!ATTLIST exception      scope          %Scope;         #IMPLIED>
<!ATTLIST exception      bundleName     %AttributeName; #IMPLIED>
<!ATTLIST exception      key            CDATA           #REQUIRED>
<!ATTLIST exception      trigger        %ClassName;     #REQUIRED>


<!-- The <processors> element describes a set of Processor objects
     (org.apache.struts.core.Processor) that are available to process
     requests. The individual Processors are configured through nested
     <processor> elements. The following attributes are defined:

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


<!-- The <processor> element describes the a Processor object
     [org.apache.struts.core.Processor] that is used to manage a
     request/response event. Each <mapping> element can specify
     its own Processor object, if needed. The following attributes
     are defined:

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

     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.

     config          Fully qualified class name to use when instantiating
                     Processor objects. If specified, the object must implement
                     org.apache.struts.core.Processor.
                     ["org.apache.struts.core.ProcessorBase"]

     handler         The fully qualified class name of the
                     RequestHandler subclass to be used with this module.
                     ["org.apache.struts.core.RequestHandler"]

     locale          Set to "false" if you do not want a Locale object stored in the
                     user's session.
                     ["true"]

     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
                     combination of the following:
                     - "$M" - Replaced by the module prefix of this module
                     - "$R" - Replaced by the "resource" attribute of the
                     selected "location" element
                     - "$P" - Same as "$R".
                     - "$$" - Causes a literal dollar sign to be rendered
                     - "$x" - (Where "x" is any character not defined above)
                     Silently swallowed, reserved for future use
                     ["$M$R"]

     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
                     "K", "M", or "G", which are interpreted to mean kilobytes,
                     megabytes, or gigabytes, respectively.
                     ["250M"]

     memFileSize     The maximum size (in bytes) of a file whose contents will
                     be retained in memory after uploading. Files larger than
                     this threshold will be written to some alternative storage
                     medium, typically a hard disk. Can be expressed as a number
                     followed by a "K", "M", or "G", which are interpreted to
                     mean kilobytes, megabytes, or gigabytes, respectively.
                     ["256K"]

     multipartClass  The fully qualified Java class name of the multipart
                     request handler class to be used with this module.
                     ["org.apache.struts.upload.CommonsMultipartRequestHandler"]

     tempDir         Temporary working directory to use when processing
                     file uploads.
                     [{Directory provided by servlet container}]
-->
<!ELEMENT processor     (set-property*)>
<!ATTLIST processor     id             ID              #IMPLIED>
<!ATTLIST processor     name           CDATA           #IMPLIED>
<!ATTLIST processor     extends        CDATA           #IMPLIED>
<!ATTLIST processor     config         %ClassName;     #IMPLIED>
<!ATTLIST processor     handler        %ClassName;     #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     tempDir        CDATA           #IMPLIED>


<!-- The <mappings> element describes a set of Mapping objects
     (org.apache.struts.core.Mapping) that are available to process
     requests. The individual Mappings are configured through nested
     <mapping> elements. The following attributes are defined:

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