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

Modifier and Type	Field and Description
private String	beanName
private CorsConfigurationSource	corsConfigurationSource
private CorsProcessor	corsProcessor
protected final Log	mappingsLogger Dedicated "hidden" logger for request mappings.
private static final WebHandler	NO_OP_HANDLER
private int	order
private final PathPatternParser	patternParser

Access	Constructor and Description
public	AbstractHandlerMapping()

Method Summary

Modifier and Type	Method and Description
protected String	formatMappingName()
protected CorsConfiguration	Returns: the CORS configuration for the handler, or `null` if none getCorsConfiguration(Object the handler to check (never `null`) handler, ServerWebExchange the current exchange exchange) Retrieve the CORS configuration for the given handler.
public CorsProcessor	getCorsProcessor() Return the configured `CorsProcessor`.
public Mono<Object>	getHandler(ServerWebExchange current server exchange exchange) Implements org.springframework.web.reactive.HandlerMapping.getHandler. Return a handler for this request.
protected abstract Mono<?>	Returns: `Mono` for the matching handler, if any getHandlerInternal(ServerWebExchange current exchange exchange) Look up a handler for the given request, returning an empty `Mono` if no specific one is found.
public int	getOrder() Implements org.springframework.core.Ordered.getOrder. Get the order value of this object.
public PathPatternParser	getPathPatternParser() Return the `PathPatternParser` instance that is used for `CORS configuration checks`.
protected boolean	hasCorsConfigurationSource(Object handler) Return `true` if there is a `CorsConfigurationSource` for this handler.
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 the "global" CORS configurations based on URL patterns.
public void	setCorsConfigurationSource(CorsConfigurationSource corsConfigurationSource) Set the "global" CORS configuration source.
public void	setCorsProcessor(CorsProcessor corsProcessor) Configure a custom `CorsProcessor` to use to apply the matched `CorsConfiguration` for a request.
public void	setOrder(int order) Specify the order value for this HandlerMapping bean.
public void	setUseCaseSensitiveMatch(boolean caseSensitiveMatch) Shortcut method for setting the same property on the underlying pattern parser in use.
public void	setUseTrailingSlashMatch(boolean trailingSlashMatch) Deprecated since 6.0. as of 6.0, see `PathPatternParser#setMatchOptionalTrailingSeparator(boolean)` Shortcut method for setting the same property on the underlying pattern parser in use.

Inherited from org.springframework.context.support.ApplicationObjectSupport:: getApplicationContext getMessageSourceAccessor initApplicationContext initApplicationContext isContextRequired obtainApplicationContext requiredContextClass setApplicationContext

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

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

NO_OP_HANDLER	back to summary
private static final WebHandler NO_OP_HANDLER

order	back to summary
private int order

patternParser	back to summary
private final PathPatternParser patternParser

AbstractHandlerMapping	back to summary
public AbstractHandlerMapping()

Method Detail

formatMappingName	back to summary
protected String formatMappingName()

getCorsConfiguration back to summary

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

protected CorsConfiguration getCorsConfiguration(Object handler, ServerWebExchange exchange)

Retrieve the CORS configuration for the given handler.

Parameters

handler:Object: the handler to check (never null)
exchange:ServerWebExchange: the current exchange

Returns:CorsConfiguration

the CORS configuration for the handler, or null if none

Annotations

@Nullable

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

getHandler back to summary

getHandler	back to summary
public Mono<Object> getHandler(ServerWebExchange exchange) Implements org.springframework.web.reactive.HandlerMapping.getHandler. Doc from org.springframework.web.reactive.HandlerMapping.getHandler. Return a handler for this request. Before returning a handler, an implementing method should check for CORS configuration associated with the handler, apply validation checks based on it, and update the response accordingly. For pre-flight requests, the same should be done based on the handler matching to the expected actual request. Parameters exchange:ServerWebExchange current server exchange Returns:Mono<Object> a `Mono` that emits one value or none in case the request cannot be resolved to a handler Annotations @Override

public Mono<Object> getHandler(ServerWebExchange exchange)

