Modifier and Type	Class and Description
private static class	MappedInterceptor.PatternAdapter Contains both the parsed `PathPattern` and the raw String pattern, and uses the former when the cached path is `PathContainer` or the latter otherwise.

Modifier and Type	Field and Description
private static final PathMatcher	defaultPathMatcher
private final MappedInterceptor.PatternAdapter[]	excludePatterns
private final MappedInterceptor.PatternAdapter[]	includePatterns
private final HandlerInterceptor	interceptor
private PathMatcher	pathMatcher

Constructor Summary

Access	Constructor and Description
public	MappedInterceptor(String[] patterns to which requests must match, or null to match all paths includePatterns, String[] patterns to which requests must not match excludePatterns, HandlerInterceptor the target interceptor interceptor, PathPatternParser a parser to use to pre-parse patterns into `PathPattern`; when not provided, `PathPatternParser#defaultInstance` is used. parser) Create an instance with the given include and exclude patterns along with the target interceptor for the mappings.
public	MappedInterceptor(String[] includePatterns, HandlerInterceptor interceptor) Variant of `MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)` with include patterns only.
public	MappedInterceptor(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor) Variant of `MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)` without a provided parser.
public	MappedInterceptor(String[] includePatterns, WebRequestInterceptor interceptor) Variant of `MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)` with a `WebRequestInterceptor` as the target.
public	MappedInterceptor(String[] includePatterns, String[] excludePatterns, WebRequestInterceptor interceptor) Variant of `MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)` with a `WebRequestInterceptor` as the target.

Method Summary

Modifier and Type	Method and Description
public void	afterCompletion(HttpServletRequest current HTTP request request, HttpServletResponse current HTTP response response, Object the handler (or `HandlerMethod`) that started asynchronous execution, for type and/or instance examination handler, Exception any exception thrown on handler execution, if any; this does not include exceptions that have been handled through an exception resolver ex) Overrides default org.springframework.web.servlet.HandlerInterceptor.afterCompletion. Callback after completion of request processing, that is, after rendering the view.
public String[]	getExcludePathPatterns() Get the exclude path patterns this interceptor is mapped to.
public String[]	getIncludePathPatterns() Get the include path patterns this interceptor is mapped to.
public HandlerInterceptor	getInterceptor() The target `HandlerInterceptor` to invoke in case of a match.
public PathMatcher	getPathMatcher() Get the configured PathMatcher.
public String[]	getPathPatterns() Deprecated for removal since 6.1. since 6.1 in favor of `getIncludePathPatterns()` Get the include path patterns this interceptor is mapped to.
public boolean	Returns: `true` if the interceptor should be applied to the request matches(HttpServletRequest the request to match to request) Check whether this interceptor is mapped to the request.
public boolean	Returns: `true` if the interceptor applies to the given request path matches(String the current request path lookupPath, PathMatcher a path matcher for path pattern matching pathMatcher) Deprecated since 5.3. as of 5.3 in favor of `matches(HttpServletRequest)` Determine if there is a match for the given lookup path.
public void	postHandle(HttpServletRequest current HTTP request request, HttpServletResponse current HTTP response response, Object the handler (or `HandlerMethod`) that started asynchronous execution, for type and/or instance examination handler, ModelAndView the `ModelAndView` that the handler returned (can also be `null`) modelAndView) Overrides default org.springframework.web.servlet.HandlerInterceptor.postHandle. Interception point after successful execution of a handler.
public boolean	preHandle(HttpServletRequest current HTTP request request, HttpServletResponse current HTTP response response, Object chosen handler to execute, for type and/or instance evaluation handler) Overrides default org.springframework.web.servlet.HandlerInterceptor.preHandle. Interception point before the execution of a handler.
public void	setPathMatcher(PathMatcher pathMatcher) Configure the PathMatcher to use to match URL paths with against include and exclude patterns.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

defaultPathMatcher	back to summary
private static final PathMatcher defaultPathMatcher

excludePatterns	back to summary
private final MappedInterceptor.PatternAdapter[] excludePatterns Annotations @Nullable

includePatterns	back to summary
private final MappedInterceptor.PatternAdapter[] includePatterns Annotations @Nullable

interceptor	back to summary
private final HandlerInterceptor interceptor

pathMatcher	back to summary
private PathMatcher pathMatcher

Constructor Detail

MappedInterceptor back to summary

