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

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, InitializingBean, ApplicationContextAware, EmbeddedValueResolverAware, Ordered, ServletContextAware, MatchableHandlerMapping, HandlerMapping

Direct Known Subclasses:

StandaloneMockMvcBuilder.StaticRequestMappingHandlerMapping

public class RequestMappingHandlerMapping
extends RequestMappingInfoHandlerMapping
implements MatchableHandlerMapping, EmbeddedValueResolverAware

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

Since:

3.1

Author:

Arjen Poutsma, Rossen Stoyanchev, Sam Brannen

Field Summary

Fields

Modifier and Type	Field and Description
private RequestMappingInfo.BuilderConfiguration	config
private ContentNegotiationManager	contentNegotiationManager
private StringValueResolver	embeddedValueResolver
private boolean	useRegisteredSuffixPatternMatch
private boolean	useSuffixPatternMatch
private boolean	useTrailingSlashMatch

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

logger

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

BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, 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.
ContentNegotiationManager	getContentNegotiationManager() Return the configured ContentNegotiationManager.
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.
java.util.List<java.lang.String>	getFileExtensions() Return the file extensions to use for suffix pattern matching.
protected RequestMappingInfo	getMappingForMethod(java.lang.reflect.Method method, java.lang.Class<?> handlerType) Uses method and type-level @RequestMapping annotations to create the RequestMappingInfo.
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.
RequestMatchResult	match(HttpServletRequest request, java.lang.String pattern) Determine whether the given request matches the request criteria.
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	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	setUseRegisteredSuffixPatternMatch(boolean useRegisteredSuffixPatternMatch) Whether suffix pattern matching should work only against path extensions explicitly registered with the ContentNegotiationManager.
void	setUseSuffixPatternMatch(boolean useSuffixPatternMatch) Whether to use suffix pattern match (".*") when matching patterns to requests.
void	setUseTrailingSlashMatch(boolean useTrailingSlashMatch) Whether to match to URLs irrespective of the presence of a trailing slash.
private void	updateCorsConfig(CorsConfiguration config, CrossOrigin annotation)
boolean	useRegisteredSuffixPatternMatch() Whether to use registered suffixes for pattern matching.
boolean	useSuffixPatternMatch() Whether to use suffix pattern matching.
boolean	useTrailingSlashMatch() Whether to match to URLs irrespective of the presence of a trailing slash.

Methods inherited from class org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping

getMappingComparator, getMappingPathPatterns, getMatchingMapping, handleMatch, handleNoMatch

Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMethodMapping

createHandlerMethod, detectHandlerMethods, getCorsConfiguration, getHandlerInternal, getHandlerMethods, getHandlerMethodsForMappingName, getNamingStrategy, handlerMethodsInitialized, initHandlerMethods, lookupHandlerMethod, registerHandlerMethod, registerMapping, setDetectHandlerMethodsInAncestorContexts, setHandlerMethodMappingNamingStrategy, unregisterMapping

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

adaptInterceptor, detectMappedInterceptors, extendInterceptors, getAdaptedInterceptors, getCorsConfigurations, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getUrlPathHelper, initApplicationContext, initInterceptors, setAlwaysUseFullPath, setCorsConfigurations, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

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

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

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.servlet.HandlerMapping

getHandler

Field Detail

useSuffixPatternMatch

private boolean useSuffixPatternMatch

useRegisteredSuffixPatternMatch

private boolean useRegisteredSuffixPatternMatch

useTrailingSlashMatch

private boolean useTrailingSlashMatch

contentNegotiationManager

private ContentNegotiationManager contentNegotiationManager

embeddedValueResolver

private StringValueResolver embeddedValueResolver

config

private RequestMappingInfo.BuilderConfiguration config

Constructor Detail

RequestMappingHandlerMapping

public RequestMappingHandlerMapping()

Method Detail

setUseSuffixPatternMatch

public void setUseSuffixPatternMatch(boolean useSuffixPatternMatch)

Whether to use suffix pattern match (".*") when matching patterns to requests. If enabled a method mapped to "/users" also matches to "/users.*".

The default value is true.

Also see setUseRegisteredSuffixPatternMatch(boolean) for more fine-grained control over specific suffixes to allow.

setUseRegisteredSuffixPatternMatch

public void setUseRegisteredSuffixPatternMatch(boolean useRegisteredSuffixPatternMatch)

Whether suffix pattern matching should work only against path extensions explicitly registered with the ContentNegotiationManager. This is generally recommended to reduce ambiguity and to avoid issues such as when a "." appears in the path for other reasons.

By default this is set to "false".

setUseTrailingSlashMatch

public void setUseTrailingSlashMatch(boolean useTrailingSlashMatch)

Whether to match to URLs irrespective of the presence of a trailing slash. If enabled a method mapped to "/users" also matches to "/users/".

The default value is true.

setContentNegotiationManager

public void setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)

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

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>

useSuffixPatternMatch

public boolean useSuffixPatternMatch()

Whether to use suffix pattern matching.

useRegisteredSuffixPatternMatch

public boolean useRegisteredSuffixPatternMatch()

Whether to use registered suffixes for pattern matching.

useTrailingSlashMatch

public boolean useTrailingSlashMatch()

Whether to match to URLs irrespective of the presence of a trailing slash.

getContentNegotiationManager

public ContentNegotiationManager getContentNegotiationManager()

Return the configured ContentNegotiationManager.

getFileExtensions

public java.util.List<java.lang.String> getFileExtensions()

Return the file extensions to use for suffix pattern matching.

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

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

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

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,
                                                      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

match

public RequestMatchResult match(HttpServletRequest request,
                                java.lang.String pattern)

Description copied from interface: MatchableHandlerMapping

Determine whether the given request matches the request criteria.

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 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,
                              CrossOrigin annotation)

resolveCorsAnnotationValue

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