com.opensymphony.xwork2.interceptor
Class MethodFilterInterceptor
java.lang.Object
com.opensymphony.xwork2.interceptor.AbstractInterceptor
com.opensymphony.xwork2.interceptor.MethodFilterInterceptor
- All Implemented Interfaces:
- Interceptor, Serializable
- Direct Known Subclasses:
- DefaultWorkflowInterceptor, ParametersInterceptor, PrepareInterceptor, ValidationInterceptor
public abstract class MethodFilterInterceptor
- extends AbstractInterceptor
MethodFilterInterceptor is an abstract Interceptor
used as
a base class for interceptors that will filter execution based on method
names according to specified included/excluded method lists.
Settable parameters are as follows:
- excludeMethods - method names to be excluded from interceptor processing
- includeMethods - method names to be included in interceptor processing
NOTE: If method name are available in both includeMethods and
excludeMethods, it will be considered as an included method:
includeMethods takes precedence over excludeMethods.
Interceptors that extends this capability include:
- TokenInterceptor
- TokenSessionStoreInterceptor
- DefaultWorkflowInterceptor
- ValidationInterceptor
- Version:
- $Date: 2008-02-16 16:24:55 +0100 (Sat, 16 Feb 2008) $ $Id: MethodFilterInterceptor.java 1747 2008-02-16 15:24:55Z davenewton $
- Author:
- Alexandru Popescu, Rainer Hermanns
- See Also:
TokenInterceptor
,
TokenSessionStoreInterceptor
,
DefaultWorkflowInterceptor
,
ValidationInterceptor
,
Serialized Form
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
log
protected transient Logger log
excludeMethods
protected Set excludeMethods
includeMethods
protected Set includeMethods
MethodFilterInterceptor
public MethodFilterInterceptor()
setExcludeMethods
public void setExcludeMethods(String excludeMethods)
getExcludeMethodsSet
public Set getExcludeMethodsSet()
setIncludeMethods
public void setIncludeMethods(String includeMethods)
getIncludeMethodsSet
public Set getIncludeMethodsSet()
intercept
public String intercept(ActionInvocation invocation)
throws 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:
Exception
- any system-level error, as defined in Action.execute()
.
applyInterceptor
protected boolean applyInterceptor(ActionInvocation invocation)
doIntercept
protected abstract String doIntercept(ActionInvocation invocation)
throws Exception
- Subclasses must override to implement the interceptor logic.
- Parameters:
invocation
- the action invocation
- Returns:
- the result of invocation
- Throws:
Exception
Copyright © 2008 OpenSymphony. All Rights Reserved.