Class AbstractHandlerMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.handler.AbstractHandlerMapping

All Implemented Interfaces:

Aware, BeanNameAware, ApplicationContextAware, Ordered, ServletContextAware, HandlerMapping

Direct Known Subclasses:

AbstractHandlerMethodMapping, AbstractUrlHandlerMapping, RouterFunctionMapping

public abstract class AbstractHandlerMapping
extends WebApplicationObjectSupport
implements HandlerMapping, Ordered, BeanNameAware

Abstract base class for HandlerMapping implementations. Supports ordering, a default handler, and handler interceptors, including handler interceptors mapped by path patterns.

Note: This base class does not support exposure of the HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE. Support for this attribute is up to concrete subclasses, typically based on request URL mappings.

Since:

07.04.2003

Author:

Juergen Hoeller, Rossen Stoyanchev, Sam Brannen

See Also:

• getHandlerInternal(HttpServletRequest)
• setDefaultHandler(Object)
• setInterceptors(Object...)
• HandlerInterceptor

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.commons.logging.Log	mappingsLogger	Dedicated "hidden" logger for request mappings.

Fields inherited from class ApplicationObjectSupport

logger

Fields inherited from interface HandlerMapping

API_VERSION_ATTRIBUTE, BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, LOOKUP_PATH, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AbstractHandlerMapping()

Method Summary

Modifier and Type	Method	Description
protected HandlerInterceptor	adaptInterceptor(Object interceptor)	Adapt the given interceptor object to HandlerInterceptor.
protected void	detectMappedInterceptors(List<HandlerInterceptor> mappedInterceptors)	Detect beans of type MappedInterceptor and add them to the list of mapped interceptors.
protected void	extendInterceptors(List<Object> interceptors)	Extension hook that subclasses can override to register additional interceptors, given the configured interceptors (see setInterceptors(Object...)).
protected String	formatMappingName()
final HandlerInterceptor @Nullable []	getAdaptedInterceptors()	Return all configured interceptors adapted to HandlerInterceptor.
@Nullable ApiVersionStrategy	getApiVersionStrategy()	Return the configured ApiVersionStrategy strategy.
protected @Nullable CorsConfiguration	getCorsConfiguration(Object handler, jakarta.servlet.http.HttpServletRequest request)	Retrieve the CORS configuration for the given handler.
@Nullable CorsConfigurationSource	getCorsConfigurationSource()	Return the configured CorsConfigurationSource, if any.
protected HandlerExecutionChain	getCorsHandlerExecutionChain(jakarta.servlet.http.HttpServletRequest request, HandlerExecutionChain chain, @Nullable CorsConfiguration config)	Update HandlerExecutionChain for CORS requests, inserting an interceptor at the start of the chain to perform CORS checks, and also using a no-op handler for preflight requests.
CorsProcessor	getCorsProcessor()	Return the configured CorsProcessor.
@Nullable Object	getDefaultHandler()	Return the default handler for this handler mapping, or null if none.
final @Nullable HandlerExecutionChain	getHandler(jakarta.servlet.http.HttpServletRequest request)	Look up a handler for the given request, falling back to the default handler if no specific one is found.
protected HandlerExecutionChain	getHandlerExecutionChain(Object handler, jakarta.servlet.http.HttpServletRequest request)	Build a HandlerExecutionChain for the given handler, including applicable interceptors.
protected abstract @Nullable Object	getHandlerInternal(jakarta.servlet.http.HttpServletRequest request)	Look up a handler for the given request, returning null if no specific one is found.
protected final MappedInterceptor @Nullable []	getMappedInterceptors()	Return all configured MappedInterceptors as an array.
int	getOrder()	Get the order value of this object.
PathMatcher	getPathMatcher()	Deprecated, for removal: This API element is subject to removal in a future version. use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.
@Nullable PathPatternParser	getPatternParser()	Return the configured PathPatternParser, or null otherwise which indicates that String pattern matching with AntPathMatcher is enabled instead.
UrlPathHelper	getUrlPathHelper()	Deprecated, for removal: This API element is subject to removal in a future version. use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.
protected boolean	hasCorsConfigurationSource(Object handler)	Return true if there is a CorsConfigurationSource for this handler.
protected void	initApplicationContext()	Initializes the interceptors.
protected void	initInterceptors()	Initialize the specified interceptors adapting WebRequestInterceptors to HandlerInterceptor.
protected String	initLookupPath(jakarta.servlet.http.HttpServletRequest request)	Initialize the path to use for request mapping.
void	setAlwaysUseFullPath(boolean alwaysUseFullPath)	Deprecated. as of 6.0, in favor of using setUrlPathHelper(UrlPathHelper)
void	setApiVersionStrategy(@Nullable ApiVersionStrategy strategy)	Configure a strategy to manage API versioning.
void	setBeanName(String name)	Set the name of the bean in the bean factory that created this bean.
void	setCorsConfigurations(Map<String, CorsConfiguration> corsConfigurations)	Set "global" CORS configuration mappings.
void	setCorsConfigurationSource(CorsConfigurationSource source)	Set a CorsConfigurationSource for "global" CORS config.
void	setCorsProcessor(CorsProcessor corsProcessor)	Configure a custom CorsProcessor to use to apply the matched CorsConfiguration for a request.
void	setDefaultHandler(@Nullable Object defaultHandler)	Set the default handler for this handler mapping.
void	setInterceptors(Object... interceptors)	Set the interceptors to apply for all handlers mapped by this handler mapping.
void	setOrder(int order)	Specify the order value for this HandlerMapping bean.
void	setPathMatcher(PathMatcher pathMatcher)	Deprecated, for removal: This API element is subject to removal in a future version. use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.
void	setPatternParser(@Nullable PathPatternParser patternParser)	Set the PathPatternParser to parse patterns with for URL path matching.
void	setRemoveSemicolonContent(boolean removeSemicolonContent)	Deprecated. as of 6.0, in favor of using setUrlPathHelper(UrlPathHelper)
void	setUrlDecode(boolean urlDecode)	Deprecated. as of 6.0, in favor of using setUrlPathHelper(UrlPathHelper)
void	setUrlPathHelper(UrlPathHelper urlPathHelper)	Deprecated, for removal: This API element is subject to removal in a future version. use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.
boolean	usesPathPatterns()	Return "true" if this HandlerMapping has been enabled to use parsed PathPatterns.

