dgraham 2002/10/27 17:33:38
Modified: doc/userGuide building_controller.xml
Log:
updated action servlet init params to match javadoc
Revision Changes Path
1.42 +118 -76 jakarta-struts/doc/userGuide/building_controller.xml
Index: building_controller.xml
===================================================================
RCS file: /home/cvs/jakarta-struts/doc/userGuide/building_controller.xml,v
retrieving revision 1.41
retrieving revision 1.42
diff -u -r1.41 -r1.42
--- building_controller.xml 27 Oct 2002 21:36:12 -0000 1.41
+++ building_controller.xml 28 Oct 2002 01:33:38 -0000 1.42
@@ -895,83 +895,125 @@
describe the default values that are assumed if you do not provide a
value for
that initialization parameter.
</p>
- <p>
- [:TODO: Conform with JavaDoc as to nominal and deprecated params]
- </p>
<ul>
-
- <li><strong>application</strong> - Java class name of the application
- resources bundle base class. [NONE]</li>
- <li><strong>bufferSize</strong> - The size of the input buffer used when
- processing file uploads. [4096]</li>
- <li><strong>config</strong> - Context-relative path to the XML resource
- containing our configuration information.
- [/WEB-INF/struts-config.xml]</li>
- <li><strong>content</strong> - Default content type and character encoding
- to be set on each response; may be overridden by a forwarded-to
- servlet or JSP page. [text/html]</li>
- <li><strong>debug</strong> - The debugging detail level for this
- servlet, which controls how much information is logged. [0]</li>
- <li><strong>detail</strong> - The debugging detail level for the Digester
- we utilize in <code>initMapping()</code>, which logs to System.out
- instead of the servlet log. [0]</li>
- <li><strong>factory</strong> - The Java class name of the
- <code>MessageResourcesFactory</code> used to create the application
- <code>MessageResources</code> object.
- [org.apache.struts.util.PropertyMessageResourcesFactory]</li>
- <li><strong>formBean</strong> - The Java class name of the ActionFormBean
- implementation to use [org.apache.struts.action.ActionFormBean].</li>
- <li><strong>forward</strong> - The Java class name of the ActionForward
- implementation to use [org.apache.struts.action.ActionForward].
- Two convenient classes you may wish to use are:
- <ul>
- <li><em>org.apache.struts.action.ForwardingActionForward</em> -
- Subclass of <code>org.apache.struts.action.ActionForward</code>
- that defaults the <code>redirect</code> property to
- <code>false</code> (same as the ActionForward default value).</li>
- <li><em>org.apache.struts.action.RedirectingActionForward</em> -
- Subclass of <code>org.apache.struts.action.ActionForward</code>
- that defaults the <code>redirect</code> property to
- <code>true</code>.</li>
- </ul></li>
- <li><strong>locale</strong> - If set to <code>true</code>, and there is a
- user session, identify and store an appropriate
- <code>java.util.Locale</code> object (under the standard key
- identified by <code>Action.LOCALE_KEY</code>) in the user's session
- if there is not a Locale object there already. [true]</li>
- <li><strong>mapping</strong> - The Java class name of the ActionMapping
- implementation to use [org.apache.struts.action.ActionMapping].
- Two convenient classes you may wish to use are:
- <ul>
- <li><em>org.apache.struts.action.RequestActionMapping</em> - Subclass
- of <code>org.apache.struts.action.ActionMapping</code> that
- defaults the <code>scope</code> property to "request".</li>
- <li><em>org.apache.struts.action.SessionActionMapping</em> - Subclass
- of <code>org.apache.struts.action.ActionMapping</code> that
- defaults the <code>scope</code> property to "session". (Same
- as the ActionMapping default value).</li>
- </ul></li>
- <li><strong>maxFileSize</strong> - 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]</li>
- <li><strong>multipartClass</strong> - The fully qualified name of the
- MultipartRequestHandler implementation class to be used for processing
- file uploads.
[org.apache.struts.upload.CommonsMultipartRequestHandler]
- </li>
- <li><strong>nocache</strong> - If set to <code>true</code>, add HTTP
headers
- to every response intended to defeat browser caching of any response
we
- generate or forward to. [false]</li>
- <li><strong>null</strong> - If set to <code>true</code>, set our
application
- resources to return <code>null</code> if an unknown message key is
used.
- Otherwise, an error message including the offending message key will
- be returned. [true]</li>
- <li><strong>tempDir</strong> - The temporary working directory to use when
- processing file uploads. [The working directory provided to this web
- application as a servlet context attribute]</li>
- <li><strong>validate</strong> - Are we using the new configuration file
- format? [true]</li>
- </ul>
+ <li><strong>config</strong> - Context-relative path to the XML resource
+ containing the configuration information for the default module.
+ [/WEB-INF/struts-config.xml].</li>
+ <li><strong>config/${module}</strong> - Context-relative path to the XML resource
+ containing the configuration information for the application module that
+ will use the specified prefix (/${module}). This can be repeated as many
+ times as required for multiple application modules. (Since Struts 1.1)</li>
+ <li><strong>convertNull</strong> - Force simulation of the Struts 1.0 behavior
+ when populating forms. If set to true, the numeric Java wrapper class types
+ (like <code>java.lang.Integer</code>) will default to null (rather than 0).
+ (Since Struts 1.1) [false] </li>
+ <li><strong>debug</strong> - TThe debugging detail level that controls how much
+ information is logged for this servlet. Accepts values 0 (off) and from
+ 1 (least serious) through 6 (most serious). [0]</li>
+ <li><strong>detail</strong> - The debugging detail level for the Digester
+ we utilize to process the application module configuration files. Accepts
+ values 0 (off) and 1 (least serious) through 6 (most serious). [0]</li>
+ <li><strong>rulesets</strong> - Comma-delimited list of fully qualified
+ classnames of additional <code>org.apache.commons.digester.RuleSet</code>
+ instances that should be added to the <code>Digester</code> that will
+ be processing <code>struts-config.xml</code> files. By default, only
+ the <code>RuleSet</code> for the standard configuration elements is
+ loaded. (Since Struts 1.1)<li>
+ <li><strong>validating</strong> - Should we use a validating XML parser to
+ process the configuration file (strongly recommended)? [true]</li>
+ </ul>
+ <p>The following parameters may still be used with the Struts 1.1 release but
+ are <b>deprecated</b>.
+ <ul>
+ <li><strong>application</strong> - Java class name of the application
+ resources bundle base class. [NONE]
+ <em>DEPRECATED - Configure this using the "parameter" attribute
+ of the <message-resources> element.</em></li>
+ <li><strong>bufferSize</strong> - The size of the input buffer used when
+ processing file uploads. [4096]
+ <em>DEPRECATED - Configure this using the "bufferSize" attribute
+ of the <controller> element.</em></li>
+ <li><strong>content</strong> - Default content type and character encoding
+ to be set on each response; may be overridden by a forwarded-to
+ servlet or JSP page. [text/html]
+ <em>DEPRECATED - Configure this using the "contentType" attribute
+ of the <controller> element.</em></li>
+ <li><strong>factory</strong> - The Java class name of the
+ <code>MessageResourcesFactory</code> used to create the application
+ <code>MessageResources</code> object.
+ [org.apache.struts.util.PropertyMessageResourcesFactory]
+ <em>DEPRECATED - Configure this using the "factory" attribute
+ of the <message-resources> element.</em></li>
+ <li><strong>formBean</strong> - The Java class name of the ActionFormBean
+ implementation to use [org.apache.struts.action.ActionFormBean].
+ <em>DEPRECATED - Configure this using the "className" attribute
+ of each <form-bean> element.</em></li>
+ <li><strong>forward</strong> - The Java class name of the ActionForward
+ implementation to use [org.apache.struts.action.ActionForward].
+ Two convenient classes you may wish to use are:
+ <ul>
+ <li><em>org.apache.struts.action.ForwardingActionForward</em> -
+ Subclass of <code>org.apache.struts.action.ActionForward</code>
+ that defaults the <code>redirect</code> property to
+ <code>false</code> (same as the ActionForward default value).
+ <li><em>org.apache.struts.action.RedirectingActionForward</em> -
+ Subclass of <code>org.apache.struts.action.ActionForward</code>
+ that defaults the <code>redirect</code> property to
+ <code>true</code>.
+ </ul>
+ <em>DEPRECATED - Configure this using the "className" attribute of
+ each <forward> element.</em></li>
+ <li><strong>locale</strong> - If set to <code>true</code>, and there is a
+ user session, identify and store an appropriate
+ <code>java.util.Locale</code> object (under the standard key
+ identified by <code>Action.LOCALE_KEY</code>) in the user's session
+ if there is not a Locale object there already. [true]
+ <em>DEPRECATED - Configure this using the "locale" attribute of
+ the <controller> element.</em></li>
+ <li><strong>mapping</strong> - The Java class name of the ActionMapping
+ implementation to use [org.apache.struts.action.ActionMapping].
+ Two convenient classes you may wish to use are:
+ <ul>
+ <li><em>org.apache.struts.action.RequestActionMapping</em> - Subclass
+ of <code>org.apache.struts.action.ActionMapping</code> that
+ defaults the <code>scope</code> property to "request".
+ <li><em>org.apache.struts.action.SessionActionMapping</em> - Subclass
+ of <code>org.apache.struts.action.ActionMapping</code> that
+ defaults the <code>scope</code> property to "session". (Same
+ as the ActionMapping default value).
+ </ul>
+ <em>DEPRECATED - Configure this using the "className" attribute of
+ each <action> element, or globally for a module by using the
+ "type" attribute of the <action-mappings> element.</em></li>
+ <li><strong>maxFileSize</strong> - 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]
+ <em>DEPRECATED - Configure this using the "maxFileSize" attribute of
+ the <controller> element.</em></li>
+ <li><strong>multipartClass</strong> - The fully qualified name of the
+ MultipartRequestHandler implementation class to be used for processing
+ file uploads. If set to <code>none</code>, disables Struts multipart
+ request handling. [org.apache.struts.upload.CommonsMultipartRequestHandler]
+ <em>DEPRECATED - Configure this using the "multipartClass" attribute of
+ the <controller> element.</em></li>
+ <li><strong>nocache</strong> - If set to <code>true</code>, add HTTP headers
+ to every response intended to defeat browser caching of any response we
+ generate or forward to. [false]
+ <em>DEPRECATED - Configure this using the "nocache" attribute of
+ the <controller> element.</em></li>
+ <li><strong>null</strong> - If set to <code>true</code>, set our application
+ resources to return <code>null</code> if an unknown message key is used.
+ Otherwise, an error message including the offending message key will
+ be returned. [true]
+ <em>DEPRECATED - Configure this using the "null" attribute of
+ the <message-resources> element.</em></li>
+ <li><strong>tempDir</strong> - The temporary working directory to use when
+ processing file uploads. [The working directory provided to this web
+ application as a servlet context attribute]
+ <em>DEPRECATED - Configure this using the "tempDir" attribute of
+ the <controller> element.</em></li>
+ </ul>
</section>
<section name="4.7.2 Configure the Action Servlet Mapping"
href="dd_config_mapping">
--
To unsubscribe, e-mail: <mailto:struts-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:struts-dev-help@;jakarta.apache.org>
