Spring Framework 6.1.4 · org.springframework.web.servlet.config.annotation.PathMatchConfigurer

Modifier and Type	Field and Description
private PathMatcher	defaultPathMatcher
private PathPatternParser	defaultPatternParser
private UrlPathHelper	defaultUrlPathHelper
private PathMatcher	pathMatcher
private Map<String, Predicate<Class<?>>>	pathPrefixes
private PathPatternParser	patternParser
private boolean	preferPathMatcher
private Boolean	registeredSuffixPatternMatch
private Boolean	suffixPatternMatch
private Boolean	trailingSlashMatch
private UrlPathHelper	urlPathHelper

Access	Constructor and Description
public	PathMatchConfigurer()

Method Summary

Modifier and Type	Method and Description
public PathMatchConfigurer	addPathPrefix(String the prefix to apply prefix, Predicate<Class<?>> a predicate for matching controller types predicate) Configure a path prefix to apply to matching controller methods.
public PathMatcher	getPathMatcher()
protected PathMatcher	getPathMatcherOrDefault() Return the configured PathMatcher or a default, shared instance otherwise.
protected Map<String, Predicate<Class<?>>>	getPathPrefixes()
public PathPatternParser	getPatternParser() Return the `PathPatternParser` to use, if configured.
public PathPatternParser	getPatternParserOrDefault() Return the configured PathPatternParser or a default, shared instance otherwise.
public UrlPathHelper	getUrlPathHelper()
protected UrlPathHelper	getUrlPathHelperOrDefault() Return the configured UrlPathHelper or a default, shared instance otherwise.
public Boolean	isUseRegisteredSuffixPatternMatch() Deprecated as of 5.2.4, see deprecation note on `setUseRegisteredSuffixPatternMatch(Boolean)`. Whether to use registered suffixes for pattern matching.
public Boolean	isUseSuffixPatternMatch() Deprecated as of 5.2.4, see deprecation note on `setUseSuffixPatternMatch(Boolean)`. Whether to use registered suffixes for pattern matching.
public Boolean	isUseTrailingSlashMatch() Deprecated
protected boolean	preferPathMatcher() Whether to prefer `PathMatcher`.
public PathMatchConfigurer	setPathMatcher(PathMatcher pathMatcher) Set the PathMatcher to use for String pattern matching.
public PathMatchConfigurer	setPatternParser(PathPatternParser the parser to pre-parse patterns with patternParser) Set the `PathPatternParser` to parse `patterns` with for URL path matching.
public PathMatchConfigurer	setUrlPathHelper(UrlPathHelper urlPathHelper) Set the UrlPathHelper to use to resolve the mapping path for the application.
public PathMatchConfigurer	setUseRegisteredSuffixPatternMatch(Boolean registeredSuffixPatternMatch) Deprecated as of 5.2.4. Whether suffix pattern matching should work only against path extensions explicitly registered when you `configure content negotiation`.
public PathMatchConfigurer	setUseSuffixPatternMatch(Boolean suffixPatternMatch) Deprecated as of 5.2.4. Whether to use suffix pattern match (".*") when matching patterns to requests.
public PathMatchConfigurer	setUseTrailingSlashMatch(Boolean trailingSlashMatch) 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.

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

defaultPathMatcher	back to summary
private PathMatcher defaultPathMatcher Annotations @Nullable

defaultPatternParser	back to summary
private PathPatternParser defaultPatternParser Annotations @Nullable

defaultUrlPathHelper	back to summary
private UrlPathHelper defaultUrlPathHelper Annotations @Nullable

pathMatcher	back to summary
private PathMatcher pathMatcher Annotations @Nullable

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

patternParser	back to summary
private PathPatternParser patternParser Annotations @Nullable

preferPathMatcher	back to summary
private boolean preferPathMatcher

registeredSuffixPatternMatch	back to summary
private Boolean registeredSuffixPatternMatch Annotations @Nullable

suffixPatternMatch	back to summary
private Boolean suffixPatternMatch Annotations @Nullable

trailingSlashMatch	back to summary
private Boolean trailingSlashMatch Annotations @Nullable

urlPathHelper	back to summary
private UrlPathHelper urlPathHelper Annotations @Nullable

PathMatchConfigurer	back to summary
public PathMatchConfigurer()

Method Detail

addPathPrefix back to summary

addPathPrefix	back to summary
public PathMatchConfigurer addPathPrefix(String prefix, Predicate<Class<?>> predicate) Configure a path prefix to apply to matching controller methods. Prefixes are used to enrich the mappings of every `@RequestMapping` method whose controller type is matched by the corresponding `Predicate`. The prefix for the first matching predicate is used. Consider using `HandlerTypePredicate` to group controllers. Parameters prefix:String the prefix to apply predicate:Predicate<Class<?>> a predicate for matching controller types Since 5.1

public PathMatchConfigurer addPathPrefix(String prefix, Predicate<Class<?>> predicate)

Configure a path prefix to apply to matching controller methods.

Prefixes are used to enrich the mappings of every @RequestMapping method whose controller type is matched by the corresponding Predicate. The prefix for the first matching predicate is used.

Consider using HandlerTypePredicate to group controllers.

Parameters

prefix:String: the prefix to apply
predicate:Predicate<Class<?>>: a predicate for matching controller types

Since

5.1

getPathMatcher	back to summary
public PathMatcher getPathMatcher() Annotations @Nullable

getPathMatcherOrDefault	back to summary
protected PathMatcher getPathMatcherOrDefault() Return the configured PathMatcher or a default, shared instance otherwise. Since 5.3

getPathMatcherOrDefault

back to summary

protected PathMatcher getPathMatcherOrDefault()

Return the configured PathMatcher or a default, shared instance otherwise.

Since: 5.3

getPathPrefixes	back to summary
protected Map<String, Predicate<Class<?>>> getPathPrefixes() Annotations @Nullable

getPatternParser back to summary

getPatternParser	back to summary
public PathPatternParser getPatternParser() Return the `PathPatternParser` to use, if configured. Annotations @Nullable Since 5.3

public PathPatternParser getPatternParser()

Return the PathPatternParser to use, if configured.

Annotations

@Nullable

Since

5.3

getPatternParserOrDefault	back to summary
public PathPatternParser getPatternParserOrDefault() Return the configured PathPatternParser or a default, shared instance otherwise. Since 5.3.4

getPatternParserOrDefault

back to summary

public PathPatternParser getPatternParserOrDefault()

Return the configured PathPatternParser or a default, shared instance otherwise.

Since: 5.3.4

getUrlPathHelper	back to summary
public UrlPathHelper getUrlPathHelper() Annotations @Nullable

getUrlPathHelperOrDefault	back to summary
protected UrlPathHelper getUrlPathHelperOrDefault() Return the configured UrlPathHelper or a default, shared instance otherwise. Since 5.3

getUrlPathHelperOrDefault

back to summary

protected UrlPathHelper getUrlPathHelperOrDefault()

Return the configured UrlPathHelper or a default, shared instance otherwise.

Since: 5.3

isUseRegisteredSuffixPatternMatch back to summary

isUseRegisteredSuffixPatternMatch	back to summary
public Boolean isUseRegisteredSuffixPatternMatch() Deprecated as of 5.2.4, see deprecation note on `setUseRegisteredSuffixPatternMatch(Boolean)`. Whether to use registered suffixes for pattern matching. Annotations @Nullable @Deprecated

public Boolean isUseRegisteredSuffixPatternMatch()

Deprecated

as of 5.2.4, see deprecation note on setUseRegisteredSuffixPatternMatch(Boolean).

Whether to use registered suffixes for pattern matching.

Annotations

@Nullable
@Deprecated

isUseSuffixPatternMatch back to summary

isUseSuffixPatternMatch	back to summary
public Boolean isUseSuffixPatternMatch() Deprecated as of 5.2.4, see deprecation note on `setUseSuffixPatternMatch(Boolean)`. Whether to use registered suffixes for pattern matching. Annotations @Nullable @Deprecated

public Boolean isUseSuffixPatternMatch()

Deprecated

as of 5.2.4, see deprecation note on setUseSuffixPatternMatch(Boolean).

Whether to use registered suffixes for pattern matching.

Annotations

@Nullable
@Deprecated

isUseTrailingSlashMatch	back to summary
public Boolean isUseTrailingSlashMatch() Deprecated Annotations @Nullable @Deprecated

preferPathMatcher back to summary

preferPathMatcher	back to summary
protected boolean preferPathMatcher() Whether to prefer `PathMatcher`. This is the case when either is true: `PathPatternParser` is explicitly set to `null`. `PathPatternParser` is not explicitly set, and a `PathMatcher` related option is explicitly set. Since 6.0

protected boolean preferPathMatcher()

Whether to prefer PathMatcher. This is the case when either is true:

PathPatternParser is explicitly set to null.
PathPatternParser is not explicitly set, and a PathMatcher related option is explicitly set.

Since: 6.0

setPathMatcher back to summary

setPathMatcher	back to summary
public PathMatchConfigurer setPathMatcher(PathMatcher pathMatcher) Set the PathMatcher to use for String pattern matching. Note This property is mutually exclusive with `setPatternParser(PathPatternParser)`. If set, it enables use of String path matching, unless a `PathPatternParser` is also explicitly set in which case this property is ignored. By default this is an instance of `AntPathMatcher` with default settings.

public PathMatchConfigurer setPathMatcher(PathMatcher pathMatcher)

Set the PathMatcher to use for String pattern matching.

Note

This property is mutually exclusive with setPatternParser(PathPatternParser). If set, it enables use of String path matching, unless a PathPatternParser is also explicitly set in which case this property is ignored.

By default this is an instance of AntPathMatcher with default settings.

setPatternParser back to summary

setPatternParser	back to summary
public PathMatchConfigurer setPatternParser(PathPatternParser patternParser) 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 following other, `AntPathMatcher` related properties: `setUseSuffixPatternMatch(Boolean)` `setUseRegisteredSuffixPatternMatch(Boolean)` `setUrlPathHelper(UrlPathHelper)` `setPathMatcher(PathMatcher)` By default, as of 6.0, a `PathPatternParser` with default settings is used, which enables parsed `patterns`. Set this property to `null` to fall back on String path matching via `AntPathMatcher` instead, or alternatively, setting one of the above listed `AntPathMatcher` related properties has the same effect. Parameters patternParser:PathPatternParser the parser to pre-parse patterns with Since 5.3

public PathMatchConfigurer setPatternParser(PathPatternParser patternParser)

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 following other, AntPathMatcher related properties:

By default, as of 6.0, a PathPatternParser with default settings is used, which enables parsed patterns. Set this property to null to fall back on String path matching via AntPathMatcher instead, or alternatively, setting one of the above listed AntPathMatcher related properties has the same effect.

Parameters

patternParser:PathPatternParser: the parser to pre-parse patterns with

Since

5.3

setUrlPathHelper back to summary

setUrlPathHelper	back to summary
public PathMatchConfigurer setUrlPathHelper(UrlPathHelper urlPathHelper) Set the UrlPathHelper to use to resolve the mapping path for the application. Note This property is mutually exclusive with `setPatternParser(PathPatternParser)`. If set, it enables use of String path matching, unless a `PathPatternParser` is also explicitly set in which case this property is ignored. By default this is an instance of `UrlPathHelper` with default settings.

public PathMatchConfigurer setUrlPathHelper(UrlPathHelper urlPathHelper)

Set the UrlPathHelper to use to resolve the mapping path for the application.

Note

By default this is an instance of UrlPathHelper with default settings.

setUseRegisteredSuffixPatternMatch back to summary

setUseRegisteredSuffixPatternMatch	back to summary
public PathMatchConfigurer setUseRegisteredSuffixPatternMatch(Boolean registeredSuffixPatternMatch) Deprecated as of 5.2.4. See class-level note in `RequestMappingHandlerMapping` on the deprecation of path extension config options. Whether suffix pattern matching should work only against path extensions explicitly registered when you `configure content negotiation`. This is generally recommended to reduce ambiguity and to avoid issues such as when a "." appears in the path for other reasons. Note This property is mutually exclusive with `setPatternParser(PathPatternParser)`. If set, it enables use of String path matching, unless a `PathPatternParser` is also explicitly set in which case this property is ignored. By default this is set to "false". Annotations @Deprecated

public PathMatchConfigurer setUseRegisteredSuffixPatternMatch(Boolean registeredSuffixPatternMatch)

Deprecated

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

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

Note

By default this is set to "false".

Annotations

@Deprecated

setUseSuffixPatternMatch back to summary

setUseSuffixPatternMatch	back to summary
public PathMatchConfigurer setUseSuffixPatternMatch(Boolean suffixPatternMatch) Deprecated as of 5.2.4. See class-level note in `RequestMappingHandlerMapping` 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.". Note This property is mutually exclusive with `setPatternParser(PathPatternParser)`. If set, it enables use of String path matching, unless a `PathPatternParser` is also explicitly set in which case this property is ignored. By default this is set to `false`. Annotations @Deprecated

public PathMatchConfigurer setUseSuffixPatternMatch(Boolean suffixPatternMatch)

Deprecated

as of 5.2.4. See class-level note in RequestMappingHandlerMapping 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.*".

Note

By default this is set to false.

Annotations

@Deprecated

setUseTrailingSlashMatch back to summary

setUseTrailingSlashMatch	back to summary
public PathMatchConfigurer setUseTrailingSlashMatch(Boolean trailingSlashMatch) 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 PathMatchConfigurer setUseTrailingSlashMatch(Boolean trailingSlashMatch)

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 Class PathMatchConfigurer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail