Class RequestMappingHandlerMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.handler.AbstractHandlerMapping

org.springframework.web.servlet.handler.AbstractHandlerMethodMapping<RequestMappingInfo>

org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping

org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping

All Implemented Interfaces:

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

public class RequestMappingHandlerMapping
extends RequestMappingInfoHandlerMapping
implements MatchableHandlerMapping, EmbeddedValueResolverAware

Creates RequestMappingInfo instances from type-level and method-level @RequestMapping and @HttpExchange annotations in @Controller classes.

Since:

3.1

Author:

Arjen Poutsma, Rossen Stoyanchev, Sam Brannen, Olga Maciaszek-Sharma, Yongjun Hong

Field Summary

Fields inherited from class AbstractHandlerMapping

mappingsLogger

Fields inherited from class ApplicationObjectSupport

logger

Fields inherited from interface HandlerMapping

API_VERSION_ATTRIBUTE, BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, LOOKUP_PATH, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
RequestMappingHandlerMapping()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Detects handler methods at initialization.
protected RequestMappingInfo	createRequestMappingInfo(RequestMapping requestMapping, @Nullable RequestCondition<?> customCondition)	Create a RequestMappingInfo from the supplied @RequestMapping annotation, meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.
protected RequestMappingInfo	createRequestMappingInfo(HttpExchange httpExchange, @Nullable RequestCondition<?> customCondition)	Create a RequestMappingInfo from the supplied @HttpExchange annotation, meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.
RequestMappingInfo.BuilderConfiguration	getBuilderConfiguration()	Obtain a RequestMappingInfo.BuilderConfiguration that reflects the internal configuration of this HandlerMapping and can be used to set RequestMappingInfo.Builder.options(RequestMappingInfo.BuilderConfiguration).
ContentNegotiationManager	getContentNegotiationManager()	Return the configured ContentNegotiationManager.
protected @Nullable RequestCondition<?>	getCustomMethodCondition(Method method)	Provide a custom method-level request condition.
protected @Nullable RequestCondition<?>	getCustomTypeCondition(Class<?> handlerType)	Provide a custom type-level request condition.
protected @Nullable RequestMappingInfo	getMappingForMethod(Method method, Class<?> handlerType)	Uses type-level and method-level @RequestMapping and @HttpExchange annotations to create the RequestMappingInfo.
Map<String, Predicate<Class<?>>>	getPathPrefixes()	The configured path prefixes as a read-only, possibly empty map.
protected @Nullable CorsConfiguration	initCorsConfiguration(Object handler, Method method, RequestMappingInfo mappingInfo)	Extract and return the CORS configuration for the mapping.
protected boolean	isHandler(Class<?> beanType)	Whether the given type is a handler with handler methods.
@Nullable RequestMatchResult	match(jakarta.servlet.http.HttpServletRequest request, String pattern)	Deprecated, for removal: This API element is subject to removal in a future version.
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	setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)	Set the ContentNegotiationManager 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 RequestMappingInfoHandlerMapping

getDirectPaths, getHandlerInternal, getMappingComparator, getMatchingMapping, handleMatch, handleNoMatch

Methods inherited from class AbstractHandlerMethodMapping

createHandlerMethod, detectHandlerMethods, getCandidateBeanNames, getCorsConfiguration, getHandlerMethods, getHandlerMethodsForMappingName, getNamingStrategy, handlerMethodsInitialized, hasCorsConfigurationSource, initHandlerMethods, lookupHandlerMethod, processCandidateBean, setDetectHandlerMethodsInAncestorContexts, setHandlerMethodMappingNamingStrategy, setPatternParser, unregisterMapping

Methods inherited from class AbstractHandlerMapping

adaptInterceptor, detectMappedInterceptors, extendInterceptors, formatMappingName, getAdaptedInterceptors, getApiVersionStrategy, getCorsConfigurationSource, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getPatternParser, getUrlPathHelper, initApplicationContext, initInterceptors, initLookupPath, setAlwaysUseFullPath, setApiVersionStrategy, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper, usesPathPatterns

Methods inherited from class WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class Object

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

Methods inherited from interface HandlerMapping

getHandler, usesPathPatterns

Methods inherited from interface MatchableHandlerMapping

getPatternParser

Constructor Details

RequestMappingHandlerMapping

