Modifier and Type	Class and Description
private class	AbstractUrlHandlerMapping.PathExposingHandlerInterceptor Special interceptor for exposing the `AbstractUrlHandlerMapping#PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE` attribute.
private class	AbstractUrlHandlerMapping.UriTemplateVariablesHandlerInterceptor Special interceptor for exposing the `AbstractUrlHandlerMapping#URI_TEMPLATE_VARIABLES_ATTRIBUTE` attribute.

Modifier and Type	Field and Description
private final Map<String, Object>	handlerMap
private boolean	lazyInitHandlers
private final Map<PathPattern, Object>	pathPatternHandlerMap
private Object	rootHandler
private boolean	useTrailingSlashMatch

Access	Constructor and Description
public	AbstractUrlHandlerMapping()

Method Summary

Modifier and Type	Method and Description
protected Object	Returns: the final handler object buildPathExposingHandler(Object the raw handler to expose rawHandler, String bestMatchingPattern, String the path to expose before executing the handler pathWithinMapping, Map<String, String> the URI template variables, can be `null` if no variables found uriTemplateVariables) Build a handler object for the given raw handler, exposing the actual handler, the `PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE`, as well as the `URI_TEMPLATE_VARIABLES_ATTRIBUTE` before executing the handler.
protected void	exposePathWithinMapping(String bestMatchingPattern, String the path within the current mapping pathWithinMapping, HttpServletRequest the request to expose the path to request) Expose the path within the current mapping as request attribute.
protected void	exposeUriTemplateVariables(Map<String, String> the URI template variables uriTemplateVariables, HttpServletRequest the request to expose the path to request) Expose the URI templates variables as request attribute.
private Object	getDirectMatch(String urlPath, HttpServletRequest request)
private String	getHandlerDescription(Object handler)
protected Object	Returns: the handler instance, or `null` if none found getHandlerInternal(HttpServletRequest current HTTP request request) Implements abstract org.springframework.web.servlet.handler.AbstractHandlerMapping.getHandlerInternal. Look up a handler for the URL path of the given request.
public final Map<String, Object>	getHandlerMap() Return the handler mappings as a read-only Map, with the registered path or pattern as key and the handler object (or handler bean name in case of a lazy-init handler), as value.
public final Map<PathPattern, Object>	getPathPatternHandlerMap() Identical to `getHandlerMap()` but populated when parsed patterns are `enabled`; otherwise empty.
public Object	getRootHandler() Return the root handler for this handler mapping (registered for "/"), or `null` if none.
protected Object	Returns: a matching handler, or `null` if not found lookupHandler(RequestPath the parsed RequestPath path, String the String lookupPath for checking direct hits lookupPath, HttpServletRequest current HTTP request request) Look up a handler instance for the given URL path.
protected Object	Returns: a matching handler, or `null` if not found lookupHandler(String the path to match patterns against lookupPath, HttpServletRequest current HTTP request request) Look up a handler instance for the given URL path.
public RequestMatchResult	match(HttpServletRequest the current request request, String the pattern to match pattern) Implements org.springframework.web.servlet.handler.MatchableHandlerMapping.match. Determine whether the request matches the given pattern.
protected void	registerHandler(String[] the URLs that the bean should be mapped to urlPaths, String the name of the handler bean beanName) Register the specified handler for the given URL paths.
protected void	registerHandler(String the URL the bean should be mapped to urlPath, Object the handler instance or handler bean name String (a bean name will automatically be resolved into the corresponding handler bean) handler) Register the specified handler for the given URL path.
public void	setLazyInitHandlers(boolean lazyInitHandlers) Set whether to lazily initialize handlers.
public void	setPatternParser(PathPatternParser the parser to use patternParser) Overrides org.springframework.web.servlet.handler.AbstractHandlerMapping.setPatternParser. Set the `PathPatternParser` to parse `patterns` with for URL path matching.
public void	setRootHandler(Object rootHandler) Set the root handler for this handler mapping, that is, the handler to be registered for the root path ("/").
public void	setUseTrailingSlashMatch(boolean useTrailingSlashMatch) Deprecated since 6.0. as of 6.0, see `PathPatternParser#setMatchOptionalTrailingSeparator(boolean)` Whether to match to URLs irrespective of the presence of a trailing slash.
protected boolean	supportsTypeLevelMappings() Indicates whether this handler mapping support type-level mappings.
public boolean	useTrailingSlashMatch() Whether to match to URLs irrespective of the presence of a trailing slash.
protected void	validateHandler(Object the handler object to validate handler, HttpServletRequest current HTTP request request) Validate the given handler against the current request.

