Home » xwork-2.1.5 » com.opensymphony » xwork2 » interceptor » [javadoc | source]
public class: ParameterFilterInterceptor [javadoc | source]

All Implemented Interfaces:

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.

  <interceptor name="parameterFilter" class="com.opensymphony.xwork2.interceptor.ParameterFilterInterceptor"/>

<action ....>
  <interceptor-ref name="parameterFilter">
    <param name="blocked">person,person.address.createDate,personDao</param>

Method from com.opensymphony.xwork2.interceptor.ParameterFilterInterceptor Summary:
getAllowedCollection,   getBlockedCollection,   intercept,   isDefaultBlock,   setAllowed,   setAllowedCollection,   setBlocked,   setBlockedCollection,   setDefaultBlock
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.ParameterFilterInterceptor Detail:
 public Collection<String> getAllowedCollection() 
 public Collection<String> getBlockedCollection() 
 public String intercept(ActionInvocation invocation) throws Exception 
 public boolean isDefaultBlock() 
 public  void setAllowed(String allowed) 
 public  void setAllowedCollection(Collection<String> allowed) 
 public  void setBlocked(String blocked) 
 public  void setBlockedCollection(Collection<String> blocked) 
 public  void setDefaultBlock(boolean defaultExclude)