Author: mrdon
Date: Sat Sep 23 23:50:57 2006
New Revision: 449368
URL: http://svn.apache.org/viewvc?view=rev&rev=449368
Log:
Reformatting default action mapper
WW-1349
Modified:
struts/struts2/trunk/core/src/main/java/org/apache/struts2/dispatcher/mapper/DefaultActionMapper.java
Modified:
struts/struts2/trunk/core/src/main/java/org/apache/struts2/dispatcher/mapper/DefaultActionMapper.java
URL:
http://svn.apache.org/viewvc/struts/struts2/trunk/core/src/main/java/org/apache/struts2/dispatcher/mapper/DefaultActionMapper.java?view=diff&rev=449368&r1=449367&r2=449368
==============================================================================
---
struts/struts2/trunk/core/src/main/java/org/apache/struts2/dispatcher/mapper/DefaultActionMapper.java
(original)
+++
struts/struts2/trunk/core/src/main/java/org/apache/struts2/dispatcher/mapper/DefaultActionMapper.java
Sat Sep 23 23:50:57 2006
@@ -36,130 +36,146 @@
/**
* <!-- START SNIPPET: javadoc -->
- *
- * Default action mapper implementation, using the standard *.[ext] (where ext
usually "action") pattern. The extension
- * is looked up from the Struts configuration key
<b>struts.action.exection</b>.
- *
- * <p/> To help with dealing with buttons and other related requirements, this
mapper (and other [EMAIL PROTECTED] 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:
- *
+ *
+ * Default action mapper implementation, using the standard *.[ext] (where ext
+ * usually "action") pattern. The extension is looked up from the Struts
+ * configuration key <b>struts.action.exection</b>.
+ *
+ * <p/> To help with dealing with buttons and other related requirements, this
+ * mapper (and other [EMAIL PROTECTED] 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:
+ *
* <ul>
- *
+ *
* <li>Method prefix - <i>method:default</i></li>
- *
+ *
* <li>Action prefix - <i>action:dashboard</i></li>
- *
+ *
* <li>Redirect prefix - <i>redirect:cancel.jsp</i></li>
- *
+ *
* <li>Redirect-action prefix - <i>redirect-action:cancel</i></li>
- *
+ *
* </ul>
- *
- * <p/> In addition to these four prefixes, this mapper also understands the
action naming pattern of <i>foo!bar</i> 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 <i>foo</i> and the method <i>bar</i>.
- *
+ *
+ * <p/> In addition to these four prefixes, this mapper also understands the
+ * action naming pattern of <i>foo!bar</i> 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 <i>foo</i> and the method <i>bar</i>.
+ *
* <!-- END SNIPPET: javadoc -->
- *
+ *
* <p/> <b>Method Prefix</b> <p/>
- *
+ *
* <!-- START SNIPPET: method -->
- *
- * 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.
- *
+ *
+ * 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.
+ *
* <!-- END SNIPPET: method -->
- *
+ *
* <pre>
- * <!-- 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 -->
+ * <!-- 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 -->
* </pre>
- *
+ *
* <p/> <b>Action prefix</b> <p/>
- *
+ *
* <!-- START SNIPPET: action -->
- *
- * 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.
- *
+ *
+ * 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.
+ *
* <!-- END SNIPPET: action -->
- *
+ *
* <pre>
- * <!-- 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 -->
+ * <!-- 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 -->
* </pre>
- *
+ *
* <p/> <b>Redirect prefix</b> <p/>
- *
+ *
* <!-- START SNIPPET: redirect -->
- *
- * 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
+ *
+ * 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.
- *
+ *
* <!-- END SNIPPET: redirect -->
- *
+ *
* <pre>
- * <!-- 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 -->
+ * <!-- 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 -->
* </pre>
- *
+ *
* <p/> <b>Redirect-action prefix</b> <p/>
- *
+ *
* <!-- START SNIPPET: redirect-action -->
- *
- * 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.
- *
+ *
+ * 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.
+ *
* <!-- END SNIPPET: redirect-action -->
- *
+ *
* <pre>
- * <!-- 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 -->
+ * <!-- 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 -->
* </pre>
- *
+ *
*/
public class DefaultActionMapper implements ActionMapper {
static final String METHOD_PREFIX = "method:";
+
static final String ACTION_PREFIX = "action:";
+
static final String REDIRECT_PREFIX = "redirect:";
+
static final String REDIRECT_ACTION_PREFIX = "redirect-action:";
- private static boolean allowDynamicMethodCalls =
"true".equals(Settings.get(StrutsConstants.STRUTS_ENABLE_DYNAMIC_METHOD_INVOCATION));
+ private static boolean allowDynamicMethodCalls = "true".equals(Settings
+ .get(StrutsConstants.STRUTS_ENABLE_DYNAMIC_METHOD_INVOCATION));
private PrefixTrie prefixTrie = null;
+
public DefaultActionMapper() {
prefixTrie = new PrefixTrie() {
{
put(METHOD_PREFIX, new ParameterAction() {
public void execute(String key, ActionMapping mapping) {
-
mapping.setMethod(key.substring(METHOD_PREFIX.length()));
+ mapping
+ .setMethod(key
+ .substring(METHOD_PREFIX.length()));
}
});
@@ -181,14 +197,16 @@
put(REDIRECT_PREFIX, new ParameterAction() {
public void execute(String key, ActionMapping mapping) {
ServletRedirectResult redirect = new
ServletRedirectResult();
-
redirect.setLocation(key.substring(REDIRECT_PREFIX.length()));
+ redirect.setLocation(key.substring(REDIRECT_PREFIX
+ .length()));
mapping.setResult(redirect);
}
});
-
+
put(REDIRECT_ACTION_PREFIX, new ParameterAction() {
public void execute(String key, ActionMapping mapping) {
- String location =
key.substring(REDIRECT_ACTION_PREFIX.length());
+ String location = key.substring(REDIRECT_ACTION_PREFIX
+ .length());
ServletRedirectResult redirect = new
ServletRedirectResult();
String extension = getDefaultExtension();
if (extension != null) {
@@ -202,10 +220,13 @@
};
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see
org.apache.struts2.dispatcher.mapper.ActionMapper#getMapping(javax.servlet.http.HttpServletRequest)
*/
- public ActionMapping getMapping(HttpServletRequest request,
ConfigurationManager configManager) {
+ public ActionMapping getMapping(HttpServletRequest request,
+ ConfigurationManager configManager) {
ActionMapping mapping = new ActionMapping();
String uri = getUri(request);
@@ -213,7 +234,7 @@
if (uri == null) {
return null;
}
-
+
parseNameAndNamespace(uri, mapping, configManager.getConfiguration());
handleSpecialParameters(request, mapping);
@@ -236,18 +257,23 @@
}
/**
- * Special parameters, as described in the class-level comment, are
searched for
- * and handled.
+ * Special parameters, as described in the class-level comment, are
searched
+ * for and handled.
*
- * @param request The request
- * @param mapping The action mapping
+ * @param request
+ * The request
+ * @param mapping
+ * The action mapping
*/
- public void handleSpecialParameters(HttpServletRequest request,
ActionMapping mapping) {
+ public void handleSpecialParameters(HttpServletRequest request,
+ ActionMapping mapping) {
// handle special parameter prefixes.
Map parameterMap = request.getParameterMap();
- for (Iterator iterator = parameterMap.keySet().iterator();
iterator.hasNext();) {
+ for (Iterator iterator = parameterMap.keySet().iterator(); iterator
+ .hasNext();) {
String key = (String) iterator.next();
- ParameterAction parameterAction = (ParameterAction)
prefixTrie.get(key);
+ ParameterAction parameterAction = (ParameterAction) prefixTrie
+ .get(key);
if (parameterAction != null) {
parameterAction.execute(key, mapping);
break;
@@ -258,17 +284,21 @@
/**
* Parses the name and namespace from the uri
*
- * @param uri The uri
- * @param mapping The action mapping to populate
+ * @param uri
+ * The uri
+ * @param mapping
+ * The action mapping to populate
*/
- void parseNameAndNamespace(String uri, ActionMapping mapping,
Configuration config) {
+ void parseNameAndNamespace(String uri, ActionMapping mapping,
+ Configuration config) {
String namespace, name;
int lastSlash = uri.lastIndexOf("/");
if (lastSlash == -1) {
namespace = "";
name = uri;
} else if (lastSlash == 0) {
- // ww-1046, assume it is the root namespace, it will fallback to
default
+ // ww-1046, assume it is the root namespace, it will fallback to
+ // default
// namespace anyway if not found in root namespace.
namespace = "/";
name = uri.substring(lastSlash + 1);
@@ -276,15 +306,16 @@
String prefix = uri.substring(0, lastSlash);
namespace = "";
// Find the longest matching namespace, defaulting to the default
- for (Iterator i = config.getPackageConfigs().values().iterator();
i.hasNext(); ) {
- String ns = ((PackageConfig)i.next()).getNamespace();
+ for (Iterator i = config.getPackageConfigs().values().iterator(); i
+ .hasNext();) {
+ String ns = ((PackageConfig) i.next()).getNamespace();
if (ns != null && prefix.startsWith(ns)) {
if (ns.length() > namespace.length()) {
namespace = ns;
}
}
}
-
+
name = uri.substring(namespace.length() + 1);
}
mapping.setNamespace(namespace);
@@ -294,23 +325,24 @@
/**
* Drops the extension from the action name
*
- * @param name The action name
+ * @param name
+ * The action name
* @return The action name without its extension
*/
String dropExtension(String name) {
- List extensions = getExtensions();
- if (extensions == null) {
- return name;
- }
- Iterator it = extensions.iterator();
- while (it.hasNext()) {
- String extension = "." + (String) it.next();
- if ( name.endsWith(extension)) {
- name = name.substring(0, name.length() -
extension.length());
- return name;
- }
- }
- return null;
+ List extensions = getExtensions();
+ if (extensions == null) {
+ return name;
+ }
+ Iterator it = extensions.iterator();
+ while (it.hasNext()) {
+ String extension = "." + (String) it.next();
+ if (name.endsWith(extension)) {
+ name = name.substring(0, name.length() - extension.length());
+ return name;
+ }
+ }
+ return null;
}
/**
@@ -319,34 +351,37 @@
static String getDefaultExtension() {
List extensions = getExtensions();
if (extensions == null) {
- return null;
+ return null;
} else {
- return (String) extensions.get(0);
+ return (String) extensions.get(0);
}
}
-
+
/**
* Returns null if no extension is specified.
*/
static List getExtensions() {
- String extensions = (String)
org.apache.struts2.config.Settings.get(StrutsConstants.STRUTS_ACTION_EXTENSION);
+ String extensions = (String) org.apache.struts2.config.Settings
+ .get(StrutsConstants.STRUTS_ACTION_EXTENSION);
if ("".equals(extensions)) {
- return null;
+ return null;
} else {
- return Arrays.asList(extensions.split(","));
- }
+ return Arrays.asList(extensions.split(","));
+ }
}
/**
* Gets the uri from the request
*
- * @param request The request
+ * @param request
+ * The request
* @return The uri
*/
String getUri(HttpServletRequest request) {
// handle http dispatcher includes.
- String uri = (String)
request.getAttribute("javax.servlet.include.servlet_path");
+ String uri = (String) request
+ .getAttribute("javax.servlet.include.servlet_path");
if (uri != null) {
return uri;
}
@@ -360,19 +395,21 @@
return uri.substring(request.getContextPath().length());
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see
org.apache.struts2.dispatcher.mapper.ActionMapper#getUriFromActionMapping(org.apache.struts2.dispatcher.mapper.ActionMapping)
*/
public String getUriFromActionMapping(ActionMapping mapping) {
StringBuffer uri = new StringBuffer();
uri.append(mapping.getNamespace());
- if(!"/".equals(mapping.getNamespace())) {
+ if (!"/".equals(mapping.getNamespace())) {
uri.append("/");
}
String name = mapping.getName();
String params = "";
- if ( name.indexOf('?') != -1) {
+ if (name.indexOf('?') != -1) {
params = name.substring(name.indexOf('?'));
name = name.substring(0, name.indexOf('?'));
}
@@ -383,10 +420,10 @@
}
String extension = getDefaultExtension();
- if ( extension != null) {
- if (uri.indexOf( '.' + extension) == -1 ) {
+ if (extension != null) {
+ if (uri.indexOf('.' + extension) == -1) {
uri.append(".").append(extension);
- if ( params.length() > 0) {
+ if (params.length() > 0) {
uri.append(params);
}
}
