com.opensymphony.webwork.dispatcher.mapper
Class DefaultActionMapper

java.lang.Object
  com.opensymphony.webwork.dispatcher.mapper.DefaultActionMapper

All Implemented Interfaces:

ActionMapper

public class DefaultActionMapper
extends Object
implements ActionMapper

Default action mapper implementation, using the standard *.[ext] (where ext usually "action") pattern. The extension is looked up from the WebWork configuration key webwork.action.exection.

To help with dealing with buttons and other related requirements, this mapper (and other ActionMappers, we hope) has the ability to name a button with some predefined prefix and have that button name alter the execution behaviour. The four prefixes are:

• Method prefix - method:default
• Action prefix - action:dashboard
• Redirect prefix - redirect:cancel.jsp
• Redirect-action prefix - redirect-action:cancel

In addition to these four prefixes, this mapper also understands the action naming pattern of foo!bar in either the extension form (eg: foo!bar.action) or in the prefix form (eg: action:foo!bar). This syntax tells this mapper to map to the action named foo and the method bar.

Method Prefix

With method-prefix, instead of calling baz action's execute() method (by default if it isn't overriden in xwork.xml to be something else), the baz action's anotherMethod() will be called. A very elegant way determine which button is clicked. Alternatively, one would have submit button set a particular value on the action when clicked, and the execute() method decides on what to do with the setted value depending on which button is clicked.

 
 <ww:form action="baz">
     <ww:textfield label="Enter your name" name="person.name"/>
     <ww:submit value="Create person"/>
     <ww:submit name="method:anotherMethod" value="Cancel"/>
 </ww:form>
 
 

Action prefix

With action-prefix, instead of executing baz action's execute() method (by default if it isn't overriden in xwork.xml to be something else), the anotherAction action's execute() method (assuming again if it isn't overriden with something else in xwork.xml) will be executed.

 
 <ww:form action="baz">
     <ww:textfield label="Enter your name" name="person.name"/>
     <ww:submit value="Create person"/>
     <ww:submit name="action:anotherAction" value="Cancel"/>
 </ww:form>
 
 

Redirect prefix

With redirect-prefix, instead of executing baz action's execute() method (by default it isn't overriden in xwork.xml to be something else), it will get redirected to, in this case to www.google.com. Internally it uses ServletRedirectResult to do the task.

 
 <ww:form action="baz">
     <ww:textfield label="Enter your name" name="person.name"/>
     <ww:submit value="Create person"/>
     <ww:submit name="redirect:www.google.com" value="Cancel"/>
 </ww:form>
 
 

Redirect-action prefix

With redirect-action-prefix, instead of executing baz action's execute() method (by default it isn't overriden in xwork.xml to be something else), it will get redirected to, in this case 'dashboard.action'. Internally it uses ServletRedirectResult to do the task and read off the extension from the webwork.properties.

 
 <ww:form action="baz">
     <ww:textfield label="Enter your name" name="person.name"/>
     <ww:submit value="Create person"/>
     <ww:submit name="redirect-action:dashboard" value="Cancel"/>
 </ww:form>
 
 

Version:

$Date: 2007-11-12 23:50:43 +0800 (Mon, 12 Nov 2007) $ $Id: DefaultActionMapper.java 2962 2007-11-12 15:50:43Z tm_jee $

Author:

Patrick Lightbody, tm_jee

Constructor Summary

DefaultActionMapper()

Method Summary

ActionMapping	getMapping(HttpServletRequest request) Return the ActionMapping for the given HttpServletRequest, the format of HttpServletRequest url depends on the implementation of ActionMapper, eg.
String	getUriFromActionMapping(ActionMapping mapping) Return the uri of the ActionMapping passed in as the argument.
protected void	handleSpecialParameters(HttpServletRequest request, ActionMapping mapping) Extension hook, that handle special parameters, namely those with prefix eg.
protected void	parseNameAndNamespace(String uri, ActionMapping mapping)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultActionMapper

public DefaultActionMapper()

Method Detail

getMapping

public ActionMapping getMapping(HttpServletRequest request)

Description copied from interface: ActionMapper

Return the ActionMapping for the given HttpServletRequest, the format of HttpServletRequest url depends on the implementation of ActionMapper, eg. a RestfulActionMapper might handle it differently from DefaultActionMapper.

Implementation should return null if it cannot handle the format of request (eg. if it is bad etc.) such that we could cascade ActionMapping together using CompositeActionMapper

Specified by:

getMapping in interface ActionMapper

Returns:

ActionMapping

handleSpecialParameters

protected void handleSpecialParameters(HttpServletRequest request,
                                       ActionMapping mapping)

Extension hook, that handle special parameters, namely those with prefix eg.

• action:someAction
• method:someMethod
• redirect:http://www.google.com
• redirect-action:someRedirectAction

Parameters:

request -

mapping -

parseNameAndNamespace

protected void parseNameAndNamespace(String uri,
                                     ActionMapping mapping)

getUriFromActionMapping

public String getUriFromActionMapping(ActionMapping mapping)

Description copied from interface: ActionMapper

Return the uri of the ActionMapping passed in as the argument.

Implementation should return null if it cannot handle the format of request (eg. if it is bad etc.) such that we could cascade ActionMapping together using CompositeActionMapper

The parameter mapping is an instance of ActionMappingEx.

Specified by:

getUriFromActionMapping in interface ActionMapper

Returns:

String