Class AntPathMatcher
- All Implemented Interfaces:
PathMatcher
Part of this mapping code has been kindly borrowed from Apache Ant.
The mapping matches URLs using the following rules:
?
matches one character*
matches zero or more characters**
matches zero or more directories in a path{spring:[a-z]+}
matches the regexp[a-z]+
as a path variable named "spring"
Examples
com/t?st.jsp
— matchescom/test.jsp
but alsocom/tast.jsp
orcom/txst.jsp
com/*.jsp
— matches all.jsp
files in thecom
directorycom/**/test.jsp
— matches alltest.jsp
files underneath thecom
pathorg/springframework/**/*.jsp
— matches all.jsp
files underneath theorg/springframework
pathorg/**/servlet/bla.jsp
— matchesorg/springframework/servlet/bla.jsp
but alsoorg/springframework/testing/servlet/bla.jsp
andorg/servlet/bla.jsp
com/{filename:\\w+}.jsp
will matchcom/test.jsp
and assign the valuetest
to thefilename
variable
Note: a pattern and a path must both be absolute or must both be relative in order for the two to match. Therefore, it is recommended that users of this implementation to sanitize patterns in order to prefix them with "/" as it makes sense in the context in which they're used.
- Since:
- 16.07.2003
- Author:
- Alef Arendsen, Juergen Hoeller, Rob Harrop, Arjen Poutsma, Rossen Stoyanchev, Sam Brannen, Vladislav Kisel
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static class
Tests whether a string matches against a pattern via a {link Pattern}. -
Field Summary
-
Constructor Summary
ConstructorDescriptionCreate a new instance with the {link #DEFAULT_PATH_SEPARATOR}. -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Actually match the givenpath
against the givenpattern
.protected AntPathMatcher.AntPathStringMatcher
getStringMatcher
(String pattern) Build or retrieve an {link AntPathStringMatcher} for the given pattern.boolean
Does the givenpath
represent a pattern that can be matched by an implementation of this interface?boolean
Match the givenpath
against the givenpattern
, according to this PathMatcher's matching strategy.boolean
matchStart
(String pattern, String path) Match the givenpath
against the corresponding part of the givenpattern
, according to this PathMatcher's matching strategy.protected String[]
tokenizePath
(String path) Tokenize the given path into parts, based on this matcher's settings.protected String[]
tokenizePattern
(String pattern) Tokenize the given path pattern into parts, based on this matcher's settings.
-
Field Details
-
DEFAULT_PATH_SEPARATOR
Default path separator: "/".- See Also:
-
-
Constructor Details
-
AntPathMatcher
public AntPathMatcher()Create a new instance with the {link #DEFAULT_PATH_SEPARATOR}.
-
-
Method Details
-
isPattern
Description copied from interface:PathMatcher
Does the givenpath
represent a pattern that can be matched by an implementation of this interface?If the return value is
false
, then the {link #match} method does not have to be used because direct equality comparisons on the static path Strings will lead to the same result.- Specified by:
isPattern
in interfacePathMatcher
- Parameters:
path
- the path to check- Returns:
true
if the givenpath
represents a pattern
-
match
Description copied from interface:PathMatcher
Match the givenpath
against the givenpattern
, according to this PathMatcher's matching strategy.- Specified by:
match
in interfacePathMatcher
- Parameters:
pattern
- the pattern to match againstpath
- the path to test- Returns:
true
if the suppliedpath
matched,false
if it didn't
-
matchStart
Description copied from interface:PathMatcher
Match the givenpath
against the corresponding part of the givenpattern
, 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.
- Specified by:
matchStart
in interfacePathMatcher
- Parameters:
pattern
- the pattern to match againstpath
- the path to test- Returns:
true
if the suppliedpath
matched,false
if it didn't
-
doMatch
protected boolean doMatch(String pattern, @Nullable String path, boolean fullMatch, @Nullable Map<String, String> uriTemplateVariables) Actually match the givenpath
against the givenpattern
.- Parameters:
pattern
- the pattern to match againstpath
- the path to testfullMatch
- whether a full pattern match is required (else a pattern match as far as the given base path goes is sufficient)- Returns:
true
if the suppliedpath
matched,false
if it didn't
-
tokenizePattern
Tokenize the given path pattern into parts, based on this matcher's settings.Performs caching based on {link #setCachePatterns}, delegating to {link #tokenizePath(String)} for the actual tokenization algorithm.
- Parameters:
pattern
- the pattern to tokenize- Returns:
- the tokenized pattern parts
-
tokenizePath
Tokenize the given path into parts, based on this matcher's settings.- Parameters:
path
- the path to tokenize- Returns:
- the tokenized path parts
-
getStringMatcher
Build or retrieve an {link AntPathStringMatcher} for the given pattern.The default implementation checks this AntPathMatcher's internal cache (see {link #setCachePatterns}), creating a new AntPathStringMatcher instance if no cached copy is found.
When encountering too many patterns to cache at runtime (the threshold is 65536), it turns the default cache off, assuming that arbitrary permutations of patterns are coming in, with little chance for encountering a recurring pattern.
This method may be overridden to implement a custom cache strategy.
- Parameters:
pattern
- the pattern to match against (nevernull
)- Returns:
- a corresponding AntPathStringMatcher (never
null
) see #setCachePatterns
-