public RequestMappingHandlerMapping()

Method Details

setPathPrefixes

public void setPathPrefixes(Map<String, Predicate<Class<?>>> prefixes)

Configure path prefixes to apply to controller methods.

Prefixes are used to enrich the mappings of every @RequestMapping method and @HttpExchange 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

getPathPrefixes

public Map<String, Predicate<Class<?>>> getPathPrefixes()

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

Since:

5.1

setContentNegotiationManager

public void setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)

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

getContentNegotiationManager

public ContentNegotiationManager getContentNegotiationManager()

Return the configured ContentNegotiationManager.

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>

See Also:

• AbstractHandlerMethodMapping.initHandlerMethods()

getBuilderConfiguration

public RequestMappingInfo.BuilderConfiguration getBuilderConfiguration()

Obtain a RequestMappingInfo.BuilderConfiguration that reflects the internal configuration of this HandlerMapping and can be used to set RequestMappingInfo.Builder.options(RequestMappingInfo.BuilderConfiguration).

This is useful for programmatic registration of request mappings via registerHandlerMethod(Object, Method, RequestMappingInfo).

Returns:

the builder configuration that reflects the internal state

Since:

5.3.14

isHandler

protected boolean isHandler(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 @Nullable RequestMappingInfo getMappingForMethod(Method method,
 Class<?> handlerType)

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

For CGLIB proxy classes, additional validation is performed based on method visibility:

• Private methods cannot be overridden and therefore cannot be used as handler methods.
• Package-private methods from different packages are inaccessible and must be changed to public or protected.

Specified by:

getMappingForMethod in class AbstractHandlerMethodMapping<RequestMappingInfo>

Parameters:

method - the method to provide a mapping for

handlerType - 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 or @HttpExchange annotation

See Also:

• getCustomMethodCondition(Method)
• getCustomTypeCondition(Class)

getCustomTypeCondition

protected @Nullable RequestCondition<?> getCustomTypeCondition(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

protected @Nullable RequestCondition<?> getCustomMethodCondition(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, meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.

createRequestMappingInfo

protected RequestMappingInfo createRequestMappingInfo(HttpExchange httpExchange,
 @Nullable RequestCondition<?> customCondition)

Create a RequestMappingInfo from the supplied @HttpExchange annotation, meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.

Since:

6.1

resolveEmbeddedValuesInPatterns

protected String[] resolveEmbeddedValuesInPatterns(String[] patterns)

Resolve placeholder values in the given array of patterns.

Returns:

a new array with updated patterns

registerMapping

public void registerMapping(RequestMappingInfo mapping,
 Object handler,
 Method method)

Description copied from class: AbstractHandlerMethodMapping

Register the given mapping.

This method may be invoked at runtime after initialization has completed.

Overrides:

registerMapping in class AbstractHandlerMethodMapping<RequestMappingInfo>

Parameters:

mapping - the mapping for the handler method

handler - the handler

method - the method

registerHandlerMethod

protected void registerHandlerMethod(Object handler,
 Method method,
 RequestMappingInfo mapping)

Register a handler method and its unique mapping. Invoked at startup for each detected handler method.

Note: To create the RequestMappingInfo, please use getBuilderConfiguration() and set the options on RequestMappingInfo.Builder.options(RequestMappingInfo.BuilderConfiguration) to match how this HandlerMapping is configured. This is important for example to ensure use of PathPattern or PathMatcher based matching.

Overrides:

registerHandlerMethod in class AbstractHandlerMethodMapping<RequestMappingInfo>

Parameters:

handler - the bean name of the handler or the handler instance

method - the method to register

mapping - the mapping conditions associated with the handler method

match

@Deprecated(since="7.0",
            forRemoval=true)
public @Nullable RequestMatchResult match(jakarta.servlet.http.HttpServletRequest request,
 String pattern)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: MatchableHandlerMapping

Determine whether the request matches the given pattern. Use this method when MatchableHandlerMapping.getPatternParser() returns null which means that the HandlerMapping is using String pattern matching.

Specified by:

match in interface MatchableHandlerMapping

Parameters:

request - the current request

pattern - the pattern to match

Returns:

the result from request matching, or null if none

initCorsConfiguration

protected @Nullable 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 class AbstractHandlerMethodMapping<RequestMappingInfo>