com.opensymphony.xwork2.interceptor
Class ParameterFilterInterceptor

java.lang.Object
  extended by com.opensymphony.xwork2.interceptor.AbstractInterceptor
      extended by com.opensymphony.xwork2.interceptor.ParameterFilterInterceptor
All Implemented Interfaces:
Interceptor, java.io.Serializable

public class ParameterFilterInterceptor
extends AbstractInterceptor

The Parameter Filter Interceptor blocks parameters from getting to the rest of the stack or your action. You can use multiple parameter filter interceptors for a given action, so, for example, you could use one in your default stack that filtered parameters you wanted blocked from every action and those you wanted blocked from an individual action you could add an additional interceptor for each action.

The way parameters are filtered for the least configuration is that if a string is in the allowed or blocked lists, then any parameter that is a member of the object represented by the parameter is allowed or blocked respectively.

For example, if the parameters are:


The parameters person.name, person.phoneNum etc would be blocked because 'person' is in the blocked list. However, person.address.street and person.address.city would be allowed because person.address is in the allowed list (the longer string determines permissions).

There are no known extension points to this interceptor.
 
 <interceptors>
   ...
   <interceptor name="parameterFilter" class="com.opensymphony.xwork2.interceptor.ParameterFilterInterceptor"/>
   ...
 </interceptors>
 
 <action ....>
   ...
   <interceptor-ref name="parameterFilter">
     <param name="blocked">person,person.address.createDate,personDao</param>
   </interceptor-ref>
   ...
 </action>
 
 

Author:
Gabe
See Also:
Serialized Form

Constructor Summary
ParameterFilterInterceptor()
           
 
Method Summary
 java.util.Collection<java.lang.String> getAllowedCollection()
           
 java.util.Collection<java.lang.String> getBlockedCollection()
           
 java.lang.String intercept(ActionInvocation invocation)
          Override to handle interception
 boolean isDefaultBlock()
           
 void setAllowed(java.lang.String allowed)
           
 void setAllowedCollection(java.util.Collection<java.lang.String> allowed)
           
 void setBlocked(java.lang.String blocked)
           
 void setBlockedCollection(java.util.Collection<java.lang.String> blocked)
           
 void setDefaultBlock(boolean defaultExclude)
           
 
Methods inherited from class com.opensymphony.xwork2.interceptor.AbstractInterceptor
destroy, init
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParameterFilterInterceptor

public ParameterFilterInterceptor()
Method Detail

intercept

public java.lang.String intercept(ActionInvocation invocation)
                           throws java.lang.Exception
Description copied from class: AbstractInterceptor
Override to handle interception

Specified by:
intercept in interface Interceptor
Specified by:
intercept in class AbstractInterceptor
Parameters:
invocation - the action invocation
Returns:
the return code, either returned from ActionInvocation.invoke(), or from the interceptor itself.
Throws:
java.lang.Exception - any system-level error, as defined in Action.execute().

isDefaultBlock

public boolean isDefaultBlock()
Returns:
Returns the defaultBlock.

setDefaultBlock

public void setDefaultBlock(boolean defaultExclude)
Parameters:
defaultExclude - The defaultExclude to set.

getBlockedCollection

public java.util.Collection<java.lang.String> getBlockedCollection()
Returns:
Returns the blocked.

setBlockedCollection

public void setBlockedCollection(java.util.Collection<java.lang.String> blocked)
Parameters:
blocked - The blocked to set.

setBlocked

public void setBlocked(java.lang.String blocked)
Parameters:
blocked - The blocked paramters as comma separated String.

getAllowedCollection

public java.util.Collection<java.lang.String> getAllowedCollection()
Returns:
Returns the allowed.

setAllowedCollection

public void setAllowedCollection(java.util.Collection<java.lang.String> allowed)
Parameters:
allowed - The allowed to set.

setAllowed

public void setAllowed(java.lang.String allowed)
Parameters:
allowed - The allowed paramters as comma separated String.


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