MappedInterceptor	back to summary
public MappedInterceptor(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor, PathPatternParser parser) Create an instance with the given include and exclude patterns along with the target interceptor for the mappings. Parameters includePatterns:String[] patterns to which requests must match, or null to match all paths excludePatterns:String[] patterns to which requests must not match interceptor:HandlerInterceptor the target interceptor parser:PathPatternParser a parser to use to pre-parse patterns into `PathPattern`; when not provided, `PathPatternParser#defaultInstance` is used. Since 5.3

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

Create an instance with the given include and exclude patterns along with the target interceptor for the mappings.

Parameters

includePatterns:String[]: patterns to which requests must match, or null to match all paths
excludePatterns:String[]: patterns to which requests must not match
interceptor:HandlerInterceptor: the target interceptor
parser:PathPatternParser: a parser to use to pre-parse patterns into PathPattern; when not provided, PathPatternParser#defaultInstance is used.

Since

5.3

MappedInterceptor	back to summary
public MappedInterceptor(String[] includePatterns, HandlerInterceptor interceptor) Variant of `MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)` with include patterns only.

MappedInterceptor	back to summary
public MappedInterceptor(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor) Variant of `MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)` without a provided parser.

MappedInterceptor	back to summary
public MappedInterceptor(String[] includePatterns, WebRequestInterceptor interceptor) Variant of `MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)` with a `WebRequestInterceptor` as the target.

MappedInterceptor	back to summary
public MappedInterceptor(String[] includePatterns, String[] excludePatterns, WebRequestInterceptor interceptor) Variant of `MappedInterceptor(String[], String[], HandlerInterceptor, PathPatternParser)` with a `WebRequestInterceptor` as the target.

Method Detail

afterCompletion back to summary

afterCompletion	back to summary
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception Overrides default org.springframework.web.servlet.HandlerInterceptor.afterCompletion. Doc from org.springframework.web.servlet.HandlerInterceptor.afterCompletion. Callback after completion of request processing, that is, after rendering the view. Will be called on any outcome of handler execution, thus allows for proper resource cleanup. Note Will only be called if this interceptor's `preHandle` method has successfully completed and returned `true`! As with the `postHandle` method, the method will be invoked on each interceptor in the chain in reverse order, so the first interceptor will be the last to be invoked. Note special considerations apply for asynchronous request processing. For more details see `org.springframework.web.servlet.AsyncHandlerInterceptor`. The default implementation is empty. Parameters request:HttpServletRequest current HTTP request response:HttpServletResponse current HTTP response handler:Object the handler (or `HandlerMethod`) that started asynchronous execution, for type and/or instance examination ex:Exception any exception thrown on handler execution, if any; this does not include exceptions that have been handled through an exception resolver Annotations @Override Exceptions Exception: in case of errors

public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception

Overrides default org.springframework.web.servlet.HandlerInterceptor.afterCompletion.

Doc from org.springframework.web.servlet.HandlerInterceptor.afterCompletion.

Callback after completion of request processing, that is, after rendering the view. Will be called on any outcome of handler execution, thus allows for proper resource cleanup.

Note

Will only be called if this interceptor's preHandle method has successfully completed and returned true!

As with the postHandle method, the method will be invoked on each interceptor in the chain in reverse order, so the first interceptor will be the last to be invoked.

Note

special considerations apply for asynchronous request processing. For more details see org.springframework.web.servlet.AsyncHandlerInterceptor.

The default implementation is empty.

Parameters

request:HttpServletRequest: current HTTP request
response:HttpServletResponse: current HTTP response
handler:Object: the handler (or HandlerMethod) that started asynchronous execution, for type and/or instance examination
ex:Exception: any exception thrown on handler execution, if any; this does not include exceptions that have been handled through an exception resolver

Annotations

@Override

Exceptions

Exception:: in case of errors

getExcludePathPatterns back to summary

getExcludePathPatterns	back to summary
public String[] getExcludePathPatterns() Get the exclude path patterns this interceptor is mapped to. Annotations @Nullable Since 6.1 See Also `getIncludePathPatterns()`

public String[] getExcludePathPatterns()

Get the exclude path patterns this interceptor is mapped to.

Annotations

@Nullable

Since

6.1

See Also

getIncludePathPatterns()

getIncludePathPatterns back to summary

getIncludePathPatterns	back to summary
public String[] getIncludePathPatterns() Get the include path patterns this interceptor is mapped to. Annotations @Nullable Since 6.1 See Also `getExcludePathPatterns()`

public String[] getIncludePathPatterns()

Get the include path patterns this interceptor is mapped to.

Annotations

@Nullable

Since

6.1

See Also

getExcludePathPatterns()