Field Detail

handlerMap	back to summary
private final Map<String, Object> handlerMap

lazyInitHandlers	back to summary
private boolean lazyInitHandlers

pathPatternHandlerMap	back to summary
private final Map<PathPattern, Object> pathPatternHandlerMap

rootHandler	back to summary
private Object rootHandler Annotations @Nullable

useTrailingSlashMatch	back to summary
private boolean useTrailingSlashMatch

Constructor Detail

AbstractUrlHandlerMapping	back to summary
public AbstractUrlHandlerMapping()

Method Detail

buildPathExposingHandler back to summary

buildPathExposingHandler	back to summary
protected Object buildPathExposingHandler(Object rawHandler, String bestMatchingPattern, String pathWithinMapping, Map<String, String> uriTemplateVariables) Build a handler object for the given raw handler, exposing the actual handler, the `PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE`, as well as the `URI_TEMPLATE_VARIABLES_ATTRIBUTE` before executing the handler. The default implementation builds a `HandlerExecutionChain` with a special interceptor that exposes the path attribute and URI template variables Parameters rawHandler:Object the raw handler to expose pathWithinMapping:String the path to expose before executing the handler uriTemplateVariables:Map<String, String> the URI template variables, can be `null` if no variables found Returns:Object the final handler object

protected Object buildPathExposingHandler(Object rawHandler, String bestMatchingPattern, String pathWithinMapping, Map<String, String> uriTemplateVariables)

Build a handler object for the given raw handler, exposing the actual handler, the PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, as well as the URI_TEMPLATE_VARIABLES_ATTRIBUTE before executing the handler.

The default implementation builds a HandlerExecutionChain with a special interceptor that exposes the path attribute and URI template variables

Parameters

rawHandler:Object: the raw handler to expose
pathWithinMapping:String: the path to expose before executing the handler
uriTemplateVariables:Map<String, String>: the URI template variables, can be null if no variables found

Returns:Object

the final handler object

exposePathWithinMapping back to summary

exposePathWithinMapping	back to summary
protected void exposePathWithinMapping(String bestMatchingPattern, String pathWithinMapping, HttpServletRequest request) Expose the path within the current mapping as request attribute. Parameters pathWithinMapping:String the path within the current mapping request:HttpServletRequest the request to expose the path to See Also `PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE`

protected void exposePathWithinMapping(String bestMatchingPattern, String pathWithinMapping, HttpServletRequest request)

Expose the path within the current mapping as request attribute.

Parameters

pathWithinMapping:String: the path within the current mapping
request:HttpServletRequest: the request to expose the path to

See Also

PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE

exposeUriTemplateVariables back to summary

exposeUriTemplateVariables	back to summary
protected void exposeUriTemplateVariables(Map<String, String> uriTemplateVariables, HttpServletRequest request) Expose the URI templates variables as request attribute. Parameters uriTemplateVariables:Map<String, String> the URI template variables request:HttpServletRequest the request to expose the path to See Also `PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE`

protected void exposeUriTemplateVariables(Map<String, String> uriTemplateVariables, HttpServletRequest request)

Expose the URI templates variables as request attribute.

Parameters

uriTemplateVariables:Map<String, String>: the URI template variables
request:HttpServletRequest: the request to expose the path to

See Also

PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE

getDirectMatch	back to summary
private Object getDirectMatch(String urlPath, HttpServletRequest request) throws Exception Annotations @Nullable

