Class PathMatchConfigurer
- java.lang.Object
- org.springframework.web.servlet.config.annotation.PathMatchConfigurer
public class PathMatchConfigurer extends Object
Helps with configuring HandlerMappings path matching options such as trailing slash match, suffix registration, path matcher and path helper.Configured path matcher and path helper instances are shared for:
- RequestMappings
- ViewControllerMappings
- ResourcesMappings
- Since:
- 4.0.3
- Author:
- Brian Clozel
- See Also:
RequestMappingHandlerMapping
,SimpleUrlHandlerMapping
Constructor Summary
Constructors Constructor Description PathMatchConfigurer()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PathMatcher
getPathMatcher()
UrlPathHelper
getUrlPathHelper()
Boolean
isUseRegisteredSuffixPatternMatch()
Boolean
isUseSuffixPatternMatch()
Boolean
isUseTrailingSlashMatch()
PathMatchConfigurer
setPathMatcher(PathMatcher pathMatcher)
Set the PathMatcher implementation to use for matching URL paths against registered URL patterns.PathMatchConfigurer
setUrlPathHelper(UrlPathHelper urlPathHelper)
Set the UrlPathHelper to use for resolution of lookup paths.PathMatchConfigurer
setUseRegisteredSuffixPatternMatch(Boolean registeredSuffixPatternMatch)
Whether suffix pattern matching should work only against path extensions explicitly registered when youconfigure content negotiation
.PathMatchConfigurer
setUseSuffixPatternMatch(Boolean suffixPatternMatch)
Whether to use suffix pattern match (".*") when matching patterns to requests.PathMatchConfigurer
setUseTrailingSlashMatch(Boolean trailingSlashMatch)
Whether to match to URLs irrespective of the presence of a trailing slash.
Constructor Detail
PathMatchConfigurer
public PathMatchConfigurer()
Method Detail
setUseSuffixPatternMatch
public PathMatchConfigurer setUseSuffixPatternMatch(Boolean suffixPatternMatch)
Whether to use suffix pattern match (".*") when matching patterns to requests. If enabled a method mapped to "/users" also matches to "/users.*".By default this is set to
true
.- See Also:
registeredSuffixPatternMatch
setUseTrailingSlashMatch
public PathMatchConfigurer setUseTrailingSlashMatch(Boolean trailingSlashMatch)
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
.
setUseRegisteredSuffixPatternMatch
public PathMatchConfigurer setUseRegisteredSuffixPatternMatch(Boolean registeredSuffixPatternMatch)
Whether suffix pattern matching should work only against path extensions explicitly registered when youconfigure content negotiation
. 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".
setUrlPathHelper
public PathMatchConfigurer setUrlPathHelper(UrlPathHelper urlPathHelper)
Set the UrlPathHelper to use for resolution of lookup paths.Use this to override the default UrlPathHelper with a custom subclass, or to share common UrlPathHelper settings across multiple HandlerMappings and MethodNameResolvers.
setPathMatcher
public PathMatchConfigurer setPathMatcher(PathMatcher pathMatcher)
Set the PathMatcher implementation to use for matching URL paths against registered URL patterns. Default is AntPathMatcher.- See Also:
AntPathMatcher
isUseSuffixPatternMatch
public Boolean isUseSuffixPatternMatch()
isUseTrailingSlashMatch
public Boolean isUseTrailingSlashMatch()
isUseRegisteredSuffixPatternMatch
public Boolean isUseRegisteredSuffixPatternMatch()
getUrlPathHelper
public UrlPathHelper getUrlPathHelper()
getPathMatcher
public PathMatcher getPathMatcher()