org.springframework.web.servlet.config.annotation

Class InterceptorRegistration

java.lang.Object

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

public class InterceptorRegistration
extends Object

Assists with the creation of a MappedInterceptor.

Since:

3.1

Author:

Rossen Stoyanchev, Keith Donald

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
InterceptorRegistration	addPathPatterns(List<String> patterns) List-based variant of addPathPatterns(String...).
InterceptorRegistration	addPathPatterns(String... patterns) Add URL patterns to which the registered interceptor should apply to.
InterceptorRegistration	excludePathPatterns(List<String> patterns) List-based variant of excludePathPatterns(String...).
InterceptorRegistration	excludePathPatterns(String... patterns) Add URL patterns to which the registered interceptor should not apply to.
protected Object	getInterceptor() Build the underlying interceptor.
protected int	getOrder() Return the order position to be used.
InterceptorRegistration	order(int order) Specify an order position to be used.
InterceptorRegistration	pathMatcher(PathMatcher pathMatcher) A PathMatcher implementation to use with this interceptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

InterceptorRegistration

public InterceptorRegistration(HandlerInterceptor interceptor)

Create an InterceptorRegistration instance.

Method Detail

addPathPatterns

public InterceptorRegistration addPathPatterns(String... patterns)

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

addPathPatterns

public InterceptorRegistration addPathPatterns(List<String> patterns)

List-based variant of addPathPatterns(String...).

Since:

5.0.3

excludePathPatterns

public InterceptorRegistration excludePathPatterns(String... patterns)

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

excludePathPatterns

public InterceptorRegistration excludePathPatterns(List<String> patterns)

List-based variant of excludePathPatterns(String...).

Since:

5.0.3

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.

order

public InterceptorRegistration order(int order)

Specify an order position to be used. Default is 0.

Since:

4.3.23

getOrder

protected int getOrder()

Return the order position to be used.

getInterceptor

protected Object getInterceptor()

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