public abstract class LookupDispatchAction extends DispatchAction
An abstract Action that dispatches to the subclass
mapped execute
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 parameter
property of the corresponding
ActionMapping. To configure the use of this action in your
struts-config.xml
file, create an entry like this:
<action path="/test" type="org.example.MyAction" name="MyForm" scope="request" input="/test.jsp" parameter="method"/>
which will use the value of the request parameter named "method" to locate the corresponding key in ApplicationResources. For example, you might have the following ApplicationResources.properties:
button.add=Add Record button.delete=Delete Record
And your JSP would have the following format for submit buttons:
<html:form action="/test"> <html:submit property="method"> <bean:message key="button.add"/> </html:submit> <html:submit property="method"> <bean:message key="button.delete"/> </html:submit> </html:form>
Your subclass must implement both getKeyMethodMap and the methods defined in the map. An example of such implementations are:
protected Map getKeyMethodMap() { 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"); }
Notes - 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. You can
override the method unspecified
to provide a custom handler.
If the submit was cancelled (a html:cancel
button was
pressed), the custom handler cancelled
will be used instead.
Modifier and Type | Field and Description |
---|---|
protected Map |
keyMethodMap
Resource key to method name lookup.
|
protected Map |
localeMap
Reverse lookup map from resource value to resource key.
|
clazz, log, methods, types
messages
Constructor and Description |
---|
LookupDispatchAction() |
Modifier and Type | Method and Description |
---|---|
ActionForward |
execute(ActionMapping mapping,
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 abstract Map |
getKeyMethodMap()
Provides the mapping from resource key to method name.
|
protected String |
getLookupMapName(javax.servlet.http.HttpServletRequest request,
String keyName,
ActionMapping mapping)
Lookup the method name corresponding to the client request's locale.
|
protected String |
getMethodName(ActionMapping mapping,
ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String parameter)
Returns the method name, given a parameter's value.
|
cancelled, dispatchMethod, getMethod, getParameter, unspecified
addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet
protected Map localeMap
protected Map keyMethodMap
public ActionForward execute(ActionMapping mapping, ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
ActionForward
instance describing where and how
control should be forwarded, or null
if the response has
already been completed.execute
in class DispatchAction
mapping
- The ActionMapping used to select this instancerequest
- The HTTP request we are processingresponse
- The HTTP response we are creatingform
- The optional ActionForm bean for this request (if any)Exception
- if an error occursprotected abstract Map getKeyMethodMap()
protected String getLookupMapName(javax.servlet.http.HttpServletRequest request, String keyName, ActionMapping mapping) throws javax.servlet.ServletException
request
- The HTTP request we are processingkeyName
- The parameter name to use as the properties keymapping
- The ActionMapping used to select this instancejavax.servlet.ServletException
- if keyName cannot be resolvedprotected String getMethodName(ActionMapping mapping, ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String parameter) throws Exception
getMethodName
in class DispatchAction
mapping
- The ActionMapping used to select this instanceform
- The optional ActionForm bean for this request (if
any)request
- The HTTP request we are processingresponse
- The HTTP response we are creatingparameter
- The ActionMapping
parameter's nameException
- if an error occursCopyright © 2000–2016 Apache Software Foundation. All rights reserved.