public interface PathMatcher
String
-based path matching.
Used by PathMatchingResourcePatternResolver
,
AbstractUrlHandlerMapping
,
and WebContentInterceptor
.
The default implementation is AntPathMatcher
, supporting the
Ant-style pattern syntax.
AntPathMatcher
Modifier and Type | Method and Description |
---|---|
String |
combine(String pattern1,
String pattern2)
Combines two patterns into a new pattern that is returned.
|
String |
extractPathWithinPattern(String pattern,
String path)
Given a pattern and a full path, determine the pattern-mapped part.
|
Map<String,String> |
extractUriTemplateVariables(String pattern,
String path)
Given a pattern and a full path, extract the URI template variables.
|
Comparator<String> |
getPatternComparator(String path)
Given a full path, returns a
Comparator suitable for sorting patterns
in order of explicitness for that path. |
boolean |
isPattern(String path)
Does the given
path represent a pattern that can be matched
by an implementation of this interface? |
boolean |
match(String pattern,
String path)
Match the given
path against the given pattern ,
according to this PathMatcher's matching strategy. |
boolean |
matchStart(String pattern,
String path)
Match the given
path against the corresponding part of the given
pattern , according to this PathMatcher's matching strategy. |
boolean isPattern(String path)
path
represent a pattern that can be matched
by an implementation of this interface?
If the return value is false
, then the match(java.lang.String, java.lang.String)
method does not have to be used because direct equality comparisons
on the static path Strings will lead to the same result.
path
- the path to checktrue
if the given path
represents a patternboolean match(String pattern, String path)
path
against the given pattern
,
according to this PathMatcher's matching strategy.pattern
- the pattern to match againstpath
- the path to testtrue
if the supplied path
matched,
false
if it didn'tboolean matchStart(String pattern, String path)
path
against the corresponding part of the given
pattern
, according to this PathMatcher's matching strategy.
Determines whether the pattern at least matches as far as the given base path goes, assuming that a full path may then match as well.
pattern
- the pattern to match againstpath
- the path to testtrue
if the supplied path
matched,
false
if it didn'tString extractPathWithinPattern(String pattern, String path)
This method is supposed to find out which part of the path is matched dynamically through an actual pattern, that is, it strips off a statically defined leading path from the given full path, returning only the actually pattern-matched part of the path.
For example: For "myroot/*.html" as pattern and "myroot/myfile.html" as full path, this method should return "myfile.html". The detailed determination rules are specified to this PathMatcher's matching strategy.
A simple implementation may return the given full path as-is in case
of an actual pattern, and the empty String in case of the pattern not
containing any dynamic parts (i.e. the pattern
parameter being
a static path that wouldn't qualify as an actual pattern
).
A sophisticated implementation will differentiate between the static parts
and the dynamic parts of the given path pattern.
pattern
- the path patternpath
- the full path to introspectpath
(never null
)Map<String,String> extractUriTemplateVariables(String pattern, String path)
For example: For pattern "/hotels/{hotel}" and path "/hotels/1", this method will return a map containing "hotel"->"1".
pattern
- the path pattern, possibly containing URI templatespath
- the full path to extract template variables fromComparator<String> getPatternComparator(String path)
Comparator
suitable for sorting patterns
in order of explicitness for that path.
The full algorithm used depends on the underlying implementation,
but generally, the returned Comparator
will
sort
a list so that more specific patterns come before generic patterns.
path
- the full path to use for comparisonString combine(String pattern1, String pattern2)
The full algorithm used for combining the two pattern depends on the underlying implementation.
pattern1
- the first patternpattern2
- the second patternIllegalArgumentException
- when the two patterns cannot be combined