org.springframework.web.servlet.config.annotation

Class InterceptorRegistration

java.lang.Object

org.springframework.web.servlet.config.annotation.InterceptorRegistration

public class InterceptorRegistration
extends java.lang.Object

Assists with the creation of a MappedInterceptor.

Since:

3.1

Author:

Rossen Stoyanchev, Keith Donald

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.String>	excludePatterns
private java.util.List<java.lang.String>	includePatterns
private HandlerInterceptor	interceptor
private PathMatcher	pathMatcher

Constructor Summary

Constructors

Constructor and Description
InterceptorRegistration(HandlerInterceptor interceptor) Creates an InterceptorRegistration instance.

Method Summary

Modifier and Type	Method and Description
InterceptorRegistration	addPathPatterns(java.lang.String... patterns) Add URL patterns to which the registered interceptor should apply to.
InterceptorRegistration	excludePathPatterns(java.lang.String... patterns) Add URL patterns to which the registered interceptor should not apply to.
protected java.lang.Object	getInterceptor() Returns the underlying interceptor.
InterceptorRegistration	pathMatcher(PathMatcher pathMatcher) A PathMatcher implementation to use with this interceptor.
private static java.lang.String[]	toArray(java.util.List<java.lang.String> list)

Methods inherited from class java.lang.Object

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

Field Detail

interceptor

private final HandlerInterceptor interceptor

includePatterns

private final java.util.List<java.lang.String> includePatterns

excludePatterns

private final java.util.List<java.lang.String> excludePatterns

pathMatcher

private PathMatcher pathMatcher

Constructor Detail

InterceptorRegistration

public InterceptorRegistration(HandlerInterceptor interceptor)

Creates an InterceptorRegistration instance.

Method Detail

addPathPatterns

public InterceptorRegistration addPathPatterns(java.lang.String... patterns)

Add URL patterns to which the registered interceptor should apply to.

excludePathPatterns

public InterceptorRegistration excludePathPatterns(java.lang.String... patterns)

Add URL patterns to which the registered interceptor should not apply to.

pathMatcher

public InterceptorRegistration pathMatcher(PathMatcher pathMatcher)

A PathMatcher implementation to use with this interceptor. This is an optional, advanced property required only if using custom PathMatcher implementations that support mapping metadata other than the Ant path patterns supported by default.

getInterceptor

protected java.lang.Object getInterceptor()

Returns the underlying interceptor. If URL patterns are provided the returned type is MappedInterceptor; otherwise HandlerInterceptor.

toArray

private static java.lang.String[] toArray(java.util.List<java.lang.String> list)