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, Sam Brannen
-
Field Summary
Fields inherited from class org.springframework.web.reactive.handler.AbstractHandlerMapping
mappingsLogger
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Detects handler methods at initialization.protected RequestMappingInfo
createRequestMappingInfo
(RequestMapping requestMapping, RequestCondition<?> customCondition) Create aRequestMappingInfo
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.Return the configuredRequestedContentTypeResolver
.protected RequestCondition<?>
getCustomMethodCondition
(Method method) Provide a custom method-level request condition.protected RequestCondition<?>
getCustomTypeCondition
(Class<?> handlerType) Provide a custom type-level request condition.protected RequestMappingInfo
getMappingForMethod
(Method method, Class<?> handlerType) Uses method and type-level @RequestMapping
annotations to create the RequestMappingInfo.The configured path prefixes as a read-only, possibly empty map.protected CorsConfiguration
initCorsConfiguration
(Object handler, Method method, RequestMappingInfo mappingInfo) Extract and return the CORS configuration for the mapping.protected boolean
Whether the given type is a handler with handler methods.protected void
registerHandlerMethod
(Object handler, Method method, RequestMappingInfo mapping) Register a handler method and its unique mapping.void
registerMapping
(RequestMappingInfo mapping, Object handler, Method method) Register the given mapping.protected String[]
resolveEmbeddedValuesInPatterns
(String[] patterns) Resolve placeholder values in the given array of patterns.void
setContentTypeResolver
(RequestedContentTypeResolver contentTypeResolver) Set theRequestedContentTypeResolver
to use to determine requested media types.void
setEmbeddedValueResolver
(StringValueResolver resolver) Set the StringValueResolver to use for resolving embedded definition values.void
setPathPrefixes
(Map<String, Predicate<Class<?>>> prefixes) Configure path prefixes to apply to controller methods.Methods inherited from class org.springframework.web.reactive.result.method.RequestMappingInfoHandlerMapping
getDirectPaths, getHandlerInternal, getMappingComparator, getMatchingMapping, handleMatch, handleNoMatch
Methods inherited from class org.springframework.web.reactive.result.method.AbstractHandlerMethodMapping
createHandlerMethod, detectHandlerMethods, getCorsConfiguration, getHandlerMethods, handlerMethodsInitialized, hasCorsConfigurationSource, initHandlerMethods, lookupHandlerMethod, 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
-
Constructor Details
-
RequestMappingHandlerMapping
public RequestMappingHandlerMapping()
-
-
Method Details
-
setPathPrefixes
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 correspondingPredicate
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:
-
getPathPrefixes
The configured path prefixes as a read-only, possibly empty map.- Since:
- 5.1
-
setContentTypeResolver
Set theRequestedContentTypeResolver
to use to determine requested media types. If not set, the default constructor is used. -
getContentTypeResolver
Return the configuredRequestedContentTypeResolver
. -
setEmbeddedValueResolver
Description copied from interface:EmbeddedValueResolverAware
Set the StringValueResolver to use for resolving embedded definition values.- Specified by:
setEmbeddedValueResolver
in interfaceEmbeddedValueResolverAware
-
afterPropertiesSet
public void afterPropertiesSet()Description copied from class:AbstractHandlerMethodMapping
Detects handler methods at initialization.- Specified by:
afterPropertiesSet
in interfaceInitializingBean
- Overrides:
afterPropertiesSet
in classAbstractHandlerMethodMapping<RequestMappingInfo>
-
isHandler
Whether the given type is a handler with handler methods. Expects a handler to have a type-level @Controller
annotation.- Specified by:
isHandler
in classAbstractHandlerMethodMapping<RequestMappingInfo>
- Parameters:
beanType
- the type of the bean being checked- Returns:
- "true" if this a handler type, "false" otherwise.
-
getMappingForMethod
Uses method and type-level @RequestMapping
annotations to create the RequestMappingInfo.- Specified by:
getMappingForMethod
in classAbstractHandlerMethodMapping<RequestMappingInfo>
- Parameters:
method
- the method to provide a mapping forhandlerType
- the handler type, possibly a subtype of the method's declaring class- Returns:
- the created RequestMappingInfo, or
null
if the method does not have a@RequestMapping
annotation. - See Also:
-
getCustomTypeCondition
Provide a custom type-level request condition. The customRequestCondition
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 usingCompositeRequestCondition
to provide multiple custom conditions.- Parameters:
handlerType
- the handler type for which to create the condition- Returns:
- the condition, or
null
-
getCustomMethodCondition
Provide a custom method-level request condition. The customRequestCondition
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 usingCompositeRequestCondition
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 aRequestMappingInfo
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
Resolve placeholder values in the given array of patterns.- Returns:
- a new array with updated patterns
-
registerMapping
Description copied from class:AbstractHandlerMethodMapping
Register the given mapping.This method may be invoked at runtime after initialization has completed.
- Overrides:
registerMapping
in classAbstractHandlerMethodMapping<RequestMappingInfo>
- Parameters:
mapping
- the mapping for the handler methodhandler
- the handlermethod
- the method
-
registerHandlerMethod
Description copied from class:AbstractHandlerMethodMapping
Register a handler method and its unique mapping. Invoked at startup for each detected handler method.- Overrides:
registerHandlerMethod
in classAbstractHandlerMethodMapping<RequestMappingInfo>
- Parameters:
handler
- the bean name of the handler or the handler instancemethod
- the method to registermapping
- the mapping conditions associated with the handler method
-
initCorsConfiguration
protected CorsConfiguration initCorsConfiguration(Object handler, Method method, RequestMappingInfo mappingInfo) Description copied from class:AbstractHandlerMethodMapping
Extract and return the CORS configuration for the mapping.- Overrides:
initCorsConfiguration
in classAbstractHandlerMethodMapping<RequestMappingInfo>
-