Methods inherited from class WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class Object

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

Field Details

mappingsLogger

protected final org.apache.commons.logging.Log mappingsLogger

Dedicated "hidden" logger for request mappings.

Constructor Details

AbstractHandlerMapping

public AbstractHandlerMapping()

Method Details

setDefaultHandler

public void setDefaultHandler(@Nullable Object defaultHandler)

Set the default handler for this handler mapping. This handler will be returned if no specific mapping was found.

Default is null, indicating no default handler.

getDefaultHandler

public @Nullable Object getDefaultHandler()

Return the default handler for this handler mapping, or null if none.

setPatternParser

public void setPatternParser(@Nullable PathPatternParser patternParser)

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(boolean) -- parsed patterns always use the full path and consider the servletPath only when a Servlet is mapped by path prefix.
• setRemoveSemicolonContent(boolean) -- parsed patterns always ignore semicolon content for path matching purposes, but path parameters remain available for use in controllers via @MatrixVariable.
• setUrlDecode(boolean) -- parsed patterns match one decoded path segment at a time and therefore don't need to decode the full path.
• setUrlPathHelper(UrlPathHelper) -- for parsed patterns, the request path is parsed once in DispatcherServlet or in ServletRequestPathFilter using ServletRequestPathUtils and cached in a request attribute.
• setPathMatcher(PathMatcher) -- 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 - the parser to use

Since:

5.3

getPatternParser

public @Nullable PathPatternParser getPatternParser()

Return the configured PathPatternParser, or null otherwise which indicates that String pattern matching with AntPathMatcher is enabled instead.

Since:

5.3

setAlwaysUseFullPath

@Deprecated(since="6.0")
public void setAlwaysUseFullPath(boolean alwaysUseFullPath)

Deprecated.

as of 6.0, in favor of using setUrlPathHelper(UrlPathHelper)

Shortcut to same property on the configured UrlPathHelper.

Note: This property is mutually exclusive with and ignored when setPatternParser(PathPatternParser) is set.

See Also:

• UrlPathHelper.setAlwaysUseFullPath(boolean)

setUrlDecode

@Deprecated(since="6.0")
public void setUrlDecode(boolean urlDecode)

Deprecated.

as of 6.0, in favor of using setUrlPathHelper(UrlPathHelper)

Shortcut to same property on the underlying UrlPathHelper.

Note: This property is mutually exclusive with and ignored when setPatternParser(PathPatternParser) is set.

See Also:

• UrlPathHelper.setUrlDecode(boolean)

setRemoveSemicolonContent

@Deprecated(since="6.0")
public void setRemoveSemicolonContent(boolean removeSemicolonContent)

Deprecated.

as of 6.0, in favor of using setUrlPathHelper(UrlPathHelper)

Shortcut to same property on the underlying UrlPathHelper.

Note: This property is mutually exclusive with and ignored when setPatternParser(PathPatternParser) is set.

See Also:

• UrlPathHelper.setRemoveSemicolonContent(boolean)

setUrlPathHelper

@Deprecated(since="7.0",
            forRemoval=true)
public void setUrlPathHelper(UrlPathHelper urlPathHelper)

Deprecated, for removal: This API element is subject to removal in a future version.

use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.

Configure the UrlPathHelper to use for resolution of lookup paths.

Note: This property is mutually exclusive with and ignored when setPatternParser(PathPatternParser) is set.

getUrlPathHelper

@Deprecated(since="7.0",
            forRemoval=true)
public UrlPathHelper getUrlPathHelper()

Deprecated, for removal: This API element is subject to removal in a future version.

use of PathMatcher and