org.springframework.web.reactive.handler

Class AbstractUrlHandlerMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.reactive.handler.AbstractHandlerMapping

org.springframework.web.reactive.handler.AbstractUrlHandlerMapping

All Implemented Interfaces:

Aware, ApplicationContextAware, Ordered, HandlerMapping

Direct Known Subclasses:

SimpleUrlHandlerMapping

public abstract class AbstractUrlHandlerMapping
extends AbstractHandlerMapping

Abstract base class for URL-mapped HandlerMapping implementations.

Supports direct matches, e.g. a registered "/test" matches "/test", and various Ant-style pattern matches, e.g. a registered "/t*" pattern matches both "/test" and "/team", "/test/*" matches all paths under "/test", "/test/**" matches all paths below "/test". For details, see the ParsingPathMatcher javadoc.

Will search all path patterns to find the most exact match for the current request path. The most exact match is defined as the longest path pattern that matches the current request path.

Since:

5.0

Author:

Rossen Stoyanchev, Juergen Hoeller

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Object>	handlerMap
private boolean	lazyInitHandlers
private boolean	useTrailingSlashMatch

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.web.reactive.HandlerMapping

BEST_MATCHING_PATTERN_ATTRIBUTE, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractUrlHandlerMapping()

Method Summary

Modifier and Type	Method and Description
private java.lang.String	getHandlerDescription(java.lang.Object handler)
<any>	getHandlerInternal(ServerWebExchange exchange) Look up a handler for the given request, returning an empty Mono if no specific one is found.
java.util.Map<java.lang.String,java.lang.Object>	getHandlerMap() Return the registered handlers as an unmodifiable Map, with the registered path as key and the handler object (or handler bean name in case of a lazy-init handler) as value.
private java.lang.Object	handleMatch(java.lang.Object handler, java.lang.String bestMatch, java.lang.String pathWithinMapping, ServerWebExchange exchange)
protected java.lang.Object	lookupHandler(java.lang.String urlPath, ServerWebExchange exchange) Look up a handler instance for the given URL path.
protected void	registerHandler(java.lang.String[] urlPaths, java.lang.String beanName) Register the specified handler for the given URL paths.
protected void	registerHandler(java.lang.String urlPath, java.lang.Object handler) Register the specified handler for the given URL path.
void	setLazyInitHandlers(boolean lazyInitHandlers) Set whether to lazily initialize handlers.
void	setUseTrailingSlashMatch(boolean useTrailingSlashMatch) Whether to match to URLs irrespective of the presence of a trailing slash.
boolean	useTrailingSlashMatch() Whether to match to URLs irrespective of the presence of a trailing slash.
protected void	validateHandler(java.lang.Object handler, ServerWebExchange exchange) Validate the given handler against the current request.

Methods inherited from class org.springframework.web.reactive.handler.AbstractHandlerMapping

getCorsConfiguration, getCorsConfigurations, getCorsProcessor, getHandler, getOrder, getPathHelper, getPathMatcher, setCorsConfigurations, setCorsProcessor, setOrder, setPathHelper, setPathMatcher, setUrlDecode

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, initApplicationContext, isContextRequired, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

useTrailingSlashMatch

private boolean useTrailingSlashMatch

lazyInitHandlers

private boolean lazyInitHandlers

handlerMap

private final java.util.Map<java.lang.String,java.lang.Object> handlerMap

Constructor Detail

AbstractUrlHandlerMapping

public AbstractUrlHandlerMapping()

Method Detail

setUseTrailingSlashMatch

public void setUseTrailingSlashMatch(boolean useTrailingSlashMatch)

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.

useTrailingSlashMatch

public boolean useTrailingSlashMatch()

Whether to match to URLs irrespective of the presence of a trailing slash.

setLazyInitHandlers

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.

getHandlerMap

public final java.util.Map<java.lang.String,java.lang.Object> getHandlerMap()

Return the registered handlers as an unmodifiable Map, with the registered path as key and the handler object (or handler bean name in case of a lazy-init handler) as value.

getHandlerInternal

public <any> getHandlerInternal(ServerWebExchange exchange)

Description copied from class: AbstractHandlerMapping

Look up a handler for the given request, returning an empty Mono if no specific one is found. This method is called by AbstractHandlerMapping.getHandler(org.springframework.web.server.ServerWebExchange).

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 AbstractHandlerMapping.getCorsConfigurations(),

Specified by:

getHandlerInternal in class AbstractHandlerMapping

Parameters:

exchange - current exchange

Returns:

Mono for the matching handler, if any

lookupHandler

protected java.lang.Object lookupHandler(java.lang.String urlPath,
                                         ServerWebExchange exchange)
                                  throws java.lang.Exception

Look up a handler instance for the given URL path.

Supports direct matches, e.g. a registered "/test" matches "/test", and various Ant-style pattern matches, e.g. a registered "/t*" matches both "/test" and "/team". For details, see the AntPathMatcher class.

Looks for the most exact pattern, where most exact is defined as the longest path pattern.

Parameters:

urlPath - URL the bean is mapped to

exchange - the current exchange

Returns:

the associated handler instance, or null if not found

Throws:

java.lang.Exception

See Also:

ParsingPathMatcher

handleMatch

private java.lang.Object handleMatch(java.lang.Object handler,
                                     java.lang.String bestMatch,
                                     java.lang.String pathWithinMapping,
                                     ServerWebExchange exchange)
                              throws java.lang.Exception

Throws:

java.lang.Exception

validateHandler

protected void validateHandler(java.lang.Object handler,
                               ServerWebExchange exchange)
                        throws java.lang.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 - the handler object to validate

exchange - current exchange

Throws:

java.lang.Exception - if validation failed

registerHandler

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

Register the specified handler for the given URL paths.

Parameters:

urlPaths - the URLs that the bean should be mapped to

beanName - the name of the handler bean

Throws:

BeansException - if the handler couldn't be registered

java.lang.IllegalStateException - if there is a conflicting handler registered

registerHandler

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

Register the specified handler for the given URL path.

Parameters:

urlPath - the URL the bean should be mapped to

handler - the handler instance or handler bean name String (a bean name will automatically be resolved into the corresponding handler bean)

Throws:

BeansException - if the handler couldn't be registered

java.lang.IllegalStateException - if there is a conflicting handler registered

getHandlerDescription

private java.lang.String getHandlerDescription(java.lang.Object handler)