getInterceptor	back to summary
public HandlerInterceptor getInterceptor() The target `HandlerInterceptor` to invoke in case of a match.

getPathMatcher	back to summary
public PathMatcher getPathMatcher() Get the configured PathMatcher.

getPathPatterns back to summary

getPathPatterns	back to summary
public String[] getPathPatterns() Deprecated for removal since 6.1. since 6.1 in favor of `getIncludePathPatterns()` Get the include path patterns this interceptor is mapped to. Annotations @Nullable @Deprecated since:6.1 forRemoval:true See Also `getIncludePathPatterns()`, `getExcludePathPatterns()`

public String[] getPathPatterns()

Deprecated

for removal since 6.1.

since 6.1 in favor of getIncludePathPatterns()

Get the include path patterns this interceptor is mapped to.

Annotations

@Nullable
@Deprecated
since:6.1
forRemoval:true

matches back to summary

matches	back to summary
public boolean matches(HttpServletRequest request) Check whether this interceptor is mapped to the request. The request mapping path is expected to have been resolved externally. See also class-level Javadoc. Parameters request:HttpServletRequest the request to match to Returns:boolean `true` if the interceptor should be applied to the request

public boolean matches(HttpServletRequest request)

Check whether this interceptor is mapped to the request.

The request mapping path is expected to have been resolved externally. See also class-level Javadoc.

Parameters

request:HttpServletRequest: the request to match to

Returns:boolean

true if the interceptor should be applied to the request

matches back to summary

matches	back to summary
public boolean matches(String lookupPath, PathMatcher pathMatcher) Deprecated since 5.3. as of 5.3 in favor of `matches(HttpServletRequest)` Determine if there is a match for the given lookup path. Parameters lookupPath:String the current request path pathMatcher:PathMatcher a path matcher for path pattern matching Returns:boolean `true` if the interceptor applies to the given request path Annotations @Deprecated since:5.3

public boolean matches(String lookupPath, PathMatcher pathMatcher)

Deprecated

since 5.3.

as of 5.3 in favor of matches(HttpServletRequest)

Determine if there is a match for the given lookup path.

Parameters

lookupPath:String: the current request path
pathMatcher:PathMatcher: a path matcher for path pattern matching

Returns:boolean

true if the interceptor applies to the given request path

Annotations

@Deprecated
since:5.3

postHandle back to summary

postHandle	back to summary
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception Overrides default org.springframework.web.servlet.HandlerInterceptor.postHandle. Doc from org.springframework.web.servlet.HandlerInterceptor.postHandle. Interception point after successful execution of a handler. Called after HandlerAdapter actually invoked the handler, but before the DispatcherServlet renders the view. Can expose additional model objects to the view via the given ModelAndView. DispatcherServlet processes a handler in an execution chain, consisting of any number of interceptors, with the handler itself at the end. With this method, each interceptor can post-process an execution, getting applied in inverse order of the execution chain. Note special considerations apply for asynchronous request processing. For more details see `org.springframework.web.servlet.AsyncHandlerInterceptor`. The default implementation is empty. Parameters request:HttpServletRequest current HTTP request response:HttpServletResponse current HTTP response handler:Object the handler (or `HandlerMethod`) that started asynchronous execution, for type and/or instance examination modelAndView:ModelAndView the `ModelAndView` that the handler returned (can also be `null`) Annotations @Override Exceptions Exception: in case of errors

public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception

Overrides default org.springframework.web.servlet.HandlerInterceptor.postHandle.

Doc from org.springframework.web.servlet.HandlerInterceptor.postHandle.

Interception point after successful execution of a handler. Called after HandlerAdapter actually invoked the handler, but before the DispatcherServlet renders the view. Can expose additional model objects to the view via the given ModelAndView.

DispatcherServlet processes a handler in an execution chain, consisting of any number of interceptors, with the handler itself at the end. With this method, each interceptor can post-process an execution, getting applied in inverse order of the execution chain.

Note

special considerations apply for asynchronous request processing. For more details see org.springframework.web.servlet.AsyncHandlerInterceptor.

The default implementation is empty.

Parameters

request:HttpServletRequest: current HTTP request
response:HttpServletResponse: current HTTP response
handler:Object: the handler (or HandlerMethod) that started asynchronous execution, for type and/or instance examination
modelAndView:ModelAndView: the ModelAndView that the handler returned (can also be null)

Annotations

@Override

Exceptions

Exception:: in case of errors

preHandle back to summary

