com.opensymphony.xwork.interceptor
Class ParametersInterceptor
java.lang.Object
com.opensymphony.xwork.interceptor.AroundInterceptor
com.opensymphony.xwork.interceptor.ParametersInterceptor
- All Implemented Interfaces:
- Interceptor, Serializable
public class ParametersInterceptor
- extends AroundInterceptor
This interceptor sets all parameters on the value stack.
This interceptor gets all parameters from ActionContext.getParameters()
and sets them on the value stack by
calling OgnlValueStack.setValue(String, Object)
, typically resulting in the values submitted in a form
request being applied to an action in the value stack. Note that the parameter map must contain a String key and
often containers a String[] for the value.
Because parameter names are effectively OGNL statements, it is important that security be taken in to account.
This interceptor will not apply any values in the parameters map if the expression contains an assignment (=),
multiple expressions (,), or references any objects in the context (#). This is all done in the acceptableName(String)
method. In addition to this method, if the action being invoked implements the ParameterNameAware
interface, the action will be consulted to determine if the parameter should be set.
In addition to these restrictions, a flag (XWorkMethodAccessor.DENY_METHOD_EXECUTION
) is set such that
no methods are allowed to be invoked. That means that any expression such as person.doSomething() or
person.getName() will be explicitely forbidden. This is needed to make sure that your application is not
exposed to attacks by malicious users.
While this interceptor is being invoked, a flag (InstantiatingNullHandler.CREATE_NULL_OBJECTS
) is turned
on to ensure that any null reference is automatically created - if possible. See the type conversion documentation
and the InstantiatingNullHandler
javadocs for more information.
Finally, a third flag (XWorkConverter.REPORT_CONVERSION_ERRORS
) is set that indicates any errors when
converting the the values to their final data type (String[] -> int) an unrecoverable error occured. With this
flag set, the type conversion errors will be reported in the action context. See the type conversion documentation
and the XWorkConverter
javadocs for more information.
If you are looking for detailed logging information about your parameters, turn on DEBUG level logging for this
interceptor. A detailed log of all the parameter keys and values will be reported.
Interceptor parameters:
Extending the interceptor:
The best way to add behavior to this interceptor is to utilize the ParameterNameAware
interface in your
actions. However, if you wish to apply a global rule that isn't implemented in your action, then you could extend
this interceptor and override the acceptableName(String)
method.
Example code:
<action name="someAction" class="com.examples.SomeAction">
<interceptor-ref name="params"/>
<result name="success">good_result.ftl</result>
</action>
- Version:
- $Date: 2007-05-30 22:05:34 -0500 (Wed, 30 May 2007) $ $Id: ParametersInterceptor.java 1530 2007-05-31 03:05:34Z tm_jee $
- Author:
- Patrick Lightbody, tmjee
- See Also:
- Serialized Form
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ParametersInterceptor
public ParametersInterceptor()
after
protected void after(ActionInvocation dispatcher,
String result)
throws Exception
- Description copied from class:
AroundInterceptor
- Called after the invocation has been executed.
- Specified by:
after
in class AroundInterceptor
result
- the result value returned by the invocation
- Throws:
Exception
before
protected void before(ActionInvocation invocation)
throws Exception
- Description copied from class:
AroundInterceptor
- Called before the invocation has been executed.
- Specified by:
before
in class AroundInterceptor
- Throws:
Exception
setParameters
protected void setParameters(Object action,
OgnlValueStack stack,
Map parameters)
acceptableName
protected boolean acceptableName(String name)