getHandlerDescription	back to summary
private String getHandlerDescription(Object handler)

getHandlerInternal back to summary

getHandlerInternal	back to summary
protected Object getHandlerInternal(HttpServletRequest request) throws Exception Implements abstract org.springframework.web.servlet.handler.AbstractHandlerMapping.getHandlerInternal. Look up a handler for the URL path of the given request. Parameters request:HttpServletRequest current HTTP request Returns:Object the handler instance, or `null` if none found Annotations @Override @Nullable Exceptions Exception: Doc from org.springframework.web.servlet.handler.AbstractHandlerMapping.getHandlerInternal. if there is an internal error

protected Object getHandlerInternal(HttpServletRequest request) throws Exception

Implements abstract org.springframework.web.servlet.handler.AbstractHandlerMapping.getHandlerInternal.

Look up a handler for the URL path of the given request.

Parameters

request:HttpServletRequest: current HTTP request

Returns:Object

the handler instance, or null if none found

Annotations

@Override
@Nullable

Exceptions

Exception:

Doc from org.springframework.web.servlet.handler.AbstractHandlerMapping.getHandlerInternal.

if there is an internal error

getHandlerMap back to summary

getHandlerMap	back to summary
public final Map<String, Object> getHandlerMap() Return the handler mappings as a read-only Map, with the registered path or pattern as key and the handler object (or handler bean name in case of a lazy-init handler), as value. See Also `getDefaultHandler()`

public final Map<String, Object> getHandlerMap()

Return the handler mappings as a read-only Map, with the registered path or pattern as key and the handler object (or handler bean name in case of a lazy-init handler), as value.

See Also: getDefaultHandler()

getPathPatternHandlerMap back to summary

getPathPatternHandlerMap	back to summary
public final Map<PathPattern, Object> getPathPatternHandlerMap() Identical to `getHandlerMap()` but populated when parsed patterns are `enabled`; otherwise empty. Since 5.3

public final Map<PathPattern, Object> getPathPatternHandlerMap()

Identical to getHandlerMap() but populated when parsed patterns are enabled; otherwise empty.

Since: 5.3

getRootHandler back to summary

getRootHandler	back to summary
public Object getRootHandler() Return the root handler for this handler mapping (registered for "/"), or `null` if none. Annotations @Nullable

public Object getRootHandler()

Return the root handler for this handler mapping (registered for "/"), or null if none.

Annotations

@Nullable

lookupHandler back to summary

lookupHandler	back to summary
protected Object lookupHandler(RequestPath path, String lookupPath, HttpServletRequest request) throws Exception Look up a handler instance for the given URL path. This method is used when parsed `PathPattern`s are `enabled`. Parameters path:RequestPath the parsed RequestPath lookupPath:String the String lookupPath for checking direct hits request:HttpServletRequest current HTTP request Returns:Object a matching handler, or `null` if not found Annotations @Nullable Since 5.3

protected Object lookupHandler(RequestPath path, String lookupPath, HttpServletRequest request) throws Exception

Look up a handler instance for the given URL path. This method is used when parsed PathPatterns are enabled.

Parameters

path:RequestPath: the parsed RequestPath
lookupPath:String: the String lookupPath for checking direct hits
request:HttpServletRequest: current HTTP request

Returns:Object

a matching handler, or null if not found

Annotations

@Nullable

Since

5.3

lookupHandler back to summary

lookupHandler	back to summary
protected Object lookupHandler(String lookupPath, HttpServletRequest request) throws Exception Look up a handler instance for the given URL path. This method is used when String pattern matching with `PathMatcher` is in use. Parameters lookupPath:String the path to match patterns against request:HttpServletRequest current HTTP request Returns:Object a matching handler, or `null` if not found Annotations @Nullable See Also `exposePathWithinMapping`, `AntPathMatcher`

protected Object lookupHandler(String lookupPath, HttpServletRequest request) throws Exception

Look up a handler instance for the given URL path. This method is used when String pattern matching with PathMatcher is in use.

