public final class PatternsRequestCondition extends AbstractRequestCondition<PatternsRequestCondition>
Constructor and Description |
---|
PatternsRequestCondition(String... patterns)
Creates a new instance with the given URL patterns.
|
PatternsRequestCondition(String[] patterns,
HttpRequestPathHelper pathHelper,
PathMatcher pathMatcher,
boolean useSuffixPatternMatch,
boolean useTrailingSlashMatch,
Set<String> extensions)
Creates a new instance with the given URL patterns.
|
Modifier and Type | Method and Description |
---|---|
PatternsRequestCondition |
combine(PatternsRequestCondition other)
Returns a new instance with URL patterns from the current instance ("this") and
the "other" instance as follows:
If there are patterns in both instances, combine the patterns in "this" with
the patterns in "other" using
PathMatcher.combine(String, String) . |
int |
compareTo(PatternsRequestCondition other,
ServerWebExchange exchange)
Compare the two conditions based on the URL patterns they contain.
|
protected Collection<String> |
getContent()
Return the discrete items a request condition is composed of.
|
PatternsRequestCondition |
getMatchingCondition(ServerWebExchange exchange)
Checks if any of the patterns match the given request and returns an instance
that is guaranteed to contain matching patterns, sorted via
PathMatcher.getPatternComparator(String) . |
List<String> |
getMatchingPatterns(String lookupPath)
Find the patterns matching the given lookup path.
|
Set<String> |
getPatterns() |
protected String |
getToStringInfix()
The notation to use when printing discrete items of content.
|
equals, hashCode, isEmpty, toString
public PatternsRequestCondition(String... patterns)
patterns
- 0 or more URL patterns; if 0 the condition will match to every request.public PatternsRequestCondition(String[] patterns, HttpRequestPathHelper pathHelper, PathMatcher pathMatcher, boolean useSuffixPatternMatch, boolean useTrailingSlashMatch, Set<String> extensions)
patterns
- the URL patterns to use; if 0, the condition will match to every request.pathHelper
- to determine the lookup path for a requestpathMatcher
- for pattern path matchinguseSuffixPatternMatch
- whether to enable matching by suffix (".*")useTrailingSlashMatch
- whether to match irrespective of a trailing slashextensions
- file extensions to consider for path matchingprotected Collection<String> getContent()
AbstractRequestCondition
For example URL patterns, HTTP request methods, param expressions, etc.
getContent
in class AbstractRequestCondition<PatternsRequestCondition>
null
protected String getToStringInfix()
AbstractRequestCondition
For example " || "
for URL patterns or " && "
for param expressions.
getToStringInfix
in class AbstractRequestCondition<PatternsRequestCondition>
public PatternsRequestCondition combine(PatternsRequestCondition other)
PathMatcher.combine(String, String)
.
other
- the condition to combine with.public PatternsRequestCondition getMatchingCondition(ServerWebExchange exchange)
PathMatcher.getPatternComparator(String)
.
A matching pattern is obtained by making checks in the following order:
exchange
- the current exchangenull
if no patterns match.public List<String> getMatchingPatterns(String lookupPath)
getMatchingCondition(ServerWebExchange)
.
This method is provided as an alternative to be used if no request is available
(e.g. introspection, tooling, etc).lookupPath
- the lookup path to match to existing patternspublic int compareTo(PatternsRequestCondition other, ServerWebExchange exchange)
PathMatcher.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(ServerWebExchange)
to ensure they
contain only patterns that match the request and are sorted with
the best matches on top.