preHandle	back to summary
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception Overrides default org.springframework.web.servlet.HandlerInterceptor.preHandle. Doc from org.springframework.web.servlet.HandlerInterceptor.preHandle. Interception point before the execution of a handler. Called after HandlerMapping determined an appropriate handler object, but before HandlerAdapter invokes the handler. DispatcherServlet processes a handler in an execution chain, consisting of any number of interceptors, with the handler itself at the end. With this method, each interceptor can decide to abort the execution chain, typically sending an HTTP error or writing a custom response. Note special considerations apply for asynchronous request processing. For more details see `org.springframework.web.servlet.AsyncHandlerInterceptor`. The default implementation returns `true`. Parameters request:HttpServletRequest current HTTP request response:HttpServletResponse current HTTP response handler:Object chosen handler to execute, for type and/or instance evaluation Returns:boolean `true` if the execution chain should proceed with the next interceptor or the handler itself. Else, DispatcherServlet assumes that this interceptor has already dealt with the response itself. Annotations @Override Exceptions Exception: in case of errors

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception

Overrides default org.springframework.web.servlet.HandlerInterceptor.preHandle.

Doc from org.springframework.web.servlet.HandlerInterceptor.preHandle.

Interception point before the execution of a handler. Called after HandlerMapping determined an appropriate handler object, but before HandlerAdapter invokes the handler.

DispatcherServlet processes a handler in an execution chain, consisting of any number of interceptors, with the handler itself at the end. With this method, each interceptor can decide to abort the execution chain, typically sending an HTTP error or writing a custom response.

Note

special considerations apply for asynchronous request processing. For more details see org.springframework.web.servlet.AsyncHandlerInterceptor.

The default implementation returns true.

Parameters

request:HttpServletRequest: current HTTP request
response:HttpServletResponse: current HTTP response
handler:Object: chosen handler to execute, for type and/or instance evaluation

Returns:boolean

true if the execution chain should proceed with the next interceptor or the handler itself. Else, DispatcherServlet assumes that this interceptor has already dealt with the response itself.

Annotations

@Override

Exceptions

Exception:: in case of errors

setPathMatcher back to summary

setPathMatcher	back to summary
public void setPathMatcher(PathMatcher pathMatcher) Configure the PathMatcher to use to match URL paths with against include and exclude patterns. This is an advanced property that should be used only when a customized `AntPathMatcher` or a custom PathMatcher is required. By default this is `AntPathMatcher`. Note Setting `PathMatcher` enforces use of String pattern matching even when a parsed `RequestPath` is available.

public void setPathMatcher(PathMatcher pathMatcher)

Configure the PathMatcher to use to match URL paths with against include and exclude patterns.

This is an advanced property that should be used only when a customized AntPathMatcher or a custom PathMatcher is required.

By default this is AntPathMatcher.

Note

Setting PathMatcher enforces use of String pattern matching even when a parsed RequestPath is available.

org.springframework.web.servlet.handler back to summary

private Class MappedInterceptor.PatternAdapter

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.servlet.handler.MappedInterceptor.PatternAdapter

Contains both the parsed PathPattern and the raw String pattern, and uses the former when the cached path is PathContainer or the latter otherwise. If the pattern cannot be parsed due to unsupported syntax, then PathMatcher is used for all requests.

Since: 5.3.6

Field Summary

Modifier and Type	Field and Description
private final PathPattern	pathPattern
private final String	patternString

Constructor Summary

Access	Constructor and Description
public	PatternAdapter(String pattern, PathPatternParser parser)

Method Summary

Modifier and Type	Method and Description
public String	getPatternString()
private static PathPattern	initPathPattern(String pattern, PathPatternParser parser)
public static MappedInterceptor.PatternAdapter[]	initPatterns(String[] patterns, PathPatternParser parser)
public boolean	match(Object path, boolean isPathContainer, PathMatcher pathMatcher)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

pathPattern	back to summary
private final PathPattern pathPattern Annotations @Nullable

patternString	back to summary
private final String patternString

Constructor Detail

PatternAdapter	back to summary
public PatternAdapter(String pattern, PathPatternParser parser)

Method Detail

getPatternString	back to summary
public String getPatternString()

initPathPattern	back to summary
private static PathPattern initPathPattern(String pattern, PathPatternParser parser) Annotations @Nullable

initPatterns	back to summary
public static MappedInterceptor.PatternAdapter[] initPatterns(String[] patterns, PathPatternParser parser) Annotations @Nullable

match	back to summary
public boolean match(Object path, boolean isPathContainer, PathMatcher pathMatcher)

public final Class MappedInterceptor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MappedInterceptor.PatternAdapter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail