org.apache.struts2.dispatcher.mapper
Class DefaultActionMapper

java.lang.Object
  extended by org.apache.struts2.dispatcher.mapper.DefaultActionMapper
All Implemented Interfaces:
ActionMapper

public class DefaultActionMapper
extends java.lang.Object
implements ActionMapper

Default action mapper implementation, using the standard *.[ext] (where ext usually "action") pattern. The extension is looked up from the Struts configuration key struts.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:

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 struts.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.

  <!-- START SNIPPET: method-example -->
  <a:form action="baz">
      <a:textfield label="Enter your name" name="person.name"/>
      <a:submit value="Create person"/>
      <a:submit name="method:anotherMethod" value="Cancel"/>
  </a:form>
  <!-- END SNIPPET: method-example -->
 

Action prefix

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

  <!-- START SNIPPET: action-example -->
  <a:form action="baz">
      <a:textfield label="Enter your name" name="person.name"/>
      <a:submit value="Create person"/>
      <a:submit name="action:anotherAction" value="Cancel"/>
  </a:form>
  <!-- END SNIPPET: action-example -->
 

Redirect prefix

With redirect-prefix, instead of executing baz action's execute() method (by default it isn't overriden in struts.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.

  <!-- START SNIPPET: redirect-example -->
  <a:form action="baz">
      <a:textfield label="Enter your name" name="person.name"/>
      <a:submit value="Create person"/>
      <a:submit name="redirect:www.google.com" value="Cancel"/>
  </a:form>
  <!-- END SNIPPET: redirect-example -->
 

Redirect-action prefix

With redirect-action-prefix, instead of executing baz action's execute() method (by default it isn't overriden in struts.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 struts.properties.

  <!-- START SNIPPET: redirect-action-example -->
  <a:form action="baz">
      <a:textfield label="Enter your name" name="person.name"/>
      <a:submit value="Create person"/>
      <a:submit name="redirect-action:dashboard" value="Cancel"/>
  </a:form>
  <!-- END SNIPPET: redirect-action-example -->
 


Constructor Summary
DefaultActionMapper()
           
 
Method Summary
 ActionMapping getMapping(javax.servlet.http.HttpServletRequest request, com.opensymphony.xwork2.config.ConfigurationManager configManager)
          Gets an action mapping for the current request
 java.lang.String getUriFromActionMapping(ActionMapping mapping)
          Converts an ActionMapping into a URI string
 void handleSpecialParameters(javax.servlet.http.HttpServletRequest request, ActionMapping mapping)
          Special parameters, as described in the class-level comment, are searched for and handled.
 
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(javax.servlet.http.HttpServletRequest request,
                                com.opensymphony.xwork2.config.ConfigurationManager configManager)
Description copied from interface: ActionMapper
Gets an action mapping for the current request

Specified by:
getMapping in interface ActionMapper
Parameters:
request - The servlet request
Returns:
The appropriate action mapping

handleSpecialParameters

public void handleSpecialParameters(javax.servlet.http.HttpServletRequest request,
                                    ActionMapping mapping)
Special parameters, as described in the class-level comment, are searched for and handled.

Parameters:
request - The request
mapping - The action mapping

getUriFromActionMapping

public java.lang.String getUriFromActionMapping(ActionMapping mapping)
Description copied from interface: ActionMapper
Converts an ActionMapping into a URI string

Specified by:
getUriFromActionMapping in interface ActionMapper
Parameters:
mapping - The action mapping
Returns:
The URI string that represents this mapping


Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.