org.springframework.web.reactive.handler

Class AbstractHandlerMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.reactive.handler.AbstractHandlerMapping

All Implemented Interfaces:

Aware, ApplicationContextAware, Ordered, HandlerMapping

Direct Known Subclasses:

AbstractHandlerMethodMapping, AbstractUrlHandlerMapping

public abstract class AbstractHandlerMapping
extends ApplicationObjectSupport
implements HandlerMapping, Ordered

Abstract base class for HandlerMapping implementations.

Since:

5.0

Author:

Rossen Stoyanchev, Juergen Hoeller

Field Summary

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
AbstractHandlerMapping()

Method Summary

Modifier and Type	Method and Description
protected CorsConfiguration	getCorsConfiguration(Object handler, ServerWebExchange exchange) Retrieve the CORS configuration for the given handler.
Map<String,CorsConfiguration>	getCorsConfigurations() Return the "global" CORS configuration.
CorsProcessor	getCorsProcessor() Return the configured CorsProcessor.
reactor.core.publisher.Mono<Object>	getHandler(ServerWebExchange exchange) Return a handler for this request.
protected abstract reactor.core.publisher.Mono<?>	getHandlerInternal(ServerWebExchange exchange) Look up a handler for the given request, returning an empty Mono if no specific one is found.
int	getOrder() Get the order value of this object.
HttpRequestPathHelper	getPathHelper() Return the HttpRequestPathHelper implementation to use for resolution of lookup paths.
PathMatcher	getPathMatcher() Return the PathMatcher implementation to use for matching URL paths against registered URL patterns.
void	setCorsConfigurations(Map<String,CorsConfiguration> corsConfigurations) Set "global" CORS configuration based on URL patterns.
void	setCorsProcessor(CorsProcessor corsProcessor) Configure a custom CorsProcessor to use to apply the matched CorsConfiguration for a request.
void	setOrder(int order) Specify the order value for this HandlerMapping bean.
void	setPathHelper(HttpRequestPathHelper pathHelper) Set the HttpRequestPathHelper to use for resolution of lookup paths.
void	setPathMatcher(PathMatcher pathMatcher) Set the PathMatcher implementation to use for matching URL paths against registered URL patterns.
void	setUrlDecode(boolean urlDecode) Set if the path should be URL-decoded.

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

Constructor Detail

AbstractHandlerMapping

public AbstractHandlerMapping()

Method Detail

setOrder

public final void setOrder(int order)

Specify the order value for this HandlerMapping bean.

Default value is Integer.MAX_VALUE, meaning that it's non-ordered.

See Also:

Ordered.getOrder()

getOrder

public final int getOrder()

Description copied from interface: Ordered

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.

Specified by:

getOrder in interface Ordered

Returns:

the order value

See Also:

Ordered.HIGHEST_PRECEDENCE, Ordered.LOWEST_PRECEDENCE

setUrlDecode

public void setUrlDecode(boolean urlDecode)

Set if the path should be URL-decoded. This sets the same property on the underlying path helper.

See Also:

HttpRequestPathHelper.setUrlDecode(boolean)

setPathHelper

public void setPathHelper(HttpRequestPathHelper pathHelper)

Set the HttpRequestPathHelper to use for resolution of lookup paths. Use this to override the default implementation with a custom subclass or to share common path helper settings across multiple HandlerMappings.

getPathHelper

public HttpRequestPathHelper getPathHelper()

Return the HttpRequestPathHelper implementation to use for resolution of lookup paths.

setPathMatcher

public void setPathMatcher(PathMatcher pathMatcher)

Set the PathMatcher implementation to use for matching URL paths against registered URL patterns. Default is AntPathMatcher.

See Also:

ParsingPathMatcher

getPathMatcher

public PathMatcher getPathMatcher()

Return the PathMatcher implementation to use for matching URL paths against registered URL patterns.

setCorsConfigurations

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

Set "global" CORS configuration based on URL patterns. By default the first matching URL pattern is combined with handler-level CORS configuration if any.

getCorsConfigurations

public Map<String,CorsConfiguration> getCorsConfigurations()

Return the "global" CORS configuration.

setCorsProcessor

public void setCorsProcessor(CorsProcessor corsProcessor)

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

By default an instance of DefaultCorsProcessor is used.

getCorsProcessor

public CorsProcessor getCorsProcessor()

Return the configured CorsProcessor.

getHandler

public reactor.core.publisher.Mono<Object> getHandler(ServerWebExchange exchange)

Description copied from interface: HandlerMapping

Return a handler for this request.

Specified by:

getHandler in interface HandlerMapping

Parameters:

exchange - current server exchange

Returns:

a Mono that emits one value or none in case the request cannot be resolved to a handler

getHandlerInternal

protected abstract reactor.core.publisher.Mono<?> getHandlerInternal(ServerWebExchange exchange)

Look up a handler for the given request, returning an empty Mono if no specific one is found. This method is called by 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 getCorsConfigurations(),

Parameters:

exchange - current exchange

Returns:

Mono for the matching handler, if any

getCorsConfiguration

protected CorsConfiguration getCorsConfiguration(Object handler,
                                                 ServerWebExchange exchange)

Retrieve the CORS configuration for the given handler.

Parameters:

handler - the handler to check (never null)

exchange - the current exchange

Returns:

the CORS configuration for the handler, or null if none