Home » xwork-2.1.5 » com.opensymphony » xwork2 » interceptor » [javadoc | source]
com.opensymphony.xwork2.interceptor
public class: ParametersInterceptor [javadoc | source]
java.lang.Object
   com.opensymphony.xwork2.interceptor.AbstractInterceptor
      com.opensymphony.xwork2.interceptor.MethodFilterInterceptor
         com.opensymphony.xwork2.interceptor.ParametersInterceptor

All Implemented Interfaces:
    Interceptor

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 ValueStack#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.

The interceptor takes one parameter named 'ordered'. When set to true action properties are guaranteed to be set top-down which means that top action's properties are set first. Then it's subcomponents properties are set. The reason for this order is to enable a 'factory' pattern. For example, let's assume that one has an action that contains a property named 'modelClass' that allows to choose what is the underlying implementation of model. By assuring that modelClass property is set before any model properties are set, it's possible to choose model implementation during action.setModelClass() call. Similiarily it's possible to use action.setPrimaryKey() property set call to actually load the model class from persistent storage. Without any assumption on parameter order you have to use patterns like 'Preparable'.

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 (ReflectionContextState#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 (ReflectionContextState#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.

Note: Since XWork 2.0.2, this interceptor extends MethodFilterInterceptor , therefore being able to deal with excludeMethods / includeMethods parameters. See [Workflow Interceptor] (class DefaultWorkflowInterceptor ) for documentation and examples on how to use this feature.

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>

Field Summary
 boolean ordered     
 Set<Pattern> excludeParams     
 Set<Pattern> acceptParams     
static  boolean devMode     
static final  Comparator<String> rbCollator    Compares based on number of '.' characters (fewer is higher) 
Fields inherited from com.opensymphony.xwork2.interceptor.MethodFilterInterceptor:
log,  excludeMethods,  includeMethods
Method from com.opensymphony.xwork2.interceptor.ParametersInterceptor Summary:
acceptableName,   addParametersToContext,   doIntercept,   getExcludeParamsSet,   getOrderedComparator,   isAccepted,   isExcluded,   isOrdered,   retrieveParameters,   setAcceptParamNames,   setDevMode,   setExcludeParams,   setOrdered,   setParameters,   setValueStackFactory
Methods from com.opensymphony.xwork2.interceptor.MethodFilterInterceptor:
applyInterceptor,   doIntercept,   getExcludeMethodsSet,   getIncludeMethodsSet,   intercept,   setExcludeMethods,   setIncludeMethods
Methods from com.opensymphony.xwork2.interceptor.AbstractInterceptor:
destroy,   init,   intercept
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from com.opensymphony.xwork2.interceptor.ParametersInterceptor Detail:
 protected boolean acceptableName(String name) 
 protected  void addParametersToContext(ActionContext ac,
    Map<String, Object> newParams) 
    Adds the parameters into context's ParameterMap
 public String doIntercept(ActionInvocation invocation) throws Exception 
 protected Set getExcludeParamsSet() 
    Gets a set of regular expressions of parameters to remove from the parameter map
 protected Comparator<String> getOrderedComparator() 
    Gets an instance of the comparator to use for the ordered sorting. Override this method to customize the ordering of the parameters as they are set to the action.
 protected boolean isAccepted(String paramName) 
 protected boolean isExcluded(String paramName) 
 public boolean isOrdered() 
    Whether to order the parameters or not
 protected Map<String, Object> retrieveParameters(ActionContext ac) 
    Gets the parameter map to apply from wherever appropriate
 public  void setAcceptParamNames(String commaDelim) 
 public static  void setDevMode(String mode) 
 public  void setExcludeParams(String commaDelim) 
    Sets a comma-delimited list of regular expressions to match parameters that should be removed from the parameter map.
 public  void setOrdered(boolean ordered) 
    Set whether to order the parameters by object depth or not
 protected  void setParameters(Object action,
    ValueStack stack,
    Map<String, Object> parameters) 
 public  void setValueStackFactory(ValueStackFactory valueStackFactory)