Spring Framework 6.1.4 · org.springframework.web.servlet.handler.AbstractHandlerMapping

Modifier and Type	Class and Description
private class	AbstractHandlerMapping.CorsInterceptor
private class	AbstractHandlerMapping.PreFlightHandler

Modifier and Type	Field and Description
private final List<HandlerInterceptor>	adaptedInterceptors
private String	beanName
private CorsConfigurationSource	corsConfigurationSource
private CorsProcessor	corsProcessor
private Object	defaultHandler
private final List<Object>	interceptors
protected final Log	mappingsLogger Dedicated "hidden" logger for request mappings.
private int	order
private PathMatcher	pathMatcher
private PathPatternParser	patternParser
pack-priv static final String	SUPPRESS_LOGGING_ATTRIBUTE
private UrlPathHelper	urlPathHelper

Access	Constructor and Description
public	AbstractHandlerMapping()

Method Summary

Modifier and Type	Method and Description
protected HandlerInterceptor	Returns: the interceptor downcast or adapted to HandlerInterceptor adaptInterceptor(Object the interceptor interceptor) Adapt the given interceptor object to `HandlerInterceptor`.
protected void	detectMappedInterceptors(List<HandlerInterceptor> an empty list to add to mappedInterceptors) Detect beans of type `MappedInterceptor` and add them to the list of mapped interceptors.
protected void	extendInterceptors(List<Object> the configured interceptor List (never `null`), allowing to add further interceptors before as well as after the existing interceptors interceptors) Extension hook that subclasses can override to register additional interceptors, given the configured interceptors (see `setInterceptors`).
protected String	formatMappingName()
public final HandlerInterceptor[]	Returns: the array of configured interceptors, or `null` if none are configured; this method also returns `null` if called too early, or more specifically before `org.springframework.context.ApplicationContextAware#setApplicationContext`. getAdaptedInterceptors() Return all configured interceptors adapted to `HandlerInterceptor`.
protected CorsConfiguration	Returns: the CORS configuration for the handler, or `null` if none getCorsConfiguration(Object the handler to check (never `null`). handler, HttpServletRequest the current request. request) Retrieve the CORS configuration for the given handler.
public CorsConfigurationSource	getCorsConfigurationSource() Return the `configured` `CorsConfigurationSource`, if any.
protected HandlerExecutionChain	getCorsHandlerExecutionChain(HttpServletRequest the current request request, HandlerExecutionChain the chain to update chain, CorsConfiguration the CORS configuration applicable to the handler 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.
public CorsProcessor	getCorsProcessor() Return the configured `CorsProcessor`.
public Object	getDefaultHandler() Return the default handler for this handler mapping, or `null` if none.
public final HandlerExecutionChain	Returns: the corresponding handler instance, or the default handler getHandler(HttpServletRequest current HTTP request request) Implements org.springframework.web.servlet.HandlerMapping.getHandler. Look up a handler for the given request, falling back to the default handler if no specific one is found.
protected HandlerExecutionChain	Returns: the HandlerExecutionChain (never `null`) getHandlerExecutionChain(Object the resolved handler instance (never `null`) handler, HttpServletRequest current HTTP request request) Build a `HandlerExecutionChain` for the given handler, including applicable interceptors.
protected abstract Object	Returns: the corresponding handler instance, or `null` if none found getHandlerInternal(HttpServletRequest current HTTP request request) Look up a handler for the given request, returning `null` if no specific one is found.
protected final MappedInterceptor[]	Returns: the array of `MappedInterceptor`s, or `null` if none getMappedInterceptors() Return all configured `MappedInterceptor`s as an array.
public int	getOrder() Implements org.springframework.core.Ordered.getOrder. Get the order value of this object.
public PathMatcher	getPathMatcher() Return the `configured` `PathMatcher`.
public PathPatternParser	getPatternParser() Return the `configured` `PathPatternParser`, or `null` otherwise which indicates that String pattern matching with `AntPathMatcher` is enabled instead.
private RequestPath	getRequestPath(HttpServletRequest request)
public UrlPathHelper	getUrlPathHelper() Return the `configured` `UrlPathHelper`.
protected boolean	hasCorsConfigurationSource(Object handler) Return `true` if there is a `CorsConfigurationSource` for this handler.
protected void	initApplicationContext() Overrides org.springframework.context.support.ApplicationObjectSupport.initApplicationContext. Initializes the interceptors.
protected void	initInterceptors() Initialize the specified interceptors adapting `WebRequestInterceptor`s to `HandlerInterceptor`.
protected String	initLookupPath(HttpServletRequest request) Initialize the path to use for request mapping.
public void	setAlwaysUseFullPath(boolean alwaysUseFullPath) Deprecated since 6.0. as of 6.0, in favor of using `setUrlPathHelper(UrlPathHelper)` Shortcut to same property on the configured `UrlPathHelper`.
public void	setBeanName(String the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the `BeanFactoryUtils#originalBeanName(String)` method to extract the original bean name (without suffix), if desired. name) Implements org.springframework.beans.factory.BeanNameAware.setBeanName. Set the name of the bean in the bean factory that created this bean.
public void	setCorsConfigurations(Map<String, CorsConfiguration> corsConfigurations) Set "global" CORS configuration mappings.
public void	setCorsConfigurationSource(CorsConfigurationSource source) Set a `CorsConfigurationSource` for "global" CORS config.
public void	setCorsProcessor(CorsProcessor corsProcessor) Configure a custom `CorsProcessor` to use to apply the matched `CorsConfiguration` for a request.
public void	setDefaultHandler(Object defaultHandler) Set the default handler for this handler mapping.
public void	setInterceptors(Object... array of handler interceptors interceptors) Set the interceptors to apply for all handlers mapped by this handler mapping.
public void	setOrder(int order) Specify the order value for this HandlerMapping bean.
public void	setPathMatcher(PathMatcher pathMatcher) Configure the PathMatcher to use.
public void	setPatternParser(PathPatternParser the parser to use patternParser) Set the `PathPatternParser` to parse `patterns` with for URL path matching.
public void	setRemoveSemicolonContent(boolean removeSemicolonContent) Deprecated since 6.0. as of 6.0, in favor of using `setUrlPathHelper(UrlPathHelper)` Shortcut to same property on the underlying `UrlPathHelper`.
public void	setUrlDecode(boolean urlDecode) Deprecated since 6.0. as of 6.0, in favor of using `setUrlPathHelper(UrlPathHelper)` Shortcut to same property on the underlying `UrlPathHelper`.
public void	setUrlPathHelper(UrlPathHelper urlPathHelper) Configure the UrlPathHelper to use for resolution of lookup paths.
public boolean	usesPathPatterns() Overrides default org.springframework.web.servlet.HandlerMapping.usesPathPatterns. Return "true" if this `HandlerMapping` has been `enabled` to use parsed `PathPattern`s.

Inherited from org.springframework.web.context.support.WebApplicationObjectSupport:: getServletContext getTempDir getWebApplicationContext initApplicationContext initServletContext isContextRequired setServletContext

adaptedInterceptors	back to summary
private final List<HandlerInterceptor> adaptedInterceptors

beanName	back to summary
private String beanName Annotations @Nullable

corsConfigurationSource	back to summary
private CorsConfigurationSource corsConfigurationSource Annotations @Nullable

corsProcessor	back to summary
private CorsProcessor corsProcessor

defaultHandler	back to summary
private Object defaultHandler Annotations @Nullable

interceptors	back to summary
private final List<Object> interceptors

mappingsLogger	back to summary
protected final Log mappingsLogger Dedicated "hidden" logger for request mappings.

order	back to summary
private int order

pathMatcher	back to summary
private PathMatcher pathMatcher

patternParser	back to summary
private PathPatternParser patternParser Annotations @Nullable

SUPPRESS_LOGGING_ATTRIBUTE	back to summary
pack-priv static final String SUPPRESS_LOGGING_ATTRIBUTE

urlPathHelper	back to summary
private UrlPathHelper urlPathHelper

AbstractHandlerMapping	back to summary
public AbstractHandlerMapping()

Method Detail

adaptInterceptor back to summary

adaptInterceptor	back to summary
protected HandlerInterceptor adaptInterceptor(Object interceptor) Adapt the given interceptor object to `HandlerInterceptor`. By default, the supported interceptor types are `HandlerInterceptor` and `WebRequestInterceptor`. Each given `WebRequestInterceptor` is wrapped with `WebRequestHandlerInterceptorAdapter`. Parameters interceptor:Object the interceptor Returns:HandlerInterceptor the interceptor downcast or adapted to HandlerInterceptor See Also `org.springframework.web.servlet.HandlerInterceptor`, `org.springframework.web.context.request.WebRequestInterceptor`, `WebRequestHandlerInterceptorAdapter`

protected HandlerInterceptor adaptInterceptor(Object interceptor)

Adapt the given interceptor object to HandlerInterceptor.

By default, the supported interceptor types are HandlerInterceptor and WebRequestInterceptor. Each given WebRequestInterceptor is wrapped with WebRequestHandlerInterceptorAdapter.

Parameters

interceptor:Object: the interceptor

Returns:HandlerInterceptor

the interceptor downcast or adapted to HandlerInterceptor

detectMappedInterceptors back to summary

detectMappedInterceptors	back to summary
protected void detectMappedInterceptors(List<HandlerInterceptor> mappedInterceptors) Detect beans of type `MappedInterceptor` and add them to the list of mapped interceptors. This is called in addition to any `MappedInterceptor`s that may have been provided via `setInterceptors`, by default adding all beans of type `MappedInterceptor` from the current context and its ancestors. Subclasses can override and refine this policy. Parameters mappedInterceptors:List<HandlerInterceptor> an empty list to add to

protected void detectMappedInterceptors(List<HandlerInterceptor> mappedInterceptors)

Detect beans of type MappedInterceptor and add them to the list of mapped interceptors.

This is called in addition to any MappedInterceptors that may have been provided via setInterceptors, by default adding all beans of type MappedInterceptor from the current context and its ancestors. Subclasses can override and refine this policy.

Parameters

mappedInterceptors:List<HandlerInterceptor>: an empty list to add to

extendInterceptors back to summary

extendInterceptors	back to summary
protected void extendInterceptors(List<Object> interceptors) Extension hook that subclasses can override to register additional interceptors, given the configured interceptors (see `setInterceptors`). Will be invoked before `initInterceptors()` adapts the specified interceptors into `HandlerInterceptor` instances. The default implementation is empty. Parameters interceptors:List<Object> the configured interceptor List (never `null`), allowing to add further interceptors before as well as after the existing interceptors

protected void extendInterceptors(List<Object> interceptors)

Extension hook that subclasses can override to register additional interceptors, given the configured interceptors (see setInterceptors).

Will be invoked before initInterceptors() adapts the specified interceptors into HandlerInterceptor instances.

The default implementation is empty.

Parameters

interceptors:List<Object>: the configured interceptor List (never null), allowing to add further interceptors before as well as after the existing interceptors

formatMappingName	back to summary
protected String formatMappingName()

getAdaptedInterceptors back to summary

getAdaptedInterceptors	back to summary
public final HandlerInterceptor[] getAdaptedInterceptors() Return all configured interceptors adapted to `HandlerInterceptor`. Returns:HandlerInterceptor[] the array of configured interceptors, or `null` if none are configured; this method also returns `null` if called too early, or more specifically before `org.springframework.context.ApplicationContextAware#setApplicationContext`. Annotations @Nullable

public final HandlerInterceptor[] getAdaptedInterceptors()

Return all configured interceptors adapted to HandlerInterceptor.

Returns:HandlerInterceptor[]

the array of configured interceptors, or null if none are configured; this method also returns null if called too early, or more specifically before org.springframework.context.ApplicationContextAware#setApplicationContext.

Annotations

@Nullable

getCorsConfiguration back to summary

getCorsConfiguration	back to summary
protected CorsConfiguration getCorsConfiguration(Object handler, HttpServletRequest request) Retrieve the CORS configuration for the given handler. Parameters handler:Object the handler to check (never `null`). request:HttpServletRequest the current request. Returns:CorsConfiguration the CORS configuration for the handler, or `null` if none Annotations @Nullable Since 4.2

protected CorsConfiguration getCorsConfiguration(Object handler, HttpServletRequest request)

Retrieve the CORS configuration for the given handler.

Parameters

handler:Object: the handler to check (never null).
request:HttpServletRequest: the current request.

Returns:CorsConfiguration

the CORS configuration for the handler, or null if none

Annotations

@Nullable

Since

4.2

getCorsConfigurationSource back to summary

getCorsConfigurationSource	back to summary
public CorsConfigurationSource getCorsConfigurationSource() Return the `configured` `CorsConfigurationSource`, if any. Annotations @Nullable Since 5.3

public CorsConfigurationSource getCorsConfigurationSource()

Return the configured CorsConfigurationSource, if any.

Annotations

@Nullable

Since

5.3

getCorsHandlerExecutionChain back to summary

getCorsHandlerExecutionChain	back to summary
protected HandlerExecutionChain getCorsHandlerExecutionChain(HttpServletRequest request, HandlerExecutionChain chain, 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. Parameters request:HttpServletRequest the current request chain:HandlerExecutionChain the chain to update config:CorsConfiguration the CORS configuration applicable to the handler Since 4.2

protected HandlerExecutionChain getCorsHandlerExecutionChain(HttpServletRequest request, HandlerExecutionChain chain, 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.

Parameters

request:HttpServletRequest: the current request
chain:HandlerExecutionChain: the chain to update
config:CorsConfiguration: the CORS configuration applicable to the handler

Since

4.2

getCorsProcessor	back to summary
public CorsProcessor getCorsProcessor() Return the configured `CorsProcessor`.

getDefaultHandler back to summary

getDefaultHandler	back to summary
public Object getDefaultHandler() Return the default handler for this handler mapping, or `null` if none. Annotations @Nullable

public Object getDefaultHandler()

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

Annotations

@Nullable

getHandler back to summary

getHandler	back to summary
public final HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception Implements org.springframework.web.servlet.HandlerMapping.getHandler. Look up a handler for the given request, falling back to the default handler if no specific one is found. Parameters request:HttpServletRequest current HTTP request Returns:HandlerExecutionChain the corresponding handler instance, or the default handler Annotations @Override @Nullable Exceptions Exception: Doc from org.springframework.web.servlet.HandlerMapping.getHandler. if there is an internal error See Also `getHandlerInternal`

public final HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception

Implements org.springframework.web.servlet.HandlerMapping.getHandler.

Look up a handler for the given request, falling back to the default handler if no specific one is found.

Parameters

request:HttpServletRequest: current HTTP request

Returns:HandlerExecutionChain

the corresponding handler instance, or the default handler

Annotations

@Override
@Nullable

Exceptions

Exception:

Doc from org.springframework.web.servlet.HandlerMapping.getHandler.

if there is an internal error

See Also

getHandlerInternal

getHandlerExecutionChain back to summary

getHandlerExecutionChain	back to summary
protected HandlerExecutionChain getHandlerExecutionChain(Object handler, HttpServletRequest request) Build a `HandlerExecutionChain` for the given handler, including applicable interceptors. The default implementation builds a standard `HandlerExecutionChain` with the given handler, the common interceptors of the handler mapping, and any `MappedInterceptors` matching to the current request URL. Interceptors are added in the order they were registered. Subclasses may override this in order to extend/rearrange the list of interceptors. Note The passed-in handler object may be a raw handler or a pre-built `HandlerExecutionChain`. This method should handle those two cases explicitly, either building a new `HandlerExecutionChain` or extending the existing chain. For simply adding an interceptor in a custom subclass, consider calling `super.getHandlerExecutionChain(handler, request)` and invoking `HandlerExecutionChain#addInterceptor` on the returned chain object. Parameters handler:Object the resolved handler instance (never `null`) request:HttpServletRequest current HTTP request Returns:HandlerExecutionChain the HandlerExecutionChain (never `null`) See Also `getAdaptedInterceptors()`

protected HandlerExecutionChain getHandlerExecutionChain(Object handler, HttpServletRequest request)

Build a HandlerExecutionChain for the given handler, including applicable interceptors.

The default implementation builds a standard HandlerExecutionChain with the given handler, the common interceptors of the handler mapping, and any MappedInterceptors matching to the current request URL. Interceptors are added in the order they were registered. Subclasses may override this in order to extend/rearrange the list of interceptors.

Note

The passed-in handler object may be a raw handler or a pre-built HandlerExecutionChain. This method should handle those two cases explicitly, either building a new HandlerExecutionChain or extending the existing chain.

For simply adding an interceptor in a custom subclass, consider calling super.getHandlerExecutionChain(handler, request) and invoking HandlerExecutionChain#addInterceptor on the returned chain object.

Parameters

handler:Object: the resolved handler instance (never null)
request:HttpServletRequest: current HTTP request

Returns:HandlerExecutionChain

the HandlerExecutionChain (never null)

See Also

getAdaptedInterceptors()

getHandlerInternal back to summary

getHandlerInternal	back to summary
protected abstract Object getHandlerInternal(HttpServletRequest request) throws Exception Look up a handler for the given request, returning `null` if no specific one is found. This method is called by `getHandler`; a `null` return value will lead to the default handler, if one is set. On CORS pre-flight requests this method should return a match not for the pre-flight request but for the expected actual request based on the URL path, the HTTP methods from the "Access-Control-Request-Method" header, and the headers from the "Access-Control-Request-Headers" header thus allowing the CORS configuration to be obtained via `getCorsConfiguration(Object, HttpServletRequest)`, Note This method may also return a pre-built `HandlerExecutionChain`, combining a handler object with dynamically determined interceptors. Statically specified interceptors will get merged into such an existing chain. Parameters request:HttpServletRequest current HTTP request Returns:Object the corresponding handler instance, or `null` if none found Annotations @Nullable Exceptions Exception: if there is an internal error

protected abstract Object getHandlerInternal(HttpServletRequest request) throws Exception

Look up a handler for the given request, returning null if no specific one is found. This method is called by getHandler; a null return value will lead to the default handler, if one is set.

On CORS pre-flight requests this method should return a match not for the pre-flight request but for the expected actual request based on the URL path, the HTTP methods from the "Access-Control-Request-Method" header, and the headers from the "Access-Control-Request-Headers" header thus allowing the CORS configuration to be obtained via getCorsConfiguration(Object, HttpServletRequest),

Note

This method may also return a pre-built HandlerExecutionChain, combining a handler object with dynamically determined interceptors. Statically specified interceptors will get merged into such an existing chain.

Parameters

request:HttpServletRequest: current HTTP request

Returns:Object

the corresponding handler instance, or null if none found

Annotations

@Nullable

Exceptions

Exception:: if there is an internal error

getMappedInterceptors back to summary

getMappedInterceptors	back to summary
protected final MappedInterceptor[] getMappedInterceptors() Return all configured `MappedInterceptor`s as an array. Returns:MappedInterceptor[] the array of `MappedInterceptor`s, or `null` if none Annotations @Nullable

protected final MappedInterceptor[] getMappedInterceptors()

Return all configured MappedInterceptors as an array.

Returns:MappedInterceptor[]

the array of MappedInterceptors, or null if none

Annotations

@Nullable

getOrder back to summary

getOrder	back to summary
public int getOrder() Implements org.springframework.core.Ordered.getOrder. Doc from org.springframework.core.Ordered.getOrder. Get the order value of this object. Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet `load-on-startup` values). Same order values will result in arbitrary sort positions for the affected objects. Returns:int the order value Annotations @Override

public int getOrder()

Implements org.springframework.core.Ordered.getOrder.

Doc from org.springframework.core.Ordered.getOrder.

Get the order value of this object.

Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet load-on-startup values).

Same order values will result in arbitrary sort positions for the affected objects.

Returns:int

the order value

Annotations

@Override

getPathMatcher	back to summary
public PathMatcher getPathMatcher() Return the `configured` `PathMatcher`.

getPatternParser back to summary

getPatternParser	back to summary
public PathPatternParser getPatternParser() Return the `configured` `PathPatternParser`, or `null` otherwise which indicates that String pattern matching with `AntPathMatcher` is enabled instead. Annotations @Nullable Since 5.3

public PathPatternParser getPatternParser()

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

Annotations

@Nullable

Since

5.3

getRequestPath	back to summary
private RequestPath getRequestPath(HttpServletRequest request)

getUrlPathHelper	back to summary
public UrlPathHelper getUrlPathHelper() Return the `configured` `UrlPathHelper`.

hasCorsConfigurationSource back to summary

hasCorsConfigurationSource	back to summary
protected boolean hasCorsConfigurationSource(Object handler) Return `true` if there is a `CorsConfigurationSource` for this handler. Since 5.2

protected boolean hasCorsConfigurationSource(Object handler)

Return true if there is a CorsConfigurationSource for this handler.

Since: 5.2

initApplicationContext back to summary

initApplicationContext	back to summary
protected void initApplicationContext() throws BeansException Overrides org.springframework.context.support.ApplicationObjectSupport.initApplicationContext. Initializes the interceptors. Annotations @Override Exceptions BeansException: Doc from org.springframework.context.support.ApplicationObjectSupport.initApplicationContext. if thrown by ApplicationContext methods See Also `extendInterceptors(java.util.List)`, `initInterceptors()`

protected void initApplicationContext() throws BeansException

Overrides org.springframework.context.support.ApplicationObjectSupport.initApplicationContext.

Initializes the interceptors.

Annotations

@Override

Exceptions

BeansException:

Doc from org.springframework.context.support.ApplicationObjectSupport.initApplicationContext.

if thrown by ApplicationContext methods

initInterceptors back to summary

initInterceptors	back to summary
protected void initInterceptors() Initialize the specified interceptors adapting `WebRequestInterceptor`s to `HandlerInterceptor`. See Also `setInterceptors`, `adaptInterceptor`

protected void initInterceptors()

Initialize the specified interceptors adapting WebRequestInterceptors to HandlerInterceptor.

See Also: setInterceptors, adaptInterceptor

initLookupPath back to summary

initLookupPath	back to summary
protected String initLookupPath(HttpServletRequest request) Initialize the path to use for request mapping. When parsed patterns are `enabled` a parsed `RequestPath` is expected to have been `parsed` externally by the `org.springframework.web.servlet.DispatcherServlet` or `org.springframework.web.filter.ServletRequestPathFilter`. Otherwise for String pattern matching via `PathMatcher` the path is `resolved` by this method. Since 5.3

protected String initLookupPath(HttpServletRequest request)

Initialize the path to use for request mapping.

When parsed patterns are enabled a parsed RequestPath is expected to have been parsed externally by the org.springframework.web.servlet.DispatcherServlet or org.springframework.web.filter.ServletRequestPathFilter.

Otherwise for String pattern matching via PathMatcher the path is resolved by this method.

Since: 5.3

setAlwaysUseFullPath back to summary

setAlwaysUseFullPath	back to summary
public void setAlwaysUseFullPath(boolean alwaysUseFullPath) Deprecated since 6.0. 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. Annotations @Deprecated since:6.0 See Also `org.springframework.web.util.UrlPathHelper#setAlwaysUseFullPath(boolean)`

public void setAlwaysUseFullPath(boolean alwaysUseFullPath)

Deprecated

since 6.0.

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.

Annotations

@Deprecated
since:6.0

setBeanName back to summary

setBeanName	back to summary
public void setBeanName(String name) Implements org.springframework.beans.factory.BeanNameAware.setBeanName. Doc from org.springframework.beans.factory.BeanNameAware.setBeanName. Set the name of the bean in the bean factory that created this bean. Invoked after population of normal bean properties but before an init callback such as `InitializingBean#afterPropertiesSet()` or a custom init-method. Parameters name:String the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the `BeanFactoryUtils#originalBeanName(String)` method to extract the original bean name (without suffix), if desired. Annotations @Override

public void setBeanName(String name)

Implements org.springframework.beans.factory.BeanNameAware.setBeanName.

Doc from org.springframework.beans.factory.BeanNameAware.setBeanName.

Set the name of the bean in the bean factory that created this bean.

Invoked after population of normal bean properties but before an init callback such as InitializingBean#afterPropertiesSet() or a custom init-method.

Parameters

name:String: the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the BeanFactoryUtils#originalBeanName(String) method to extract the original bean name (without suffix), if desired.

Annotations

@Override

setCorsConfigurations back to summary

setCorsConfigurations	back to summary
public void setCorsConfigurations(Map<String, CorsConfiguration> corsConfigurations) Set "global" CORS configuration mappings. The first matching URL pattern determines the `CorsConfiguration` to use which is then further `combined` with the `CorsConfiguration` for the selected handler. This is mutually exclusive with `setCorsConfigurationSource(CorsConfigurationSource)`. Since 4.2 See Also `setCorsProcessor(CorsProcessor)`

public void setCorsConfigurations(Map<String, CorsConfiguration> corsConfigurations)

Set "global" CORS configuration mappings. The first matching URL pattern determines the CorsConfiguration to use which is then further combined with the CorsConfiguration for the selected handler.

This is mutually exclusive with setCorsConfigurationSource(CorsConfigurationSource).

Since: 4.2
See Also: setCorsProcessor(CorsProcessor)

setCorsConfigurationSource back to summary

setCorsConfigurationSource	back to summary
public void setCorsConfigurationSource(CorsConfigurationSource source) Set a `CorsConfigurationSource` for "global" CORS config. The `CorsConfiguration` determined by the source is `combined` with the `CorsConfiguration` for the selected handler. This is mutually exclusive with `setCorsConfigurations(Map)`. Since 5.1 See Also `setCorsProcessor(CorsProcessor)`

public void setCorsConfigurationSource(CorsConfigurationSource source)

Set a CorsConfigurationSource for "global" CORS config. The CorsConfiguration determined by the source is combined with the CorsConfiguration for the selected handler.

This is mutually exclusive with setCorsConfigurations(Map).

Since: 5.1
See Also: setCorsProcessor(CorsProcessor)

setCorsProcessor back to summary

setCorsProcessor	back to summary
public void setCorsProcessor(CorsProcessor corsProcessor) Configure a custom `CorsProcessor` to use to apply the matched `CorsConfiguration` for a request. By default `DefaultCorsProcessor` is used. Since 4.2

public void setCorsProcessor(CorsProcessor corsProcessor)

Configure a custom CorsProcessor to use to apply the matched CorsConfiguration for a request.

By default DefaultCorsProcessor is used.

Since: 4.2

setDefaultHandler back to summary

setDefaultHandler	back to summary
public void setDefaultHandler(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.

public void setDefaultHandler(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.

setInterceptors back to summary

setInterceptors	back to summary
public void setInterceptors(Object... interceptors) Set the interceptors to apply for all handlers mapped by this handler mapping. Supported interceptor types are `HandlerInterceptor`, `WebRequestInterceptor`, and `MappedInterceptor`. Mapped interceptors apply only to request URLs that match its path patterns. Mapped interceptor beans are also detected by type during initialization. Parameters interceptors:Object[] array of handler interceptors See Also `adaptInterceptor`, `org.springframework.web.servlet.HandlerInterceptor`, `org.springframework.web.context.request.WebRequestInterceptor`, `MappedInterceptor`

public void setInterceptors(Object... interceptors)

Set the interceptors to apply for all handlers mapped by this handler mapping.

Supported interceptor types are HandlerInterceptor, WebRequestInterceptor, and MappedInterceptor. Mapped interceptors apply only to request URLs that match its path patterns. Mapped interceptor beans are also detected by type during initialization.

Parameters

interceptors:Object[]: array of handler interceptors

setOrder back to summary

setOrder	back to summary
public void setOrder(int order) Specify the order value for this HandlerMapping bean. The default value is `Ordered.LOWEST_PRECEDENCE`, meaning non-ordered. See Also `org.springframework.core.Ordered#getOrder()`

public void setOrder(int order)

Specify the order value for this HandlerMapping bean.

The default value is Ordered.LOWEST_PRECEDENCE, meaning non-ordered.

See Also: org.springframework.core.Ordered#getOrder()

setPathMatcher back to summary

setPathMatcher	back to summary
public void setPathMatcher(PathMatcher pathMatcher) Configure the PathMatcher to use. Note This property is mutually exclusive with and ignored when `setPatternParser(PathPatternParser)` is set. By default this is `AntPathMatcher`. See Also `org.springframework.util.AntPathMatcher`

public void setPathMatcher(PathMatcher pathMatcher)

Configure the PathMatcher to use.

Note

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

By default this is AntPathMatcher.

See Also: org.springframework.util.AntPathMatcher

setPatternParser back to summary

setPatternParser	back to summary
public void setPatternParser(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` -- 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 Since 5.3

public void setPatternParser(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 -- 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

Since

5.3

setRemoveSemicolonContent back to summary

public void setRemoveSemicolonContent(boolean removeSemicolonContent)

Deprecated

since 6.0.

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.

Annotations

@Deprecated
since:6.0

setUrlDecode back to summary

public void setUrlDecode(boolean urlDecode)

Deprecated

since 6.0.

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.

Annotations

@Deprecated
since:6.0

setUrlPathHelper	back to summary
public void setUrlPathHelper(UrlPathHelper urlPathHelper) Configure the UrlPathHelper to use for resolution of lookup paths. Note This property is mutually exclusive with and ignored when `setPatternParser(PathPatternParser)` is set.

usesPathPatterns back to summary

public boolean usesPathPatterns()

Overrides default org.springframework.web.servlet.HandlerMapping.usesPathPatterns.

Return "true" if this HandlerMapping has been enabled to use parsed PathPatterns.

Annotations

@Override

public abstract Class AbstractHandlerMapping

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AbstractHandlerMapping.CorsInterceptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class AbstractHandlerMapping.PreFlightHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public CorsConfiguration	getCorsConfiguration(HttpServletRequest request) Implements org.springframework.web.cors.CorsConfigurationSource.getCorsConfiguration. Return a `CorsConfiguration` based on the incoming request.
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.