Implements org.springframework.web.reactive.HandlerMapping.getHandler.

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

Return a handler for this request.

Before returning a handler, an implementing method should check for CORS configuration associated with the handler, apply validation checks based on it, and update the response accordingly. For pre-flight requests, the same should be done based on the handler matching to the expected actual request.

Parameters

exchange:ServerWebExchange: current server exchange

Returns:Mono<Object>

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

Annotations

@Override

getHandlerInternal back to summary

getHandlerInternal	back to summary
protected abstract 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`. 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. Parameters exchange:ServerWebExchange current exchange Returns:Mono<?> `Mono` for the matching handler, if any

protected abstract 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.

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.

Parameters

exchange:ServerWebExchange: current exchange

Returns:Mono<?>

Mono for the matching handler, if any

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

getPathPatternParser	back to summary
public PathPatternParser getPathPatternParser() Return the `PathPatternParser` instance that is used for `CORS configuration checks`. Subclasses can also use this pattern parser for their own request mapping purposes.

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

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 the "global" CORS configurations based on URL patterns. By default, the first matching URL pattern is combined with handler-level CORS configuration if any. See Also `setCorsConfigurationSource(CorsConfigurationSource)`

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

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

See Also: setCorsConfigurationSource(CorsConfigurationSource)

setCorsConfigurationSource back to summary

setCorsConfigurationSource	back to summary
public void setCorsConfigurationSource(CorsConfigurationSource corsConfigurationSource) Set the "global" CORS configuration source. By default, the first matching URL pattern is combined with the CORS configuration for the handler, if any. Since 5.1 See Also `setCorsConfigurations(Map)`

public void setCorsConfigurationSource(CorsConfigurationSource corsConfigurationSource)

Set the "global" CORS configuration source. By default, the first matching URL pattern is combined with the CORS configuration for the handler, if any.

Since: 5.1
See Also: setCorsConfigurations(Map)

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 an instance of `DefaultCorsProcessor` is used.

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.

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

setUseCaseSensitiveMatch back to summary

setUseCaseSensitiveMatch	back to summary
public void setUseCaseSensitiveMatch(boolean caseSensitiveMatch) Shortcut method for setting the same property on the underlying pattern parser in use. For more details see: `getPathPatternParser()` -- the underlying pattern parser `PathPatternParser#setCaseSensitive(boolean)` -- the case sensitive slash option, including its default value. Note aside from

public void setUseCaseSensitiveMatch(boolean caseSensitiveMatch)

Shortcut method for setting the same property on the underlying pattern parser in use. For more details see:

getPathPatternParser() -- the underlying pattern parser
PathPatternParser#setCaseSensitive(boolean) -- the case sensitive slash option, including its default value.

Note

aside from

setUseTrailingSlashMatch back to summary

setUseTrailingSlashMatch	back to summary
public void setUseTrailingSlashMatch(boolean trailingSlashMatch) Deprecated since 6.0. as of 6.0, see `PathPatternParser#setMatchOptionalTrailingSeparator(boolean)` Shortcut method for setting the same property on the underlying pattern parser in use. For more details see: `getPathPatternParser()` -- the underlying pattern parser `PathPatternParser#setMatchOptionalTrailingSeparator(boolean)` -- the trailing slash option, including its default value. The default was changed in 6.0 from `true` to `false` in order to support the deprecation of the property. Annotations @Deprecated since:6.0

public void setUseTrailingSlashMatch(boolean trailingSlashMatch)

Deprecated

since 6.0.

as of 6.0, see PathPatternParser#setMatchOptionalTrailingSeparator(boolean)

Shortcut method for setting the same property on the underlying pattern parser in use. For more details see:

getPathPatternParser() -- the underlying pattern parser
PathPatternParser#setMatchOptionalTrailingSeparator(boolean) -- the trailing slash option, including its default value.

The default was changed in 6.0 from true to false in order to support the deprecation of the property.

Annotations

@Deprecated
since:6.0

public abstract Class AbstractHandlerMapping

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail