Class PatternsRequestCondition
- All Implemented Interfaces:
RequestCondition<PatternsRequestCondition>
In contrast to PathPatternsRequestCondition
which uses parsed
PathPattern
s, this condition does String pattern matching via
AntPathMatcher
.
- Since:
- 3.1
- Author:
- Rossen Stoyanchev
-
Constructor Summary
ConstructorDescriptionPatternsRequestCondition
(String... patterns) Constructor with URL patterns which are prepended with "/" if necessary.PatternsRequestCondition
(String[] patterns, boolean useTrailingSlashMatch, PathMatcher pathMatcher) Variant ofPatternsRequestCondition(String...)
with aPathMatcher
and flag for matching trailing slashes.PatternsRequestCondition
(String[] patterns, UrlPathHelper urlPathHelper, PathMatcher pathMatcher, boolean useTrailingSlashMatch) Deprecated.PatternsRequestCondition
(String[] patterns, UrlPathHelper urlPathHelper, PathMatcher pathMatcher, boolean useSuffixPatternMatch, boolean useTrailingSlashMatch) Deprecated.as of 5.2.4.PatternsRequestCondition
(String[] patterns, UrlPathHelper urlPathHelper, PathMatcher pathMatcher, boolean useSuffixPatternMatch, boolean useTrailingSlashMatch, List<String> fileExtensions) Deprecated.as of 5.2.4. -
Method Summary
Modifier and TypeMethodDescriptioncombine
(PatternsRequestCondition other) Combine the patterns of the current and of the other instances as follows: If only one instance has patterns, use those.int
compareTo
(PatternsRequestCondition other, HttpServletRequest request) Compare the two conditions based on the URL patterns they contain.protected Collection<String>
Return the discrete items a request condition is composed of.Return the mapping paths that are not patterns.getMatchingCondition
(HttpServletRequest request) Checks if any of the patterns match the given request and returns an instance that is guaranteed to contain matching patterns, sorted viaPathMatcher.getPatternComparator(String)
.getMatchingPatterns
(String lookupPath) Find the patterns matching the given lookup path.protected String
The notation to use when printing discrete items of content.boolean
Whether the condition is the "" (empty path) mapping.Methods inherited from class org.springframework.web.servlet.mvc.condition.AbstractRequestCondition
equals, hashCode, isEmpty, toString
-
Constructor Details
-
PatternsRequestCondition
Constructor with URL patterns which are prepended with "/" if necessary.- Parameters:
patterns
- 0 or more URL patterns; no patterns results in an empty path""
mapping which matches all requests.
-
PatternsRequestCondition
public PatternsRequestCondition(String[] patterns, boolean useTrailingSlashMatch, @Nullable PathMatcher pathMatcher) Variant ofPatternsRequestCondition(String...)
with aPathMatcher
and flag for matching trailing slashes.- Since:
- 5.3
-
PatternsRequestCondition
@Deprecated public PatternsRequestCondition(String[] patterns, @Nullable UrlPathHelper urlPathHelper, @Nullable PathMatcher pathMatcher, boolean useTrailingSlashMatch) Deprecated.as of 5.3 in favor ofPatternsRequestCondition(String[], boolean, PathMatcher)
.Variant ofPatternsRequestCondition(String...)
with aUrlPathHelper
and aPathMatcher
, and whether to match trailing slashes.As of 5.3 the path is obtained through the static method
UrlPathHelper.getResolvedLookupPath(jakarta.servlet.ServletRequest)
and aUrlPathHelper
does not need to be passed in.- Since:
- 5.2.4
-
PatternsRequestCondition
@Deprecated public PatternsRequestCondition(String[] patterns, @Nullable UrlPathHelper urlPathHelper, @Nullable PathMatcher pathMatcher, boolean useSuffixPatternMatch, boolean useTrailingSlashMatch) Deprecated.as of 5.2.4. See class-level note inRequestMappingHandlerMapping
on the deprecation of path extension config options.Variant ofPatternsRequestCondition(String...)
with aUrlPathHelper
and aPathMatcher
, and flags for matching with suffixes and trailing slashes.As of 5.3 the path is obtained through the static method
UrlPathHelper.getResolvedLookupPath(jakarta.servlet.ServletRequest)
and aUrlPathHelper
does not need to be passed in. -
PatternsRequestCondition
@Deprecated public PatternsRequestCondition(String[] patterns, @Nullable UrlPathHelper urlPathHelper, @Nullable PathMatcher pathMatcher, boolean useSuffixPatternMatch, boolean useTrailingSlashMatch, @Nullable List<String> fileExtensions) Deprecated.as of 5.2.4. See class-level note inRequestMappingHandlerMapping
on the deprecation of path extension config options.Variant ofPatternsRequestCondition(String...)
with aUrlPathHelper
and aPathMatcher
, and flags for matching with suffixes and trailing slashes, along with specific extensions.As of 5.3 the path is obtained through the static method
UrlPathHelper.getResolvedLookupPath(jakarta.servlet.ServletRequest)
and aUrlPathHelper
does not need to be passed in.
-
-
Method Details
-
getPatterns
-
getContent
Description copied from class:AbstractRequestCondition
Return the discrete items a request condition is composed of.For example URL patterns, HTTP request methods, param expressions, etc.
- Specified by:
getContent
in classAbstractRequestCondition<PatternsRequestCondition>
- Returns:
- a collection of objects (never
null
)
-
getToStringInfix
Description copied from class:AbstractRequestCondition
The notation to use when printing discrete items of content.For example
" || "
for URL patterns or" && "
for param expressions.- Specified by:
getToStringInfix
in classAbstractRequestCondition<PatternsRequestCondition>
-
isEmptyPathMapping
public boolean isEmptyPathMapping()Whether the condition is the "" (empty path) mapping. -
getDirectPaths
Return the mapping paths that are not patterns.- Since:
- 5.3
-
combine
Combine the patterns of the current and of the other instances as follows:- If only one instance has patterns, use those.
- If both have patterns, combine patterns from "this" instance with
patterns from the other instance via
PathMatcher.combine(String, String)
. - If neither has patterns, use
""
and"/"
as root path patterns.
- Parameters:
other
- the condition to combine with.- Returns:
- a request condition instance that is the result of combining the two condition instances.
-
getMatchingCondition
Checks if any of the patterns match the given request and returns an instance that is guaranteed to contain matching patterns, sorted viaPathMatcher.getPatternComparator(String)
.A matching pattern is obtained by making checks in the following order:
- Direct match
- Pattern match with ".*" appended if the pattern doesn't already contain a "."
- Pattern match
- Pattern match with "/" appended if the pattern doesn't already end in "/"
- Parameters:
request
- the current request- Returns:
- the same instance if the condition contains no patterns;
or a new condition with sorted matching patterns;
or
null
if no patterns match.
-
getMatchingPatterns
Find the patterns matching the given lookup path. Invoking this method should yield results equivalent to those of callinggetMatchingCondition(jakarta.servlet.http.HttpServletRequest)
. This method is provided as an alternative to be used if no request is available (e.g. introspection, tooling, etc).- Parameters:
lookupPath
- the lookup path to match to existing patterns- Returns:
- a collection of matching patterns sorted with the closest match at the top
-
compareTo
Compare the two conditions based on the URL patterns they contain. Patterns are compared one at a time, from top to bottom viaPathMatcher.getPatternComparator(String)
. If all compared patterns match equally, but one instance has more patterns, it is considered a closer match.It is assumed that both instances have been obtained via
getMatchingCondition(HttpServletRequest)
to ensure they contain only patterns that match the request and are sorted with the best matches on top.
-
PatternsRequestCondition(String[], boolean, PathMatcher)
.