husted 01/11/28 09:22:58
Modified: src/share/org/apache/struts/actions DispatchAction.java
Added: src/share/org/apache/struts/actions
LookupDispatchAction.java
Log:
Refactor DispatchAction so that it can be more easily subclassed.
Commit LookupDispatchAction (by Erik Hatcher) which
can dispatch to a method by looking up the message key
for the button's label, so that multiple submit buttons can share
the same name.
Revision Changes Path
1.3 +65 -48
jakarta-struts/src/share/org/apache/struts/actions/DispatchAction.java
Index: DispatchAction.java
===================================================================
RCS file:
/home/cvs/jakarta-struts/src/share/org/apache/struts/actions/DispatchAction.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DispatchAction.java 2001/03/29 18:41:52 1.2
+++ DispatchAction.java 2001/11/28 17:22:58 1.3
@@ -1,7 +1,7 @@
/*
- * $Header:
/home/cvs/jakarta-struts/src/share/org/apache/struts/actions/DispatchAction.java,v 1.2
2001/03/29 18:41:52 craigmcc Exp $
- * $Revision: 1.2 $
- * $Date: 2001/03/29 18:41:52 $
+ * $Header:
/home/cvs/jakarta-struts/src/share/org/apache/struts/actions/DispatchAction.java,v 1.3
2001/11/28 17:22:58 husted Exp $
+ * $Revision: 1.3 $
+ * $Date: 2001/11/28 17:22:58 $
*
* ====================================================================
*
@@ -127,7 +127,8 @@
*
* @author Niall Pemberton <[EMAIL PROTECTED]>
* @author Craig R. McClanahan
- * @version $Revision: 1.2 $ $Date: 2001/03/29 18:41:52 $
+ * @author Ted Husted
+ * @version $Revision: 1.3 $ $Date: 2001/11/28 17:22:58 $
*/
public abstract class DispatchAction extends Action {
@@ -168,53 +169,18 @@
HttpServletRequest.class, HttpServletResponse.class };
- // --------------------------------------------------------- Public Methods
-
/**
- * Process the specified HTTP request, and create the corresponding HTTP
- * response (or forward to another web component that will create it).
- * Return an <code>ActionForward</code> instance describing where and how
- * control should be forwarded, or <code>null</code> if the response has
- * already been completed.
- *
- * @param mapping The ActionMapping used to select this instance
- * @param actionForm The optional ActionForm bean for this request (if any)
- * @param request The HTTP request we are processing
- * @param response The HTTP response we are creating
- *
- * @exception IOException if an input/output error occurs
- * @exception ServletException if a servlet exception occurs
+ * Dispatch to the specified method.
+ * Added to class at Revision 1.3
+ * @since 1.1
*/
- public ActionForward perform(ActionMapping mapping,
- ActionForm form,
- HttpServletRequest request,
- HttpServletResponse response)
- throws IOException, ServletException {
+ protected ActionForward dispatchMethod(ActionMapping mapping,
+ ActionForm form,
+ HttpServletRequest request,
+ HttpServletResponse response,
+ String name) throws IOException {
- // Identify the request parameter containing the method name
- String parameter = mapping.getParameter();
- if (parameter == null) {
- String message =
- messages.getMessage("dispatch.handler", mapping.getPath());
- servlet.log(message);
- response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
- message);
- return (null);
- }
-
- // Identify the method name to be dispatched to
- String name = request.getParameter(parameter);
- if (name == null) {
- String message =
- messages.getMessage("dispatch.parameter", mapping.getPath(),
- parameter);
- servlet.log(message);
- response.sendError(HttpServletResponse.SC_BAD_REQUEST,
- message);
- return (null);
- }
-
// Identify the method object to be dispatched to
Method method = null;
try {
@@ -229,7 +195,6 @@
return (null);
}
- // Dispatch to the specified method
ActionForward forward = null;
try {
Object args[] = { mapping, form, request, response };
@@ -262,6 +227,58 @@
// Return the returned ActionForward instance
return (forward);
+ }
+
+
+// --------------------------------------------------------- Public Methods
+
+
+ /**
+ * Process the specified HTTP request, and create the corresponding HTTP
+ * response (or forward to another web component that will create it).
+ * Return an <code>ActionForward</code> instance describing where and how
+ * control should be forwarded, or <code>null</code> if the response has
+ * already been completed.
+ *
+ * @param mapping The ActionMapping used to select this instance
+ * @param actionForm The optional ActionForm bean for this request (if any)
+ * @param request The HTTP request we are processing
+ * @param response The HTTP response we are creating
+ *
+ * @exception IOException if an input/output error occurs
+ * @exception ServletException if a servlet exception occurs
+ */
+ public ActionForward perform(ActionMapping mapping,
+ ActionForm form,
+ HttpServletRequest request,
+ HttpServletResponse response)
+ throws IOException, ServletException {
+
+ // Identify the request parameter containing the method name
+ String parameter = mapping.getParameter();
+ if (parameter == null) {
+ String message =
+ messages.getMessage("dispatch.handler", mapping.getPath());
+ servlet.log(message);
+ response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR,
+ message);
+ return (null);
+ }
+
+ // Identify the method name to be dispatched to
+ String name = request.getParameter(parameter);
+ if (name == null) {
+ String message =
+ messages.getMessage("dispatch.parameter", mapping.getPath(),
+ parameter);
+ servlet.log(message);
+ response.sendError(HttpServletResponse.SC_BAD_REQUEST,
+ message);
+ return (null);
+ }
+
+ // Invoke the named method, and return the result
+ return dispatchMethod(mapping,form,request,response,name);
}
1.1
jakarta-struts/src/share/org/apache/struts/actions/LookupDispatchAction.java
Index: LookupDispatchAction.java
===================================================================
/*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Struts", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.struts.actions;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.struts.action.Action;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.util.MessageResources;
/**
* <p>
*
* An abstract <strong>Action</strong> that dispatches to the subclass mapped
* perform method. This is useful in
* cases where an HTML form has multiple submit buttons with the same name. The
* button name is specified by the <code>parameter</code> property of the
* corresponding ActionMapping. To configure the use of this action in your
* <code>struts-config.xml</code> file, create an entry like this:</p> <pre>
* <action path="/test"
* type="org.example.MyAction"
* name="MyForm"
* scope="request"
* input="/test.jsp"
* parameter="action"/>
* </pre> <p>
*
* which will use the value of the request parameter named "action" to locate
* the corresponding key in ApplicationResources. For example, you might have
* the following ApplicationResources.properties:</p> <pre>
* button.add=Add Record
* button.delete=Delete Record
* </pre><p>
*
* And your JSP would have the following format for submit buttons:</p> <pre>
* <html:form action="/test">
* <html:submit property="action">
* <bean:message key="button.add"/>
* </html:submit>
* <html:submit property="action">
* <bean:message key="button.delete"/>
* </html:submit>
* </html:form>
* </pre> <p>
*
* Your subclass must implement both getKeyMethodMap and the
* methods defined in the map. An example of such implementations are:</p>
* <pre>
* protected Map getKeyMethodMap(ActionMapping mapping,
* ActionForm form,
* HttpServletRequest request) {
* Map map = new HashMap();
* map.put("button.add", "add");
* map.put("button.delete", "delete");
* return map;
* }
*
* public ActionForward add(ActionMapping mapping,
* ActionForm form,
* HttpServletRequest request,
* HttpServletResponse response)
* throws IOException, ServletException {
* // do add
* return mapping.findForward("success");
* }
*
* public ActionForward delete(ActionMapping mapping,
* ActionForm form,
* HttpServletRequest request,
* HttpServletResponse response)
* throws IOException, ServletException {
* // do delete
* return mapping.findForward("success");
* }
* <p>
*
* <strong>Notes</strong> - If duplicate values exist for the keys returned by
* getKeys, only the first one found will be returned. If no corresponding key
* is found then an exception will be thrown.
*
*@author Erik Hatcher
*@created November 14, 2001
*/
public abstract class LookupDispatchAction extends DispatchAction {
/**
* Reverse lookup map from resource value to resource key.
*/
protected Map lookupMap = null;
/**
* Resource key to method name lookup
*/
protected Map keyMethodMap = null;
// ---------------------------------------------------------- Public Methods
/**
* Process the specified HTTP request, and create the corresponding HTTP
* response (or forward to another web component that will create it).
* Return an <code>ActionForward</code> instance describing where and how
* control should be forwarded, or <code>null</code> if the response has
* already been completed.
*
*@param mapping The ActionMapping used to select this
* instance
*@param request The HTTP request we are processing
*@param response The HTTP response we are creating
*@param form The optional ActionForm bean for this
* request (if any)
*@return Describes where and how control should be
* forwarded.
*@exception IOException if an input/output error occurs
*@exception ServletException if a servlet exception occurs, mapping does
* not have a parameter attribute, or the request does not contain the
* attribute named in the mapping parameter.
*/
public ActionForward perform(
ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws IOException, ServletException {
// Identify the request parameter containing the method name
String parameter = mapping.getParameter();
if (parameter == null) {
String message = messages.getMessage("dispatch.handler",
mapping.getPath());
throw new ServletException(message);
}
// Identify the string to lookup
String name = request.getParameter(parameter);
if (name == null) {
String message =
messages.getMessage("dispatch.parameter", mapping.getPath(),
parameter);
throw new ServletException(message);
}
if (lookupMap == null) {
// Build the key lookup map
lookupMap = new HashMap();
MessageResources resources = servlet.getResources();
keyMethodMap = getKeyMethodMap();
Iterator iter = keyMethodMap.keySet().iterator();
while (iter.hasNext()) {
String key = (String) iter.next();
String text = resources.getMessage(key);
if ((text != null) && !lookupMap.containsKey(text)) {
lookupMap.put(text, key);
}
}
}
// Find the key
String key = (String) lookupMap.get(name);
String methodName = (String) keyMethodMap.get(key);
Object args[] = { mapping, form, request, response };
return dispatchMethod(mapping, form, request, response, methodName);
}
/**
* Provides the mapping from resource key to method name
*
*@return Resource key / method name map
*/
protected abstract Map getKeyMethodMap();
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
