struts-jericho-config_2_0.dtd

jakarta-struts-1.2.4-src

<!--
     DTD for the Struts Application Configuration File

     To support validation of your configuration file, include the following
     DOCTYPE element at the beginning (after the "xml" declaration):

     <!DOCTYPE struts-config PUBLIC
       "-//Apache Software Foundation//DTD Struts Configuration 1.2//EN"
       "http://jakarta.apache.org/struts/dtds/struts-jericho-config_2_0.dtd">

     $Id: struts-jericho-config_2_0.dtd,v 1.5 2003/12/19 02:35:07 husted Exp $
-->


<!-- ========== Defined Types ============================================= -->


<!-- An "Identifier" is the name of a programming construct and must conform
     to the rules for identifiers in the Java language.
-->
<!ENTITY % Identifier "CDATA">


<!-- An "AttributeName" is the identifier of a page, request, session, or
     application scope attribute.
-->
<!ENTITY % AttributeName "CDATA">


<!-- A "PropObject" is the identifier of an object, such as an input form,
     and also serves as the name of the corresponding scripting variable
     and the name of the attribute under which the object is accessed.
     Therefore, it must conform to the rules for an Identifier.
-->
<!ENTITY % PropObject "CDATA">


<!-- A "Boolean" is the string representation of a boolean (true or false)
     variable.
-->
<!ENTITY % Boolean "(true|false)">


<!-- A "ClassName" is the fully qualified name of a compiled class that is
     instantiated to provide the functionality of the enclosing element.
-->
<!ENTITY % ClassName "CDATA">


<!-- An "Integer" is a character string consisting solely of numeric digits,
     optionally preceeded by a minus sign, that can be converted to a
     32-bit integer.
-->
<!ENTITY % Integer "CDATA">


<!-- A "Resource" is a relative path, delimited by "/" characters, that
     defines the location of a resource relative to the location of the
     Struts configuration file itself.
-->
<!ENTITY % Resource "#PCDATA">


<!-- A "PropName" is the name of an object property, and must begin with
     a lower case letter and contain only characters that are legal in a
     identifier.
-->
<!ENTITY % PropName "CDATA">


<!-- A "RequestPath" is an application-relative URI path, beginning with a
     slash, that identifies a mapped resource (such as a server page or a
     servlet) within this web application.
-->
<!ENTITY % RequestPath "CDATA">


<!-- The name of a scope within which a object, such as an input handler, may be accessed.
-->
<!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 ======================================== -->


<!-- The "struts-config" element is the root of the configuration file
     hierarchy, and contains nested elements for all of the other
     configuration settings.
-->
<!ELEMENT struts-config (
 display-name?,
 description?,
 property*,
 catalog*,
 inputs?,
 locations?,
 exceptions?,
 processors?,
 mappings?,
 bundles,
 plug-in*)>

<!ATTLIST struts-config  id             ID              #IMPLIED>

<!-- The <property> element refers to the location of a properties file,
     relative to the Struts configuration file, that contains replacement
     variables to use when processing the elements. The properties defined
     can be referred to using the standard "shell" notation: ${property}.

     Properties can be used to avoid redundacy. For example, an often-used
     class name can be listed in the properties file:

         inputHandler = app.struts.MyInputHandler

     and then referred to as the value for an attribute:

         handler = ${inputHandler}

     The following attribute is defined:

     resource        The path to the properties file, relative to the Struts
                     Configuration file being processed.
-->
<!ELEMENT property>
<!ATTLIST property           id          ID              #IMPLIED>
<!ATTLIST property           resource    %Resource;      #REQUIRED>


<!-- The <catalog> element refers to the location of a Catalog file,
     relative to the Struts configuration file, that contains a registry
     of Command Chains that can be referred to in the "command" attributes
     of other elements.

     The following attribute is defined:

     resource        The path to the Catalog file, relative to the Struts
                     Configuration file being processed.
-->
<!ELEMENT property>
<!ATTLIST property           id          ID              #IMPLIED>
<!ATTLIST property           resource    %Resource;      #REQUIRED>


<!-- The <inputs> element describes the set of input descriptors.
The following attribute is defined:

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

     handler         Fully qualified Java class to use when instantiating
                     InputHandler objects. If specified, the object must implement
                     org.apache.struts.core.InputHandler.
                     ["org.apache.struts.core.DynaInputHandlerBase"]
-->
<!ELEMENT inputs (input*)>
<!ATTLIST inputs id              ID              #IMPLIED>
<!ATTLIST inputs config          %ClassName;     #IMPLIED>
<!ATTLIST inputs handler         %ClassName;     #IMPLIED>


<!-- The <input> element describes an InputHandler (org.apache.struts.core.InputHandler)
     instance that can be referenced by a Mapping instance.

     name            The unique identifier for this input descriptor.
                     Referenced by the "input" attribute of the <mapping> element
                     to specify which input handler to use with a matching request. May also
                     be referenced by an "extends" attribute in another <input> element.

     extends         Name of an input 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 overloaded by providing a new value.

     config          Fully qualified class name of the Input class to use with
                     this input that implements org.apache.struts.core.Input.
                     ["org.apache.struts.core.InputBase"]

     handler         Fully qualified class name of the InputHandler class to use with
                     this input that implements org.apache.struts.core.InputHandler.
                     ["org.apache.struts.core.DynaInputHandlerBase"]

-->
<!ELEMENT input (icon?, display-name?, description?, set-property*, input-property*)>
<!ATTLIST input     id              ID              #IMPLIED>
<!ATTLIST input     name            CDATA           #REQUIRED>
<!ATTLIST input     extends         CDATA           #IMPLIED>
<!ATTLIST input     config          %ClassName;     #IMPLIED>
<!ATTLIST input     handler         %ClassName;     #REQUIRED>


<!-- The <input-property> element describes an object property that can be used to
     configure an instance of a DynaInputHandler. This element is only utilized when the
     "handler" attribute of the enclosing <input> element implements
     org.apache.struts.core.DynaInputHandler.

     name            The name of the object property described by this element.

     extends         Name of an input 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 overloaded by providing a new value.

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

     handler         Fully qualified class name of the field that will handle this
                     property, optionally followed by "[]" to indicate that the
                     field is indexed.

     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 ""

     size            The number of array elements to create if the value of the
                     "handler" attribute specifies an array, but there is no value
                     specified for the "initial" attribute.
-->
<!ELEMENT input-property  (set-property*)>
<!ATTLIST input-property  name            CDATA          #REQUIRED>
<!ATTLIST input-property  extends         CDATA          #IMPLIED>
<!ATTLIST input-property  config         %ClassName;     #IMPLIED>
<!ATTLIST input-property  handler        %ClassName;     #REQUIRED>
<!ATTLIST input-property  initial        CDATA           #IMPLIED>
<!ATTLIST input-property  size           %Integer;       #IMPLIED>


<!-- 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
     as <exception> and <mapping>, may also provide nested locations specific
     to that element (local scope). The following attribute is defined:

     handler        Fully qualified Java class to use when instantiating
                    Location objects. If specified, the object must implement
                    org.apache.struts.core.Location.
                    ["org.apache.struts.core.LocationBase"]
-->
<!ELEMENT locations (location*)>
<!ATTLIST locations id            ID              #IMPLIED>
<!ATTLIST locations className     %ClassName;     #IMPLIED>


<!-- The <location> element is referenced by
     a logical name and encapsulates a URI or a reference to a mapping. A
     "location" element may be used to describe both global and local locations.
     Global locations are available to all the elements. Local locations can be