husted 2002/07/09 16:57:05
Modified: src/share/org/apache/struts/action RequestProcessor.java
PlugIn.java ActionServlet.java ActionForward.java
ActionForm.java Action.java
Log:
Javadoc updates. No code changes.
Revision Changes Path
1.15 +5 -5
jakarta-struts/src/share/org/apache/struts/action/RequestProcessor.java
Index: RequestProcessor.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/RequestProcessor.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- RequestProcessor.java 7 Jul 2002 23:15:36 -0000 1.14
+++ RequestProcessor.java 9 Jul 2002 23:57:05 -0000 1.15
@@ -719,7 +719,7 @@
return (path);
}
- // For extension matching, strip the application prefix and extension
+ // For extension matching, strip the module prefix and extension
path = (String) request.getAttribute(INCLUDE_SERVLET_PATH);
if (path == null) {
path = request.getServletPath();
1.5 +15 -15 jakarta-struts/src/share/org/apache/struts/action/PlugIn.java
Index: PlugIn.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/action/PlugIn.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PlugIn.java 25 Jun 2002 01:30:40 -0000 1.4
+++ PlugIn.java 9 Jul 2002 23:57:05 -0000 1.5
@@ -68,11 +68,11 @@
/**
- * <p>A <strong>PlugIn</strong> is a configuration wrapper for an application
- * specific module or service that needs to be notified about application
- * startup and application shutdown events (corresponding to when the
- * container calls <code>init()</code> and <code>destroy()</code> on the
- * corresponding {@link ActionServlet} instance). PlugIn modules can be
+ * <p>A <strong>PlugIn</strong> is a configuration wrapper for a
+ * module-specific resource or service that needs to be notified about
+ * application startup and application shutdown events (corresponding to when
+ * the container calls <code>init()</code> and <code>destroy()</code> on the
+ * corresponding {@link ActionServlet} instance). PlugIn Actions can be
* configured in the <code>struts-config.xml</code> file, without the need
* to subclass {@link ActionServlet} simply to perform application lifecycle
* activities.</p>
@@ -91,20 +91,20 @@
/**
- * <p>Receive notification that our owning sub-application is being
+ * <p>Receive notification that our owning application module is being
* shut down.</p>
*/
public void destroy();
/**
- * <p>Receive notification that the specified sub-applicaiton is being
+ * <p>Receive notification that the specified application module is being
* started up.</p>
*
- * @param servlet ActionServlet that is managing all the sub-applications
- * in this web application
- * @param config ApplicationConfig for the sub-application with which
- * this plug in is associated
+ * @param servlet ActionServlet that is managing all the application
+ * modules in this web application
+ * @param config ApplicationConfig for the application module with which
+ * this plug-in is associated
*
* @exception ServletException if this <code>PlugIn</code> cannot
* be successfully initialized
1.113 +39 -39
jakarta-struts/src/share/org/apache/struts/action/ActionServlet.java
Index: ActionServlet.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionServlet.java,v
retrieving revision 1.112
retrieving revision 1.113
diff -u -r1.112 -r1.113
--- ActionServlet.java 9 Jul 2002 06:40:03 -0000 1.112
+++ ActionServlet.java 9 Jul 2002 23:57:05 -0000 1.113
@@ -179,7 +179,7 @@
* are listed after the nominal parameters.</p>
* <ul>
* <li><strong>config</strong> - Context-relative path to the XML resource
- * containing the configuration information for the default application.
+ * 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
@@ -193,7 +193,7 @@
* 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 configuration files. Accepts
+ * 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>validating</strong> - Should we use a validating XML parser to
* process the configuration file (strongly recommended)? [true]</li>
@@ -259,7 +259,7 @@
* as the ActionMapping default value).
* </ul>
* <em>DEPRECATED - Configure this using the "className" attribute of
- * each <action> element, or globally for a subapp by using the
+ * 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
@@ -306,7 +306,7 @@
/**
* The context-relative path to our configuration resource for the
- * default sub-application.
+ * default application module.
*/
protected String config = "/WEB-INF/struts-config.xml";
@@ -328,7 +328,7 @@
/**
- * The JDBC data sources that has been configured for this application,
+ * The JDBC data sources that has been configured for this module,
* if any, keyed by the servlet context attribute under which they are
* stored.
*/
@@ -442,7 +442,7 @@
initOther();
initServlet();
- // Initialize sub-applications as needed
+ // Initialize application modules as needed
getServletContext().setAttribute(Action.ACTION_SERVLET_KEY, this);
ApplicationConfig ac = initApplicationConfig("", config);
initApplicationMessageResources(ac);
@@ -529,7 +529,7 @@
/**
- * Return a JDBC data source associated with this application, if any.
+ * Return a JDBC data source associated with this module, if any.
*
* @param key The servlet context attribute key under which this data
* source is stored, or <code>null</code> for the default.
@@ -588,7 +588,7 @@
/**
* Return the ActionMapping for the specified path, for the default
- * sub-application.
+ * application module.
*
* @param path Request path for which a mapping is requested
*
@@ -629,12 +629,12 @@
/**
- * <p>Return the application resources for the default sub-application,
+ * <p>Return the application resources for the default application module,
* if any.
*
* @deprecated Actions should call Action.getResources(HttpServletRequest)
* instead of this method, in order to retrieve the resources for the
- * current sub-application
+ * current application module.
*/
public MessageResources getResources() {
@@ -665,7 +665,7 @@
/**
- * Gracefully terminate use of any sub-applications associated with this
+ * Gracefully terminate use of any application modules associated with this
* application (if any).
* @since Struts 1.1
*/
@@ -717,7 +717,7 @@
* Gracefully terminate use of the data source associated with this
* application (if any).
*
- * @deprecated Will no longer be required with multi-application support
+ * @deprecated Will no longer be required with multi-module support
*/
protected void destroyDataSources() {
@@ -756,7 +756,7 @@
/**
* Return the application configuration object for the currently selected
- * sub-application.
+ * application module.
*
* @param request The servlet request we are processing
* @since Struts 1.1
@@ -777,9 +777,9 @@
/**
* Look up and return the {@link RequestProcessor} responsible for the
- * specified sub-application, creating a new one if necessary.
+ * specified application module, creating a new one if necessary.
*
- * @param appConfig The sub-application configuration for which to
+ * @param appConfig The application module configuration for which to
* acquire and return a RequestProcessor.
*
* @exception ServletException if we cannot instantiate a RequestProcessor
@@ -811,7 +811,7 @@
}
/**
* <p>Initialize the application configuration information for the
- * specified sub-application.</p>
+ * specified application module.</p>
*
* @param prefix Application prefix for this application
* @param path Context-relative resource path for this application's
@@ -828,14 +828,14 @@
"' configuration from '" + path + "'");
}
- // Parse the application configuration for this application
+ // Parse the application configuration for this module
ApplicationConfig config = null;
InputStream input = null;
String mapping = null;
try {
config = new ApplicationConfig(prefix);
- // Support for application-wide ActionMapping override
+ // Support for module-wide ActionMapping type override
mapping = getServletConfig().getInitParameter("mapping");
if (mapping != null) {
config.setActionMappingClass(mapping);
@@ -862,7 +862,7 @@
}
}
- // Special handling for the default sub-application (for
+ // Special handling for the default application module (for
// backwards compatibility only, will be removed later)
if (prefix.length() < 1) {
defaultControllerConfig(config);
@@ -880,10 +880,10 @@
/**
- * <p>Initialize the application data sources for the specified
- * sub-application.</p>
+ * <p>Initialize the data sources for the specified application
+ * module.</p>
*
- * @param config ApplicationConfig information for this application
+ * @param config ApplicationConfig information for this module
*
* @exception ServletException if initialization cannot be performed
* @since Struts 1.1
@@ -892,7 +892,7 @@
(ApplicationConfig config) throws ServletException {
if (log.isDebugEnabled()) {
- log.debug("Initializing application path '" + config.getPrefix() +
+ log.debug("Initializing module path '" + config.getPrefix() +
"' data sources");
}
@@ -906,7 +906,7 @@
dataSources.setFast(false);
for (int i = 0; i < dscs.length; i++) {
if (log.isDebugEnabled()) {
- log.debug("Initializing application path '" + config.getPrefix() +
+ log.debug("Initializing module path '" + config.getPrefix() +
"' data source '" + dscs[i].getKey() + "'");
}
DataSource ds = null;
@@ -939,9 +939,9 @@
/**
- * <p>Initialize the plug ins for the specified sub-application.</p>
+ * <p>Initialize the plug ins for the specified application module.</p>
*
- * @param config ApplicationConfig information for this application
+ * @param config ApplicationConfig information for this module
*
* @exception ServletException if initialization cannot be performed
* @since Struts 1.1
@@ -950,7 +950,7 @@
(ApplicationConfig config) throws ServletException {
if (log.isDebugEnabled()) {
- log.debug("Initializing application path '" + config.getPrefix() +
+ log.debug("Initializing module path '" + config.getPrefix() +
"' plug ins");
}
@@ -979,9 +979,9 @@
/**
* <p>Initialize the application MessageResources for the specified
- * sub-application.</p>
+ * application module.</p>
*
- * @param config ApplicationConfig information for this application
+ * @param config ApplicationConfig information for this module
*
* @exception ServletException if initialization cannot be performed
* @since Struts 1.1
@@ -1026,7 +1026,7 @@
/**
* <p>Create (if needed) and return a new Digester instance that has been
- * initialized to process Struts application configuraiton files and
+ * initialized to process Struts module configuraiton files and
* configure a corresponding ApplicationConfig object (which must be
* pushed on to the evaluation stack before parsing begins).</p>
*
@@ -1056,7 +1056,7 @@
/**
- * Initialize data sources for the default application. This method
+ * Initialize data sources for the default module. This method
* signature is maintained only for backwards compatibility, and will
* be removed in a subsequent release.
*
@@ -1227,11 +1227,11 @@
/**
- * Perform backwards-compatible configuration of the default application's
+ * Perform backwards-compatible configuration of the default module's
* controller configuration from servlet initialization parameters (as
* were used in Struts 1.0).
*
- * @param config The ApplicationConfig object for the default app
+ * @param config The ApplicationConfig object for the default module
*
* @since Struts 1.1
* @deprecated Will be removed in a release after Struts 1.1.
@@ -1360,11 +1360,11 @@
/**
- * Perform backwards-compatible configuration of the default application's
+ * Perform backwards-compatible configuration of the default module's
* message resources configuration from servlet initialization parameters
* (as were used in Struts 1.0).
*
- * @param config The ApplicationConfig object for the default app
+ * @param config The ApplicationConfig object for the default module
*
* @since Struts 1.1
* @deprecated Will be removed in a release after Struts 1.1.
1.9 +6 -6
jakarta-struts/src/share/org/apache/struts/action/ActionForward.java
Index: ActionForward.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionForward.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ActionForward.java 7 Jul 2002 23:45:21 -0000 1.8
+++ ActionForward.java 9 Jul 2002 23:57:05 -0000 1.9
@@ -81,11 +81,11 @@
* <ul>
* <li><strong>contextRelative</strong> - Should the <code>path</code>
* value be interpreted as context-relative (instead of
- * application-relative, if it starts with a '/' character? [false]</li>
+ * module-relative, if it starts with a '/' character? [false]</li>
* <li><strong>name</strong> - Logical name by which this instance may be
* looked up in relationship to a particular <code>ActionMapping</code>.
* </li>
- * <li><strong>path</strong> - Application-relative or context-relative URI to
+ * <li><strong>path</strong> - Module-relative or context-relative URI to
* which control should be forwarded, or an absolute or relative URI to
* which control should be redirected.</li>
* <li><strong>redirect</strong> - Set to <code>true</code> if the controller
1.12 +10 -10
jakarta-struts/src/share/org/apache/struts/action/ActionForm.java
Index: ActionForm.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/action/ActionForm.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- ActionForm.java 25 Jun 2002 00:42:44 -0000 1.11
+++ ActionForm.java 9 Jul 2002 23:57:05 -0000 1.12
@@ -74,17 +74,17 @@
* <p>An <strong>ActionForm</strong> is a JavaBean optionally associated with
* one or more <code>ActionMappings</code>. Such a bean will have had its
* properties initialized from the corresponding request parameters before
- * the corresonding action's <code>perform()</code> method is called.</p>
+ * the corresonding action's <code>execute</code> method is called.</p>
*
* <p>When the properties of this bean have been populated, but before the
- * <code>perform()</code> method of the action is called, this bean's
- * <code>validate()</code> method will be called, which gives the bean a chance
+ * <code>execute</code> method of the action is called, this bean's
+ * <code>validate</code> method will be called, which gives the bean a chance
* to verify that the properties submitted by the user are correct and valid.
* If this method finds problems, it returns an error messages object that
* encapsulates those problems, and the controller servlet will return control
- * to the corresponding input form. Otherwise, the <code>validate()</code>
- * method returns <code>null()</code>, indicating that everything is acceptable
- * and the corresponding Action's <code>perform()</code> method should be
+ * to the corresponding input form. Otherwise, the <code>validate</code>
+ * method returns <code>null</code>, indicating that everything is acceptable
+ * and the corresponding Action's <code>execute</code> method should be
* called.</p>
*
* <p>This class must be subclassed in order to be instantiated. Subclasses
1.43 +16 -16 jakarta-struts/src/share/org/apache/struts/action/Action.java
Index: Action.java
===================================================================
RCS file: /home/cvs/jakarta-struts/src/share/org/apache/struts/action/Action.java,v
retrieving revision 1.42
retrieving revision 1.43
diff -u -r1.42 -r1.43
--- Action.java 1 Jul 2002 04:10:38 -0000 1.42
+++ Action.java 9 Jul 2002 23:57:05 -0000 1.43
@@ -131,11 +131,11 @@
/**
* <p>The base of the context attributes key under which our
* <code>ApplicationConfig</code> data structure will be stored. This
- * will be suffixed with the actual application prefix (including the
+ * will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual attributes key.</p>
*
* <p>For each request processed by the controller servlet, the
- * <code>ApplicationConfig</code> object for the application selected by
+ * <code>ApplicationConfig</code> object for the module selected by
* the request URI currently being processed will also be exposed under
* this key as a request attribute.</p>
*
@@ -149,7 +149,7 @@
* The context attributes key under which our <strong>default</strong>
* configured data source (which must implement
* <code>javax.sql.DataSource</code>) is stored,
- * if one is configured for this application.
+ * if one is configured for this module.
*/
public static final String DATA_SOURCE_KEY =
"org.apache.struts.action.DATA_SOURCE";
@@ -243,12 +243,12 @@
/**
* <p>The base of the context attributes key under which our
- * application <code>MessageResources</code> will be stored. This
- * will be suffixed with the actual application prefix (including the
+ * module <code>MessageResources</code> will be stored. This
+ * will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual resources key.</p>
*
* <p>For each request processed by the controller servlet, the
- * <code>MessageResources</code> object for the application selected by
+ * <code>MessageResources</code> object for the module selected by
* the request URI currently being processed will also be exposed under
* this key as a request attribute.</p>
*/
@@ -266,7 +266,7 @@
/**
* <p>The base of the context attributes key under which an array of
* <code>PlugIn</code> instances will be stored. This
- * will be suffixed with the actual application prefix (including the
+ * will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual attributes key.</p>
* @since Struts 1.1
*/
@@ -277,7 +277,7 @@
/**
* <p>The base of the context attributes key under which our
* <code>RequestProcessor</code> instance will be stored. This
- * will be suffixed with the actual application prefix (including the
+ * will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual attributes key.</p>
* @since Struts 1.1
*/
@@ -512,11 +512,11 @@
/**
- * Return the message resources for the default sub-application.
+ * Return the message resources for the default application module.
*
* @deprecated This method can only return the resources for the default
- * sub-application. Use getResources(HttpServletRequest) to get the
- * resources for the current sub-application.
+ * application module. Use getResources(HttpServletRequest) to get the
+ * resources for the current application module.
*/
protected MessageResources getResources() {
@@ -527,7 +527,7 @@
/**
- * Return the message resources for the current sub-application.
+ * Return the message resources for the current application module.
*
* @param request The servlet request we are processing
* @since Struts 1.1
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
