org.springframework.web.servlet.handler

Class MappedInterceptor

java.lang.Object

org.springframework.web.servlet.handler.MappedInterceptor

public final class MappedInterceptor
extends Object

Contains a HandlerInterceptor along with include (and optionally exclude) path patterns to which the interceptor should apply. Also provides matching logic to test if the interceptor applies to a given request path.

A MappedInterceptor can be registered directly with any AbstractHandlerMethodMapping. Furthermore, beans of type MappedInterceptor are automatically detected by AbstractHandlerMethodMapping (including ancestor ApplicationContext's) which effectively means the interceptor is registered "globally" with all handler mappings.

Since:

3.0

Author:

Keith Donald, Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
MappedInterceptor(String[] includePatterns, HandlerInterceptor interceptor) Create a new MappedInterceptor instance.
MappedInterceptor(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor) Create a new MappedInterceptor instance.
MappedInterceptor(String[] includePatterns, String[] excludePatterns, WebRequestInterceptor interceptor) Create a new MappedInterceptor instance.
MappedInterceptor(String[] includePatterns, WebRequestInterceptor interceptor) Create a new MappedInterceptor instance.

Method Summary

Modifier and Type	Method and Description
HandlerInterceptor	getInterceptor() The actual Interceptor reference.
PathMatcher	getPathMatcher() The configured PathMatcher, or null.
String[]	getPathPatterns() The path into the application the interceptor is mapped to.
boolean	matches(String lookupPath, PathMatcher pathMatcher) Returns true if the interceptor applies to the given request path.
void	setPathMatcher(PathMatcher pathMatcher) Configure a PathMatcher to use with this MappedInterceptor instead of the one passed by default to the matches(String, org.springframework.util.PathMatcher) method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MappedInterceptor

public MappedInterceptor(String[] includePatterns,
                         HandlerInterceptor interceptor)

Create a new MappedInterceptor instance.

Parameters:

includePatterns - the path patterns to map with a null value matching to all paths

interceptor - the HandlerInterceptor instance to map to the given patterns

MappedInterceptor

public MappedInterceptor(String[] includePatterns,
                         String[] excludePatterns,
                         HandlerInterceptor interceptor)

Create a new MappedInterceptor instance.

Parameters:

includePatterns - the path patterns to map with a null value matching to all paths

excludePatterns - the path patterns to exclude

interceptor - the HandlerInterceptor instance to map to the given patterns

MappedInterceptor

public MappedInterceptor(String[] includePatterns,
                         WebRequestInterceptor interceptor)

Create a new MappedInterceptor instance.

Parameters:

includePatterns - the path patterns to map with a null value matching to all paths

interceptor - the WebRequestInterceptor instance to map to the given patterns

MappedInterceptor

public MappedInterceptor(String[] includePatterns,
                         String[] excludePatterns,
                         WebRequestInterceptor interceptor)

Create a new MappedInterceptor instance.

Parameters:

includePatterns - the path patterns to map with a null value matching to all paths

interceptor - the WebRequestInterceptor instance to map to the given patterns

Method Detail

setPathMatcher

public void setPathMatcher(PathMatcher pathMatcher)

Configure a PathMatcher to use with this MappedInterceptor instead of the one passed by default to the matches(String, org.springframework.util.PathMatcher) method. This is an advanced property that is only required when using custom PathMatcher implementations that support mapping metadata other than the Ant-style path patterns supported by default.

Parameters:

pathMatcher - the path matcher to use

getPathMatcher

public PathMatcher getPathMatcher()

The configured PathMatcher, or null.

getPathPatterns

public String[] getPathPatterns()

The path into the application the interceptor is mapped to.

getInterceptor

public HandlerInterceptor getInterceptor()

The actual Interceptor reference.

matches

public boolean matches(String lookupPath,
                       PathMatcher pathMatcher)

Returns true if the interceptor applies to the given request path.

Parameters:

lookupPath - the current request path

pathMatcher - a path matcher for path pattern matching