org.apache.struts.actions
Class DispatchAction

java.lang.Object
  org.apache.struts.action.Action
      org.apache.struts.actions.BaseAction
          org.apache.struts.actions.DispatchAction

Direct Known Subclasses:

EventDispatchAction, LookupDispatchAction, MappingDispatchAction

public abstract class DispatchAction
extends BaseAction

An abstract Action that dispatches to a public method that is named by the request parameter whose name is specified by the parameter property of the corresponding ActionMapping. This Action is useful for developers who prefer to combine many similar actions into a single Action class, in order to simplify their application design.

To configure the use of this action in your struts-config.xml file, create an entry like this:

<action path="/saveSubscription" type="org.apache.struts.actions.DispatchAction" name="subscriptionForm" scope="request" input="/subscription.jsp" parameter="method"/>

which will use the value of the request parameter named "method" to pick the appropriate "execute" method, which must have the same signature (other than method name) of the standard Action.execute method. For example, you might have the following three methods in the same action:

• public ActionForward delete(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception
• public ActionForward insert(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception
• public ActionForward update(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception

and call one of the methods with a URL like this:

http://localhost:8080/myapp/saveSubscription.do?method=update

NOTE - All of the other mapping characteristics of this action must be shared by the various handlers. This places some constraints over what types of handlers may reasonably be packaged into the same DispatchAction subclass.

NOTE - If the value of the request parameter is empty, a method named unspecified is called. The default action is to throw an exception. If the request was cancelled (a html:cancel button was pressed), the custom handler cancelled will be used instead. You can also override the getMethodName method to override the action's default handler selection.

Version:

$Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $

Field Summary

protected java.lang.Class	clazz The Class instance of this DispatchAction class.
protected static org.apache.commons.logging.Log	log Commons Logging instance.
protected java.util.HashMap	methods The set of Method objects we have introspected for this class, keyed by method name.
protected java.lang.Class[]	types The set of argument type classes for the reflected method call.

Fields inherited from class org.apache.struts.actions.BaseAction

messages

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

DispatchAction()

Method Summary

protected org.apache.struts.action.ActionForward	cancelled(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method which is dispatched to when the request is a cancel button submit.
protected org.apache.struts.action.ActionForward	dispatchMethod(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String name) Dispatch to the specified method.
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Process the specified HTTP request, and create the corresponding HTTP response (or forward to another web component that will create it).
protected java.lang.reflect.Method	getMethod(java.lang.String name) Introspect the current class to identify a method of the specified name that accepts the same parameter types as the execute method does.
protected java.lang.String	getMethodName(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String parameter) Returns the method name, given a parameter's value.
protected java.lang.String	getParameter(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Returns the parameter value.
protected org.apache.struts.action.ActionForward	unspecified(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method which is dispatched to when there is no value for specified request parameter included in the request.

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.apache.commons.logging.Log log

Commons Logging instance.

clazz

protected java.lang.Class clazz

The Class instance of this DispatchAction class.

methods

protected java.util.HashMap methods

The set of Method objects we have introspected for this class, keyed by method name. This collection is populated as different methods are called, so that introspection needs to occur only once per method name.

types

protected java.lang.Class[] types

The set of argument type classes for the reflected method call. These are the same for all calls, so calculate them only once.

Constructor Detail

DispatchAction

public DispatchAction()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws java.lang.Exception

Process the specified HTTP request, and create the corresponding HTTP response (or forward to another web component that will create it). Return an ActionForward instance describing where and how control should be forwarded, or null if the response has already been completed.

Overrides:

execute in class org.apache.struts.action.Action

Parameters:

mapping - The ActionMapping used to select this instance

form - The optional ActionForm bean for this request (if any)

request - The HTTP request we are processing

response - The HTTP response we are creating

Returns:

The forward to which control should be transferred, or null if the response has been completed.

Throws:

java.lang.Exception - if an exception occurs

unspecified

protected org.apache.struts.action.ActionForward unspecified(org.apache.struts.action.ActionMapping mapping,
                                                             org.apache.struts.action.ActionForm form,
                                                             javax.servlet.http.HttpServletRequest request,
                                                             javax.servlet.http.HttpServletResponse response)
                                                      throws java.lang.Exception

Method which is dispatched to when there is no value for specified request parameter included in the request. Subclasses of DispatchAction should override this method if they wish to provide default behavior different than throwing a ServletException.

Parameters:

mapping - The ActionMapping used to select this instance

form - The optional ActionForm bean for this request (if any)

request - The non-HTTP request we are processing

response - The non-HTTP response we are creating

Returns:

The forward to which control should be transferred, or null if the response has been completed.

Throws:

java.lang.Exception - if the application business logic throws an exception.

cancelled

protected org.apache.struts.action.ActionForward cancelled(org.apache.struts.action.ActionMapping mapping,
                                                           org.apache.struts.action.ActionForm form,
                                                           javax.servlet.http.HttpServletRequest request,
                                                           javax.servlet.http.HttpServletResponse response)
                                                    throws java.lang.Exception

Method which is dispatched to when the request is a cancel button submit. Subclasses of DispatchAction should override this method if they wish to provide default behavior different than returning null.

Parameters:

mapping - The ActionMapping used to select this instance

form - The optional ActionForm bean for this request (if any)

request - The non-HTTP request we are processing

response - The non-HTTP response we are creating

Returns:

The forward to which control should be transferred, or null if the response has been completed.

Throws:

java.lang.Exception - if the application business logic throws an exception.

Since:

Struts 1.2.0

dispatchMethod

protected org.apache.struts.action.ActionForward dispatchMethod(org.apache.struts.action.ActionMapping mapping,
                                                                org.apache.struts.action.ActionForm form,
                                                                javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response,
                                                                java.lang.String name)
                                                         throws java.lang.Exception

Dispatch to the specified method.

Parameters:

mapping - The ActionMapping used to select this instance

form - The optional ActionForm bean for this request (if any)

request - The non-HTTP request we are processing

response - The non-HTTP response we are creating

name - The name of the method to invoke

Returns:

The forward to which control should be transferred, or null if the response has been completed.

Throws:

java.lang.Exception - if the application business logic throws an exception.

Since:

Struts 1.1

getParameter

protected java.lang.String getParameter(org.apache.struts.action.ActionMapping mapping,
                                        org.apache.struts.action.ActionForm form,
                                        javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response)
                                 throws java.lang.Exception

Returns the parameter value.

Parameters:

mapping - The ActionMapping used to select this instance

form - The optional ActionForm bean for this request (if any)

request - The HTTP request we are processing

response - The HTTP response we are creating

Returns:

The ActionMapping parameter's value

Throws:

java.lang.Exception - if the parameter is missing.

getMethod

protected java.lang.reflect.Method getMethod(java.lang.String name)
                                      throws java.lang.NoSuchMethodException

Introspect the current class to identify a method of the specified name that accepts the same parameter types as the execute method does.

Parameters:

name - Name of the method to be introspected

Returns:

The method with the specified name.

Throws:

java.lang.NoSuchMethodException - if no such method can be found

getMethodName

protected java.lang.String getMethodName(org.apache.struts.action.ActionMapping mapping,
                                         org.apache.struts.action.ActionForm form,
                                         javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response,
                                         java.lang.String parameter)
                                  throws java.lang.Exception

Returns the method name, given a parameter's value.

Parameters:

mapping - The ActionMapping used to select this instance

form - The optional ActionForm bean for this request (if any)

request - The HTTP request we are processing

response - The HTTP response we are creating

parameter - The ActionMapping parameter's name

Returns:

The method's name.

Throws:

java.lang.Exception - if an error occurs.

Since:

Struts 1.2.0