|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.struts2.dispatcher.mapper.DefaultActionMapper
public class DefaultActionMapper
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.extension. To help with dealing with buttons and other related requirements, this mapper (and other
ActionMapper
s, 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:
<!-- START SNIPPET: method-example --> <s:form action="baz"> <s:textfield label="Enter your name" name="person.name"/> <s:submit value="Create person"/> <s:submit name="method:anotherMethod" value="Cancel"/> </s: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 --> <s:form action="baz"> <s:textfield label="Enter your name" name="person.name"/> <s:submit value="Create person"/> <s:submit name="action:anotherAction" value="Cancel"/> </s: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 --> <s:form action="baz"> <s:textfield label="Enter your name" name="person.name"/> <s:submit value="Create person"/> <s:submit name="redirect:www.google.com" value="Cancel"/> </s: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 --> <s:form action="baz"> <s:textfield label="Enter your name" name="person.name"/> <s:submit value="Create person"/> <s:submit name="redirectAction:dashboard" value="Cancel"/> </s:form> <!-- END SNIPPET: redirect-action-example -->
Field Summary | |
---|---|
protected static java.lang.String |
ACTION_PREFIX
|
protected boolean |
allowDynamicMethodCalls
|
protected boolean |
allowSlashesInActionNames
|
protected boolean |
alwaysSelectFullNamespace
|
protected Container |
container
|
protected java.util.List<java.lang.String> |
extensions
|
protected static java.lang.String |
METHOD_PREFIX
|
protected PrefixTrie |
prefixTrie
|
protected static java.lang.String |
REDIRECT_ACTION_PREFIX
|
protected static java.lang.String |
REDIRECT_PREFIX
|
Constructor Summary | |
---|---|
DefaultActionMapper()
|
Method Summary | |
---|---|
protected void |
addParameterAction(java.lang.String prefix,
ParameterAction parameterAction)
Adds a parameter action. |
protected java.lang.String |
dropExtension(java.lang.String name)
Deprecated. Since 2.1, use dropExtension(java.lang.String,org.apache.struts2.dispatcher.mapper.ActionMapping) instead |
protected java.lang.String |
dropExtension(java.lang.String name,
ActionMapping mapping)
Drops the extension from the action name, storing it in the mapping for later use |
protected java.lang.String |
getDefaultExtension()
Returns null if no extension is specified. |
ActionMapping |
getMapping(javax.servlet.http.HttpServletRequest request,
ConfigurationManager configManager)
Expose the ActionMapping for the current request |
ActionMapping |
getMappingFromActionName(java.lang.String actionName)
Expose the ActionMapping for the specified action name |
protected java.lang.String |
getUri(javax.servlet.http.HttpServletRequest request)
Gets the uri from the request |
java.lang.String |
getUriFromActionMapping(ActionMapping mapping)
Convert 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. |
boolean |
isSlashesInActionNames()
|
protected ActionMapping |
parseActionName(ActionMapping mapping)
|
protected void |
parseNameAndNamespace(java.lang.String uri,
ActionMapping mapping,
ConfigurationManager configManager)
Parses the name and namespace from the uri |
void |
setAllowDynamicMethodCalls(java.lang.String allow)
|
void |
setAlwaysSelectFullNamespace(java.lang.String val)
|
void |
setContainer(Container container)
|
void |
setExtensions(java.lang.String extensions)
|
void |
setSlashesInActionNames(java.lang.String allow)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.String METHOD_PREFIX
protected static final java.lang.String ACTION_PREFIX
protected static final java.lang.String REDIRECT_PREFIX
protected static final java.lang.String REDIRECT_ACTION_PREFIX
protected boolean allowDynamicMethodCalls
protected boolean allowSlashesInActionNames
protected boolean alwaysSelectFullNamespace
protected PrefixTrie prefixTrie
protected java.util.List<java.lang.String> extensions
protected Container container
Constructor Detail |
---|
public DefaultActionMapper()
Method Detail |
---|
protected void addParameterAction(java.lang.String prefix, ParameterAction parameterAction)
prefix
- The string prefix to trigger the actionparameterAction
- The parameter action to executepublic void setAllowDynamicMethodCalls(java.lang.String allow)
public void setSlashesInActionNames(java.lang.String allow)
public void setAlwaysSelectFullNamespace(java.lang.String val)
public void setContainer(Container container)
public void setExtensions(java.lang.String extensions)
public ActionMapping getMappingFromActionName(java.lang.String actionName)
ActionMapper
getMappingFromActionName
in interface ActionMapper
actionName
- The name of the action that may have other information embedded in it
public ActionMapping getMapping(javax.servlet.http.HttpServletRequest request, ConfigurationManager configManager)
ActionMapper
getMapping
in interface ActionMapper
request
- The servlet requestconfigManager
- The current configuration manager
protected ActionMapping parseActionName(ActionMapping mapping)
public void handleSpecialParameters(javax.servlet.http.HttpServletRequest request, ActionMapping mapping)
request
- The requestmapping
- The action mappingprotected void parseNameAndNamespace(java.lang.String uri, ActionMapping mapping, ConfigurationManager configManager)
uri
- The urimapping
- The action mapping to populateprotected java.lang.String dropExtension(java.lang.String name)
dropExtension(java.lang.String,org.apache.struts2.dispatcher.mapper.ActionMapping)
instead
name
- The action name
protected java.lang.String dropExtension(java.lang.String name, ActionMapping mapping)
name
- The action namemapping
- The action mapping to store the extension in
protected java.lang.String getDefaultExtension()
protected java.lang.String getUri(javax.servlet.http.HttpServletRequest request)
request
- The request
public java.lang.String getUriFromActionMapping(ActionMapping mapping)
ActionMapper
getUriFromActionMapping
in interface ActionMapper
mapping
- The action mapping
public boolean isSlashesInActionNames()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |