Modifier and Type	Class and Description
private static class	RequestMappingHandlerMapping.AnnotationDescriptor

Modifier and Type	Field and Description
private RequestMappingInfo.BuilderConfiguration	config
private ContentNegotiationManager	contentNegotiationManager
private boolean	defaultPatternParser
private StringValueResolver	embeddedValueResolver
private static final RequestMethod[]	EMPTY_REQUEST_METHOD_ARRAY
private static final String[]	EMPTY_STRING_ARRAY
private Map<String, Predicate<Class<?>>>	pathPrefixes
private boolean	useRegisteredSuffixPatternMatch
private boolean	useSuffixPatternMatch
private boolean	useTrailingSlashMatch

Access	Constructor and Description
public	RequestMappingHandlerMapping()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.afterPropertiesSet. Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Detects handler methods at initialization.
private RequestMappingInfo	createRequestMappingInfo(AnnotatedElement element)
protected RequestMappingInfo	createRequestMappingInfo(RequestMapping requestMapping, 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, RequestCondition<?> customCondition) Create a `RequestMappingInfo` from the supplied `@HttpExchange` annotation, meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.
private static List<RequestMappingHandlerMapping.AnnotationDescriptor>	getAnnotationDescriptors(AnnotatedElement element)
public RequestMappingInfo.BuilderConfiguration	Returns: the builder configuration that reflects the internal state getBuilderConfiguration() Obtain a `RequestMappingInfo.BuilderConfiguration` that reflects the internal configuration of this `HandlerMapping` and can be used to set `RequestMappingInfo.Builder#options(RequestMappingInfo.BuilderConfiguration)`.
public ContentNegotiationManager	getContentNegotiationManager() Return the configured `ContentNegotiationManager`.
protected RequestCondition<?>	Returns: the condition, or `null` getCustomMethodCondition(Method the handler method for which to create the condition method) Provide a custom method-level request condition.
protected RequestCondition<?>	Returns: the condition, or `null` getCustomTypeCondition(Class<?> the handler type for which to create the condition handlerType) Provide a custom type-level request condition.
public List<String>	getFileExtensions() Deprecated as of 5.2.4. See class-level note on the deprecation of path extension config options. Return the file extensions to use for suffix pattern matching.
protected RequestMappingInfo	Returns: the created `RequestMappingInfo`, or `null` if the method does not have a `@RequestMapping` or `@HttpExchange` annotation getMappingForMethod(Method the method to provide a mapping for method, Class<?> the handler type, possibly a subtype of the method's declaring class handlerType) Implements abstract org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getMappingForMethod. Uses type-level and method-level `@RequestMapping` and `@HttpExchange` annotations to create the `RequestMappingInfo`.
pack-priv String	getPathPrefix(Class<?> handlerType)
public Map<String, Predicate<Class<?>>>	getPathPrefixes() The configured path prefixes as a read-only, possibly empty map.
protected CorsConfiguration	initCorsConfiguration(Object handler, Method method, RequestMappingInfo mappingInfo) Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.initCorsConfiguration. Extract and return the CORS configuration for the mapping.
protected boolean	isHandler(Class<?> the type of the bean being checked beanType) Implements abstract org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.isHandler. Whether the given type is a handler with handler methods.
public RequestMatchResult	match(HttpServletRequest the current request request, String the pattern to match pattern) Implements org.springframework.web.servlet.handler.MatchableHandlerMapping.match. Determine whether the request matches the given pattern.
protected void	registerHandlerMethod(Object the bean name of the handler or the handler instance handler, Method the method to register method, RequestMappingInfo the mapping conditions associated with the handler method mapping) Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.registerHandlerMethod. Register a handler method and its unique mapping.
public void	registerMapping(RequestMappingInfo the mapping for the handler method mapping, Object the handler handler, Method the method method) Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.registerMapping. Register the given mapping.
private String	resolveCorsAnnotationValue(String value)
protected String[]	Returns: a new array with updated patterns resolveEmbeddedValuesInPatterns(String[] patterns) Resolve placeholder values in the given array of patterns.
public void	setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager) Set the `ContentNegotiationManager` to use to determine requested media types.
public void	setEmbeddedValueResolver(StringValueResolver resolver) Implements org.springframework.context.EmbeddedValueResolverAware.setEmbeddedValueResolver. Set the StringValueResolver to use for resolving embedded definition values.
public void	setPathPrefixes(Map<String, Predicate<Class<?>>> a map with path prefixes as key prefixes) Configure path prefixes to apply to controller methods.
public void	setPatternParser(PathPatternParser the parser to use patternParser) Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.setPatternParser. Set the `PathPatternParser` to parse `patterns` with for URL path matching.
public void	setUseRegisteredSuffixPatternMatch(boolean useRegisteredSuffixPatternMatch) Deprecated as of 5.2.4. See class level note on the deprecation of path extension config options. Whether suffix pattern matching should work only against path extensions explicitly registered with the `ContentNegotiationManager`.
public void	setUseSuffixPatternMatch(boolean useSuffixPatternMatch) Deprecated as of 5.2.4. Whether to use suffix pattern match (".*") when matching patterns to requests.
public void	setUseTrailingSlashMatch(boolean useTrailingSlashMatch) Deprecated since 6.0. as of 6.0, see `PathPatternParser#setMatchOptionalTrailingSeparator(boolean)` Whether to match to URLs irrespective of the presence of a trailing slash.
private static RequestMethod[]	toMethodArray(String method)
private static String[]	toStringArray(String value)
private void	updateConsumesCondition(RequestMappingInfo info, Method method)
private void	updateCorsConfig(CorsConfiguration config, CrossOrigin annotation)
public boolean	useRegisteredSuffixPatternMatch() Deprecated as of 5.2.4. Whether to use registered suffixes for pattern matching.
public boolean	useSuffixPatternMatch() Deprecated as of 5.2.4. Whether to use registered suffixes for pattern matching.
public boolean	useTrailingSlashMatch() Whether to match to URLs irrespective of the presence of a trailing slash.

Inherited from org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping:: getDirectPaths getHandlerInternal getMappingComparator getMappingPathPatterns getMatchingMapping handleMatch handleNoMatch

Field Detail

config	back to summary
private RequestMappingInfo.BuilderConfiguration config

contentNegotiationManager	back to summary
private ContentNegotiationManager contentNegotiationManager

defaultPatternParser	back to summary
private boolean defaultPatternParser

embeddedValueResolver	back to summary
private StringValueResolver embeddedValueResolver Annotations @Nullable

EMPTY_REQUEST_METHOD_ARRAY	back to summary
private static final RequestMethod[] EMPTY_REQUEST_METHOD_ARRAY

EMPTY_STRING_ARRAY	back to summary
private static final String[] EMPTY_STRING_ARRAY

pathPrefixes	back to summary
private Map<String, Predicate<Class<?>>> pathPrefixes

useRegisteredSuffixPatternMatch	back to summary
private boolean useRegisteredSuffixPatternMatch

useSuffixPatternMatch	back to summary
private boolean useSuffixPatternMatch

useTrailingSlashMatch	back to summary
private boolean useTrailingSlashMatch

Constructor Detail

RequestMappingHandlerMapping	back to summary
public RequestMappingHandlerMapping()

Method Detail

afterPropertiesSet	back to summary
public void afterPropertiesSet() Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.afterPropertiesSet. Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.afterPropertiesSet. Detects handler methods at initialization. Annotations @Override @SuppressWarnings:deprecation

afterPropertiesSet

back to summary

public void afterPropertiesSet()

Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.afterPropertiesSet.

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.afterPropertiesSet.

Detects handler methods at initialization.

Annotations

@Override
@SuppressWarnings:deprecation

createRequestMappingInfo	back to summary
private RequestMappingInfo createRequestMappingInfo(AnnotatedElement element) Annotations @Nullable

createRequestMappingInfo	back to summary
protected RequestMappingInfo createRequestMappingInfo(RequestMapping requestMapping, RequestCondition<?> customCondition) Create a `RequestMappingInfo` from the supplied `@RequestMapping` annotation, meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.

createRequestMappingInfo back to summary

createRequestMappingInfo	back to summary
protected RequestMappingInfo createRequestMappingInfo(HttpExchange httpExchange, 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

protected RequestMappingInfo createRequestMappingInfo(HttpExchange httpExchange, 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

getAnnotationDescriptors	back to summary
private static List<RequestMappingHandlerMapping.AnnotationDescriptor> getAnnotationDescriptors(AnnotatedElement element)

getBuilderConfiguration back to summary

getBuilderConfiguration	back to summary
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:RequestMappingInfo.BuilderConfiguration the builder configuration that reflects the internal state Since 5.3.14

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:RequestMappingInfo.BuilderConfiguration: the builder configuration that reflects the internal state
Since: 5.3.14

getContentNegotiationManager	back to summary
public ContentNegotiationManager getContentNegotiationManager() Return the configured `ContentNegotiationManager`.

getCustomMethodCondition back to summary

getCustomMethodCondition	back to summary
protected 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:Method the handler method for which to create the condition Returns:RequestCondition<?> the condition, or `null` Annotations @Nullable

protected 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:Method: the handler method for which to create the condition

Returns:RequestCondition<?>

the condition, or null

Annotations

@Nullable

getCustomTypeCondition back to summary

getCustomTypeCondition	back to summary
protected 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:Class<?> the handler type for which to create the condition Returns:RequestCondition<?> the condition, or `null` Annotations @Nullable

protected 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:Class<?>: the handler type for which to create the condition

Returns:RequestCondition<?>

the condition, or null

Annotations

@Nullable

getFileExtensions	back to summary
public List<String> getFileExtensions() Deprecated as of 5.2.4. See class-level note on the deprecation of path extension config options. Return the file extensions to use for suffix pattern matching. Annotations @Nullable @Deprecated @SuppressWarnings:deprecation

getFileExtensions

back to summary

public List<String> getFileExtensions()

Deprecated

as of 5.2.4. See class-level note on the deprecation of path extension config options.

Return the file extensions to use for suffix pattern matching.

Annotations

@Nullable
@Deprecated
@SuppressWarnings:deprecation

getMappingForMethod back to summary

getMappingForMethod	back to summary
protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) Implements abstract org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getMappingForMethod. Uses type-level and method-level `@RequestMapping` and `@HttpExchange` annotations to create the `RequestMappingInfo`. Parameters method:Method Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getMappingForMethod. the method to provide a mapping for handlerType:Class<?> Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getMappingForMethod. the handler type, possibly a subtype of the method's declaring class Returns:RequestMappingInfo the created `RequestMappingInfo`, or `null` if the method does not have a `@RequestMapping` or `@HttpExchange` annotation Annotations @Override @Nullable See Also `getCustomMethodCondition(Method)`, `getCustomTypeCondition(Class)`

protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType)

Implements abstract org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getMappingForMethod.

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

Parameters

method:Method

Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getMappingForMethod.

the method to provide a mapping for

handlerType:Class<?>

Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getMappingForMethod.

the handler type, possibly a subtype of the method's declaring class

Returns:RequestMappingInfo

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

Annotations

@Override
@Nullable

getPathPrefix	back to summary
pack-priv String getPathPrefix(Class<?> handlerType) Annotations @Nullable

getPathPrefixes	back to summary
public Map<String, Predicate<Class<?>>> getPathPrefixes() The configured path prefixes as a read-only, possibly empty map. Since 5.1

getPathPrefixes

back to summary

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

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

Since: 5.1

initCorsConfiguration	back to summary
protected CorsConfiguration initCorsConfiguration(Object handler, Method method, RequestMappingInfo mappingInfo) Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.initCorsConfiguration. Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.initCorsConfiguration. Extract and return the CORS configuration for the mapping. Annotations @Override

initCorsConfiguration

back to summary

protected CorsConfiguration initCorsConfiguration(Object handler, Method method, RequestMappingInfo mappingInfo)

Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.initCorsConfiguration.

Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.initCorsConfiguration.

Extract and return the CORS configuration for the mapping.

Annotations

@Override

isHandler back to summary

isHandler	back to summary
protected boolean isHandler(Class<?> beanType) Implements abstract org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.isHandler. Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.isHandler. Whether the given type is a handler with handler methods. Expects a handler to have a type-level @`Controller` annotation. Parameters beanType:Class<?> the type of the bean being checked Returns:boolean "true" if this a handler type, "false" otherwise. Annotations @Override

protected boolean isHandler(Class<?> beanType)

Implements abstract org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.isHandler.

Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.isHandler.

Whether the given type is a handler with handler methods.

Expects a handler to have a type-level @Controller annotation.

Parameters

beanType:Class<?>: the type of the bean being checked

Returns:boolean

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

Annotations

@Override

match back to summary

match	back to summary
public RequestMatchResult match(HttpServletRequest request, String pattern) Implements org.springframework.web.servlet.handler.MatchableHandlerMapping.match. Doc from org.springframework.web.servlet.handler.MatchableHandlerMapping.match. Determine whether the request matches the given pattern. Use this method when `getPatternParser()` returns `null` which means that the `HandlerMapping` is using String pattern matching. Parameters request:HttpServletRequest the current request pattern:String the pattern to match Returns:RequestMatchResult the result from request matching, or `null` if none Annotations @Override

public RequestMatchResult match(HttpServletRequest request, String pattern)

Implements org.springframework.web.servlet.handler.MatchableHandlerMapping.match.

Doc from org.springframework.web.servlet.handler.MatchableHandlerMapping.match.

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

Parameters

request:HttpServletRequest: the current request
pattern:String: the pattern to match

Returns:RequestMatchResult

the result from request matching, or null if none

Annotations

@Override

registerHandlerMethod back to summary

registerHandlerMethod	back to summary
protected void registerHandlerMethod(Object handler, Method method, RequestMappingInfo mapping) Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.registerHandlerMethod. Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.registerHandlerMethod. 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 `org.springframework.web.util.pattern.PathPattern` or `org.springframework.util.PathMatcher` based matching. Parameters handler:Object the bean name of the handler or the handler instance method:Method the method to register mapping:RequestMappingInfo the mapping conditions associated with the handler method Annotations @Override

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

Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.registerHandlerMethod.

Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.registerHandlerMethod.

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 org.springframework.web.util.pattern.PathPattern or org.springframework.util.PathMatcher based matching.

Parameters

handler:Object: the bean name of the handler or the handler instance
method:Method: the method to register
mapping:RequestMappingInfo: the mapping conditions associated with the handler method

Annotations

@Override

registerMapping	back to summary
public void registerMapping(RequestMappingInfo mapping, Object handler, Method method) Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.registerMapping. Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.registerMapping. Register the given mapping. This method may be invoked at runtime after initialization has completed. Parameters mapping:RequestMappingInfo the mapping for the handler method handler:Object the handler method:Method the method Annotations @Override

registerMapping

back to summary

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

Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.registerMapping.

Doc from org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.registerMapping.

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

Parameters

mapping:RequestMappingInfo: the mapping for the handler method
handler:Object: the handler
method:Method: the method

Annotations

@Override

resolveCorsAnnotationValue	back to summary
private String resolveCorsAnnotationValue(String value)

resolveEmbeddedValuesInPatterns	back to summary
protected String[] resolveEmbeddedValuesInPatterns(String[] patterns) Resolve placeholder values in the given array of patterns. Returns:String[] a new array with updated patterns

resolveEmbeddedValuesInPatterns

back to summary

protected String[] resolveEmbeddedValuesInPatterns(String[] patterns)

Resolve placeholder values in the given array of patterns.

Returns:String[]: a new array with updated patterns

setContentNegotiationManager	back to summary
public void setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager) Set the `ContentNegotiationManager` to use to determine requested media types. If not set, the default constructor is used.

setEmbeddedValueResolver	back to summary
public void setEmbeddedValueResolver(StringValueResolver resolver) Implements org.springframework.context.EmbeddedValueResolverAware.setEmbeddedValueResolver. Doc from org.springframework.context.EmbeddedValueResolverAware.setEmbeddedValueResolver. Set the StringValueResolver to use for resolving embedded definition values. Annotations @Override

setEmbeddedValueResolver

back to summary

public void setEmbeddedValueResolver(StringValueResolver resolver)

Implements org.springframework.context.EmbeddedValueResolverAware.setEmbeddedValueResolver.

Doc from org.springframework.context.EmbeddedValueResolverAware.setEmbeddedValueResolver.

Set the StringValueResolver to use for resolving embedded definition values.

Annotations

@Override

setPathPrefixes back to summary

setPathPrefixes	back to summary
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:Map<String, Predicate<Class<?>>> a map with path prefixes as key Since 5.1

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:Map<String, Predicate<Class<?>>>: a map with path prefixes as key

Since

5.1

setPatternParser back to summary

setPatternParser	back to summary
public void setPatternParser(PathPatternParser patternParser) Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.setPatternParser. Doc from org.springframework.web.servlet.handler.AbstractHandlerMapping.setPatternParser. Set the `PathPatternParser` to parse `patterns` with for URL path matching. Parsed patterns provide a more modern and efficient alternative to String path matching via `AntPathMatcher`. Note: This property is mutually exclusive with the below properties, all of which are not necessary for parsed patterns and are ignored when a `PathPatternParser` is available: `setAlwaysUseFullPath` -- parsed patterns always use the full path and consider the servletPath only when a Servlet is mapped by path prefix. `setRemoveSemicolonContent` -- parsed patterns always ignore semicolon content for path matching purposes, but path parameters remain available for use in controllers via `@MatrixVariable`. `setUrlDecode` -- parsed patterns match one decoded path segment at a time and therefore don't need to decode the full path. `setUrlPathHelper` -- for parsed patterns, the request path is parsed once in `DispatcherServlet` or in `ServletRequestPathFilter` using `ServletRequestPathUtils` and cached in a request attribute. `setPathMatcher` -- a parsed patterns encapsulates the logic for path matching and does need a `PathMatcher`. By default, as of 6.0, this is set to a `PathPatternParser` instance with default settings and therefore use of parsed patterns is enabled. Set this to `null` to switch to String path matching via `AntPathMatcher` instead. Parameters patternParser:PathPatternParser the parser to use Annotations @Override

public void setPatternParser(PathPatternParser patternParser)

Overrides org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.setPatternParser.

Doc from org.springframework.web.servlet.handler.AbstractHandlerMapping.setPatternParser.

Set the PathPatternParser to parse patterns with for URL path matching. Parsed patterns provide a more modern and efficient alternative to String path matching via AntPathMatcher.

Note: This property is mutually exclusive with the below properties, all of which are not necessary for parsed patterns and are ignored when a PathPatternParser is available:

setAlwaysUseFullPath -- parsed patterns always use the full path and consider the servletPath only when a Servlet is mapped by path prefix.
setRemoveSemicolonContent -- parsed patterns always ignore semicolon content for path matching purposes, but path parameters remain available for use in controllers via @MatrixVariable.
setUrlDecode -- parsed patterns match one decoded path segment at a time and therefore don't need to decode the full path.
setUrlPathHelper -- for parsed patterns, the request path is parsed once in DispatcherServlet or in ServletRequestPathFilter using ServletRequestPathUtils and cached in a request attribute.
setPathMatcher -- a parsed patterns encapsulates the logic for path matching and does need a PathMatcher.

By default, as of 6.0, this is set to a PathPatternParser instance with default settings and therefore use of parsed patterns is enabled. Set this to null to switch to String path matching via AntPathMatcher instead.

Parameters

patternParser:PathPatternParser: the parser to use

Annotations

@Override

setUseRegisteredSuffixPatternMatch back to summary

setUseRegisteredSuffixPatternMatch	back to summary
public void setUseRegisteredSuffixPatternMatch(boolean useRegisteredSuffixPatternMatch) Deprecated as of 5.2.4. See class level note on the deprecation of path extension config options. 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". Note This property is ignored when `setPatternParser(PathPatternParser)` is configured. Annotations @Deprecated

public void setUseRegisteredSuffixPatternMatch(boolean useRegisteredSuffixPatternMatch)

Deprecated

as of 5.2.4. See class level note on the deprecation of path extension config options.

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".

Note

This property is ignored when setPatternParser(PathPatternParser) is configured.

Annotations

@Deprecated

setUseSuffixPatternMatch back to summary

setUseSuffixPatternMatch	back to summary
public void setUseSuffixPatternMatch(boolean useSuffixPatternMatch) Deprecated as of 5.2.4. See class level note on the deprecation of path extension config options. As there is no replacement for this method, in 5.2.x it is necessary to set it to `false`. In 5.3 the default changes to `false` and use of this property becomes unnecessary. Whether to use suffix pattern match (".") when matching patterns to requests. If enabled a method mapped to "/users" also matches to "/users.". By default value this is set to `false`. Also see `setUseRegisteredSuffixPatternMatch(boolean)` for more fine-grained control over specific suffixes to allow. Note This property is ignored when `setPatternParser(PathPatternParser)` is configured. Annotations @Deprecated

public void setUseSuffixPatternMatch(boolean useSuffixPatternMatch)

Deprecated

as of 5.2.4. See class level note on the deprecation of path extension config options. As there is no replacement for this method, in 5.2.x it is necessary to set it to false. In 5.3 the default changes to false and use of this property becomes unnecessary.

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

By default value this is set to false.

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

Note

This property is ignored when setPatternParser(PathPatternParser) is configured.

Annotations

@Deprecated

setUseTrailingSlashMatch back to summary

setUseTrailingSlashMatch	back to summary
public void setUseTrailingSlashMatch(boolean useTrailingSlashMatch) Deprecated since 6.0. as of 6.0, see `PathPatternParser#setMatchOptionalTrailingSeparator(boolean)` 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 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 useTrailingSlashMatch)

Deprecated

since 6.0.

as of 6.0, see PathPatternParser#setMatchOptionalTrailingSeparator(boolean)

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 was changed in 6.0 from true to false in order to support the deprecation of the property.

Annotations

@Deprecated
since:6.0

toMethodArray	back to summary
private static RequestMethod[] toMethodArray(String method)

toStringArray	back to summary
private static String[] toStringArray(String value)

updateConsumesCondition	back to summary
private void updateConsumesCondition(RequestMappingInfo info, Method method)

updateCorsConfig	back to summary
private void updateCorsConfig(CorsConfiguration config, CrossOrigin annotation)

useRegisteredSuffixPatternMatch back to summary

useRegisteredSuffixPatternMatch	back to summary
public boolean useRegisteredSuffixPatternMatch() Deprecated as of 5.2.4. See deprecation notice on `setUseRegisteredSuffixPatternMatch(boolean)`. Whether to use registered suffixes for pattern matching. Annotations @Deprecated

public boolean useRegisteredSuffixPatternMatch()

Deprecated

as of 5.2.4. See deprecation notice on setUseRegisteredSuffixPatternMatch(boolean).

Whether to use registered suffixes for pattern matching.

Annotations

@Deprecated

useSuffixPatternMatch back to summary

useSuffixPatternMatch	back to summary
public boolean useSuffixPatternMatch() Deprecated as of 5.2.4. See deprecation notice on `setUseSuffixPatternMatch(boolean)`. Whether to use registered suffixes for pattern matching. Annotations @Deprecated

public boolean useSuffixPatternMatch()

Deprecated

as of 5.2.4. See deprecation notice on setUseSuffixPatternMatch(boolean).

Whether to use registered suffixes for pattern matching.

Annotations

@Deprecated

useTrailingSlashMatch	back to summary
public boolean useTrailingSlashMatch() Whether to match to URLs irrespective of the presence of a trailing slash.

org.springframework.web.servlet.mvc.method.annotation back to summary

private Class RequestMappingHandlerMapping.AnnotationDescriptor

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping.AnnotationDescriptor

Field Summary

Modifier and Type	Field and Description
private final Annotation	annotation
private final MergedAnnotation<?>	root

Constructor Summary

Access	Constructor and Description
pack-priv	AnnotationDescriptor(MergedAnnotation<Annotation> mergedAnnotation)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

annotation	back to summary
private final Annotation annotation

root	back to summary
private final MergedAnnotation<?> root

Constructor Detail

AnnotationDescriptor	back to summary
pack-priv AnnotationDescriptor(MergedAnnotation<Annotation> mergedAnnotation)

Method Detail

equals back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class RequestMappingHandlerMapping

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class RequestMappingHandlerMapping.AnnotationDescriptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail