org.springframework.web.reactive.result.method.annotation

Class RequestMappingHandlerMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.reactive.handler.AbstractHandlerMapping

org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping<RequestMappingInfo>

org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping

org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping

All Implemented Interfaces:

Aware, BeanNameAware, InitializingBean, ApplicationContextAware, EmbeddedValueResolverAware, Ordered, HandlerMapping

public class RequestMappingHandlerMapping
extends RequestMappingInfoHandlerMapping
implements EmbeddedValueResolverAware

An extension of RequestMappingInfoHandlerMapping that creates RequestMappingInfo instances from class-level and method-level @RequestMapping annotations.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private RequestMappingInfo.BuilderConfiguration	config
private RequestedContentTypeResolver	contentTypeResolver
private StringValueResolver	embeddedValueResolver
private java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>>	pathPrefixes

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

logger

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

BEST_MATCHING_HANDLER_ATTRIBUTE, 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
RequestMappingHandlerMapping()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Detects handler methods at initialization.
private RequestMappingInfo	createRequestMappingInfo(java.lang.reflect.AnnotatedElement element) Delegates to createRequestMappingInfo(RequestMapping, RequestCondition), supplying the appropriate custom RequestCondition depending on whether the supplied annotatedElement is a class or method.
protected RequestMappingInfo	createRequestMappingInfo(RequestMapping requestMapping, RequestCondition<?> customCondition) Create a RequestMappingInfo from the supplied @RequestMapping annotation, which is either a directly declared annotation, a meta-annotation, or the synthesized result of merging annotation attributes within an annotation hierarchy.
RequestedContentTypeResolver	getContentTypeResolver() Return the configured RequestedContentTypeResolver.
protected RequestCondition<?>	getCustomMethodCondition(java.lang.reflect.Method method) Provide a custom method-level request condition.
protected RequestCondition<?>	getCustomTypeCondition(java.lang.Class<?> handlerType) Provide a custom type-level request condition.
protected RequestMappingInfo	getMappingForMethod(java.lang.reflect.Method method, java.lang.Class<?> handlerType) Uses method and type-level @RequestMapping annotations to create the RequestMappingInfo.
java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>>	getPathPrefixes() The configured path prefixes as a read-only, possibly empty map.
protected CorsConfiguration	initCorsConfiguration(java.lang.Object handler, java.lang.reflect.Method method, RequestMappingInfo mappingInfo) Extract and return the CORS configuration for the mapping.
protected boolean	isHandler(java.lang.Class<?> beanType) Whether the given type is a handler with handler methods.
private java.lang.String	resolveCorsAnnotationValue(java.lang.String value)
protected java.lang.String[]	resolveEmbeddedValuesInPatterns(java.lang.String[] patterns) Resolve placeholder values in the given array of patterns.
void	setContentTypeResolver(RequestedContentTypeResolver contentTypeResolver) Set the RequestedContentTypeResolver to use to determine requested media types.
void	setEmbeddedValueResolver(StringValueResolver resolver) Set the StringValueResolver to use for resolving embedded definition values.
void	setPathPrefixes(java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> prefixes) Configure path prefixes to apply to controller methods.
private void	updateCorsConfig(CorsConfiguration config, CrossOrigin annotation)

Methods inherited from class org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping

getMappingComparator, getMatchingMapping, handleMatch, handleNoMatch

Methods inherited from class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping

createHandlerMethod, detectHandlerMethods, getCorsConfiguration, getHandlerInternal, getHandlerMethods, handlerMethodsInitialized, initHandlerMethods, lookupHandlerMethod, registerHandlerMethod, registerMapping, unregisterMapping

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

formatMappingName, getCorsProcessor, getHandler, getOrder, getPathPatternParser, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setOrder, setUseCaseSensitiveMatch, setUseTrailingSlashMatch

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

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

Methods inherited from class java.lang.Object

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

Field Detail

pathPrefixes

private final java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> pathPrefixes

contentTypeResolver

private RequestedContentTypeResolver contentTypeResolver

embeddedValueResolver

@Nullable
private StringValueResolver embeddedValueResolver

config

private RequestMappingInfo.BuilderConfiguration config

Constructor Detail

RequestMappingHandlerMapping

public RequestMappingHandlerMapping()

Method Detail

setPathPrefixes

public void setPathPrefixes(java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> prefixes)

Configure path prefixes to apply to controller methods.

Prefixes are used to enrich the mappings of every @RequestMapping method whose controller type is matched by a corresponding Predicate in the map. The prefix for the first matching predicate is used, assuming the input map has predictable order.

Consider using HandlerTypePredicate to group controllers.

Parameters:

prefixes - a map with path prefixes as key

Since:

5.1

See Also:

HandlerTypePredicate

getPathPrefixes

public java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> getPathPrefixes()

The configured path prefixes as a read-only, possibly empty map.

Since:

5.1

setContentTypeResolver

public void setContentTypeResolver(RequestedContentTypeResolver contentTypeResolver)

Set the RequestedContentTypeResolver to use to determine requested media types. If not set, the default constructor is used.

getContentTypeResolver

public RequestedContentTypeResolver getContentTypeResolver()

Return the configured RequestedContentTypeResolver.

setEmbeddedValueResolver

public void setEmbeddedValueResolver(StringValueResolver resolver)

Description copied from interface: EmbeddedValueResolverAware

Set the StringValueResolver to use for resolving embedded definition values.

Specified by:

setEmbeddedValueResolver in interface EmbeddedValueResolverAware

afterPropertiesSet

public void afterPropertiesSet()

Description copied from class: AbstractHandlerMethodMapping

Detects handler methods at initialization.

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AbstractHandlerMethodMapping<RequestMappingInfo>

isHandler

protected boolean isHandler(java.lang.Class<?> beanType)

Whether the given type is a handler with handler methods. Expects a handler to have a type-level @Controller annotation.

Specified by:

isHandler in class AbstractHandlerMethodMapping<RequestMappingInfo>

Parameters:

beanType - the type of the bean being checked

Returns:

"true" if this a handler type, "false" otherwise.

getMappingForMethod

protected RequestMappingInfo getMappingForMethod(java.lang.reflect.Method method,
                                                 java.lang.Class<?> handlerType)

Uses method and type-level @RequestMapping annotations to create the RequestMappingInfo.

Specified by:

getMappingForMethod in class AbstractHandlerMethodMapping<RequestMappingInfo>

Parameters:

method - the method to provide a mapping for

handlerType - the handler type, possibly a sub-type of the method's declaring class

Returns:

the created RequestMappingInfo, or null if the method does not have a @RequestMapping annotation.

See Also:

getCustomMethodCondition(Method), getCustomTypeCondition(Class)

createRequestMappingInfo

@Nullable
private RequestMappingInfo createRequestMappingInfo(java.lang.reflect.AnnotatedElement element)

Delegates to createRequestMappingInfo(RequestMapping, RequestCondition), supplying the appropriate custom RequestCondition depending on whether the supplied annotatedElement is a class or method.

See Also:

getCustomTypeCondition(Class), getCustomMethodCondition(Method)

getCustomTypeCondition

@Nullable
protected RequestCondition<?> getCustomTypeCondition(java.lang.Class<?> handlerType)

Provide a custom type-level request condition. The custom RequestCondition can be of any type so long as the same condition type is returned from all calls to this method in order to ensure custom request conditions can be combined and compared.

Consider extending AbstractRequestCondition for custom condition types and using CompositeRequestCondition to provide multiple custom conditions.

Parameters:

handlerType - the handler type for which to create the condition

Returns:

the condition, or null

getCustomMethodCondition

@Nullable
protected RequestCondition<?> getCustomMethodCondition(java.lang.reflect.Method method)

Provide a custom method-level request condition. The custom RequestCondition can be of any type so long as the same condition type is returned from all calls to this method in order to ensure custom request conditions can be combined and compared.

Consider extending AbstractRequestCondition for custom condition types and using CompositeRequestCondition to provide multiple custom conditions.

Parameters:

method - the handler method for which to create the condition

Returns:

the condition, or null

createRequestMappingInfo

protected RequestMappingInfo createRequestMappingInfo(RequestMapping requestMapping,
                                                      @Nullable
                                                      RequestCondition<?> customCondition)

Create a RequestMappingInfo from the supplied @RequestMapping annotation, which is either a directly declared annotation, a meta-annotation, or the synthesized result of merging annotation attributes within an annotation hierarchy.

resolveEmbeddedValuesInPatterns

protected java.lang.String[] resolveEmbeddedValuesInPatterns(java.lang.String[] patterns)

Resolve placeholder values in the given array of patterns.

Returns:

a new array with updated patterns

initCorsConfiguration

protected CorsConfiguration initCorsConfiguration(java.lang.Object handler,
                                                  java.lang.reflect.Method method,
                                                  RequestMappingInfo mappingInfo)

Description copied from class: AbstractHandlerMethodMapping

Extract and return the CORS configuration for the mapping.

Overrides:

initCorsConfiguration in class AbstractHandlerMethodMapping<RequestMappingInfo>

updateCorsConfig

private void updateCorsConfig(CorsConfiguration config,
                              @Nullable
                              CrossOrigin annotation)

resolveCorsAnnotationValue

private java.lang.String resolveCorsAnnotationValue(java.lang.String value)