Parameters

lookupPath:String: the path to match patterns against
request:HttpServletRequest: current HTTP request

Returns:Object

a matching handler, or null if not found

Annotations

@Nullable

match back to summary

match	back to summary
public RequestMatchResult match(HttpServletRequest request, String pattern) Implements org.springframework.web.servlet.handler.MatchableHandlerMapping.match. Doc from org.springframework.web.servlet.handler.MatchableHandlerMapping.match. Determine whether the request matches the given pattern. Use this method when `getPatternParser()` returns `null` which means that the `HandlerMapping` is using String pattern matching. Parameters request:HttpServletRequest the current request pattern:String the pattern to match Returns:RequestMatchResult the result from request matching, or `null` if none Annotations @Override @Nullable

public RequestMatchResult match(HttpServletRequest request, String pattern)

Implements org.springframework.web.servlet.handler.MatchableHandlerMapping.match.

Doc from org.springframework.web.servlet.handler.MatchableHandlerMapping.match.

Determine whether the request matches the given pattern. Use this method when getPatternParser() returns null which means that the HandlerMapping is using String pattern matching.

Parameters

request:HttpServletRequest: the current request
pattern:String: the pattern to match

Returns:RequestMatchResult

the result from request matching, or null if none

Annotations

@Override
@Nullable

registerHandler	back to summary
protected void registerHandler(String[] urlPaths, String beanName) throws BeansException, IllegalStateException Register the specified handler for the given URL paths. Parameters urlPaths:String[] the URLs that the bean should be mapped to beanName:String the name of the handler bean Exceptions BeansException: if the handler couldn't be registered IllegalStateException: if there is a conflicting handler registered

registerHandler

back to summary

protected void registerHandler(String[] urlPaths, String beanName) throws BeansException, IllegalStateException

Parameters

urlPaths:String[]: the URLs that the bean should be mapped to
beanName:String: the name of the handler bean

Exceptions

BeansException:: if the handler couldn't be registered
IllegalStateException:: if there is a conflicting handler registered

registerHandler	back to summary
protected void registerHandler(String urlPath, Object handler) throws BeansException, IllegalStateException Register the specified handler for the given URL path. Parameters urlPath:String the URL the bean should be mapped to handler:Object the handler instance or handler bean name String (a bean name will automatically be resolved into the corresponding handler bean) Exceptions BeansException: if the handler couldn't be registered IllegalStateException: if there is a conflicting handler registered

registerHandler

back to summary

protected void registerHandler(String urlPath, Object handler) throws BeansException, IllegalStateException

Parameters

urlPath:String: the URL the bean should be mapped to
handler:Object: the handler instance or handler bean name String (a bean name will automatically be resolved into the corresponding handler bean)

Exceptions

BeansException:: if the handler couldn't be registered
IllegalStateException:: if there is a conflicting handler registered

setLazyInitHandlers	back to summary
public void setLazyInitHandlers(boolean lazyInitHandlers) Set whether to lazily initialize handlers. Only applicable to singleton handlers, as prototypes are always lazily initialized. Default is "false", as eager initialization allows for more efficiency through referencing the controller objects directly. If you want to allow your controllers to be lazily initialized, make them "lazy-init" and set this flag to true. Just making them "lazy-init" will not work, as they are initialized through the references from the handler mapping in this case.

setLazyInitHandlers

back to summary

public void setLazyInitHandlers(boolean lazyInitHandlers)

Set whether to lazily initialize handlers. Only applicable to singleton handlers, as prototypes are always lazily initialized. Default is "false", as eager initialization allows for more efficiency through referencing the controller objects directly.

If you want to allow your controllers to be lazily initialized, make them "lazy-init" and set this flag to true. Just making them "lazy-init" will not work, as they are initialized through the references from the handler mapping in this case.

setPatternParser back to summary

setPatternParser	back to summary
public void setPatternParser(PathPatternParser patternParser) Overrides org.springframework.web.servlet.handler.AbstractHandlerMapping.setPatternParser. Doc from org.springframework.web.servlet.handler.AbstractHandlerMapping.setPatternParser. Set the `PathPatternParser` to parse `patterns` with for URL path matching. Parsed patterns provide a more modern and efficient alternative to String path matching via `AntPathMatcher`. Note: This property is mutually exclusive with the below properties, all of which are not necessary for parsed patterns and are ignored when a `PathPatternParser` is available: `setAlwaysUseFullPath` -- parsed patterns always use the full path and consider the servletPath only when a Servlet is mapped by path prefix. `setRemoveSemicolonContent` -- parsed patterns always ignore semicolon content for path matching purposes, but path parameters remain available for use in controllers via `@MatrixVariable`. `setUrlDecode` -- parsed patterns match one decoded path segment at a time and therefore don't need to decode the full path. `setUrlPathHelper` -- for parsed patterns, the request path is parsed once in `DispatcherServlet` or in `ServletRequestPathFilter` using `ServletRequestPathUtils` and cached in a request attribute. `setPathMatcher` -- a parsed patterns encapsulates the logic for path matching and does need a `PathMatcher`. By default, as of 6.0, this is set to a `PathPatternParser` instance with default settings and therefore use of parsed patterns is enabled. Set this to `null` to switch to String path matching via `AntPathMatcher` instead. Parameters patternParser:PathPatternParser the parser to use Annotations @Override

public void setPatternParser(PathPatternParser patternParser)

Overrides org.springframework.web.servlet.handler.AbstractHandlerMapping.setPatternParser.

Doc from org.springframework.web.servlet.handler.AbstractHandlerMapping.setPatternParser.

Set the PathPatternParser to parse patterns with for URL path matching. Parsed patterns provide a more modern and efficient alternative to String path matching via AntPathMatcher.

Note: This property is mutually exclusive with the below properties, all of which are not necessary for parsed patterns and are ignored when a PathPatternParser is available:

setAlwaysUseFullPath -- parsed patterns always use the full path and consider the servletPath only when a Servlet is mapped by path prefix.
setRemoveSemicolonContent -- parsed patterns always ignore semicolon content for path matching purposes, but path parameters remain available for use in controllers via @MatrixVariable.
setUrlDecode -- parsed patterns match one decoded path segment at a time and therefore don't need to decode the full path.
setUrlPathHelper -- for parsed patterns, the request path is parsed once in DispatcherServlet or in ServletRequestPathFilter using ServletRequestPathUtils and cached in a request attribute.
setPathMatcher -- a parsed patterns encapsulates the logic for path matching and does need a PathMatcher.

By default, as of 6.0, this is set to a PathPatternParser instance with default settings and therefore use of parsed patterns is enabled. Set this to null to switch to String path matching via AntPathMatcher instead.

Parameters

patternParser:PathPatternParser: the parser to use

Annotations

@Override

setRootHandler back to summary

setRootHandler	back to summary
public void setRootHandler(Object rootHandler) Set the root handler for this handler mapping, that is, the handler to be registered for the root path ("/"). Default is `null`, indicating no root handler.

public void setRootHandler(Object rootHandler)

Set the root handler for this handler mapping, that is, the handler to be registered for the root path ("/").

Default is null, indicating no root handler.

setUseTrailingSlashMatch back to summary

setUseTrailingSlashMatch	back to summary
public void setUseTrailingSlashMatch(boolean useTrailingSlashMatch) Deprecated since 6.0. as of 6.0, see `PathPatternParser#setMatchOptionalTrailingSeparator(boolean)` Whether to match to URLs irrespective of the presence of a trailing slash. If enabled a URL pattern such as "/users" also matches to "/users/". The default value is `false`. Annotations @Deprecated since:6.0

public void setUseTrailingSlashMatch(boolean useTrailingSlashMatch)

Deprecated

since 6.0.

as of 6.0, see PathPatternParser#setMatchOptionalTrailingSeparator(boolean)

Whether to match to URLs irrespective of the presence of a trailing slash. If enabled a URL pattern such as "/users" also matches to "/users/".

The default value is false.

Annotations

@Deprecated
since:6.0

supportsTypeLevelMappings	back to summary
protected boolean supportsTypeLevelMappings() Indicates whether this handler mapping support type-level mappings. Default to `false`.

useTrailingSlashMatch	back to summary
public boolean useTrailingSlashMatch() Whether to match to URLs irrespective of the presence of a trailing slash.

validateHandler	back to summary
protected void validateHandler(Object handler, HttpServletRequest request) throws Exception Validate the given handler against the current request. The default implementation is empty. Can be overridden in subclasses, for example to enforce specific preconditions expressed in URL mappings. Parameters handler:Object the handler object to validate request:HttpServletRequest current HTTP request Exceptions Exception: if validation failed

validateHandler

back to summary

protected void validateHandler(Object handler, HttpServletRequest request) throws Exception

Validate the given handler against the current request.

The default implementation is empty. Can be overridden in subclasses, for example to enforce specific preconditions expressed in URL mappings.

Parameters

handler:Object: the handler object to validate
request:HttpServletRequest: current HTTP request

Exceptions

Exception:: if validation failed

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

private Class AbstractUrlHandlerMapping.PathExposingHandlerInterceptor

Class Inheritance

extends Object
implements HandlerInterceptor

java.lang.Object
org.springframework.web.servlet.handler.AbstractUrlHandlerMapping.PathExposingHandlerInterceptor

All Implemented Interfaces

org.springframework.web.servlet.HandlerInterceptor

Special interceptor for exposing the AbstractUrlHandlerMapping#PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE attribute.

See Also: AbstractUrlHandlerMapping#exposePathWithinMapping

Field Summary

Modifier and Type	Field and Description
private final String	bestMatchingPattern
private final String	pathWithinMapping

Constructor Summary

Access	Constructor and Description
public	PathExposingHandlerInterceptor(String bestMatchingPattern, String pathWithinMapping)

Method Summary

Modifier and Type	Method and Description
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.

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

Field Detail

bestMatchingPattern	back to summary
private final String bestMatchingPattern

pathWithinMapping	back to summary
private final String pathWithinMapping

Constructor Detail

PathExposingHandlerInterceptor	back to summary
public PathExposingHandlerInterceptor(String bestMatchingPattern, String pathWithinMapping)

Method Detail

preHandle back to summary

preHandle	back to summary
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) 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

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

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

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

private Class AbstractUrlHandlerMapping.UriTemplateVariablesHandlerInterceptor

Class Inheritance

extends Object
implements HandlerInterceptor

java.lang.Object
org.springframework.web.servlet.handler.AbstractUrlHandlerMapping.UriTemplateVariablesHandlerInterceptor

All Implemented Interfaces

org.springframework.web.servlet.HandlerInterceptor

Special interceptor for exposing the AbstractUrlHandlerMapping#URI_TEMPLATE_VARIABLES_ATTRIBUTE attribute.

See Also: AbstractUrlHandlerMapping#exposePathWithinMapping

Field Summary

Modifier and Type	Field and Description
private final Map<String, String>	uriTemplateVariables

Constructor Summary

Access	Constructor and Description
public	UriTemplateVariablesHandlerInterceptor(Map<String, String> uriTemplateVariables)

Method Summary

Modifier and Type	Method and Description
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.

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

Field Detail

uriTemplateVariables	back to summary
private final Map<String, String> uriTemplateVariables

Constructor Detail

UriTemplateVariablesHandlerInterceptor	back to summary
public UriTemplateVariablesHandlerInterceptor(Map<String, String> uriTemplateVariables)

Method Detail

preHandle back to summary

preHandle	back to summary
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) 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

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

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.

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

public abstract Class AbstractUrlHandlerMapping

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AbstractUrlHandlerMapping.PathExposingHandlerInterceptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AbstractUrlHandlerMapping.UriTemplateVariablesHandlerInterceptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail