public class AntPathMatcher extends Object
Part of this mapping code has been kindly borrowed from Apache Ant.
The mapping matches URLs using the following rules:
Some examples:
com/t?st.jsp
- matches com/test.jsp
but also
com/tast.jsp
or com/txst.jsp
com/*.jsp
- matches all
.jsp
files in the com
directorycom/**/test.jsp
- matches all
test.jsp
files underneath the com
pathorg/springframework/**/*.jsp
- matches all .jsp
files underneath the org/springframework
pathorg/**/servlet/bla.jsp
- matches org/springframework/servlet/bla.jsp
but also
org/springframework/testing/servlet/bla.jsp
and org/servlet/bla.jsp
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_PATH_SEPARATOR
Default path separator: "/".
|
Constructor and Description |
---|
AntPathMatcher() |
Modifier and Type | Method and Description |
---|---|
String |
combine(String pattern1,
String pattern2)
Combines two patterns into a new pattern that is returned.
|
static int |
countOccurrencesOf(String str,
String sub)
Count the occurrences of the substring in string s.
|
protected boolean |
doMatch(String pattern,
String path,
boolean fullMatch,
Map<String,String> uriTemplateVariables)
Actually match the given
path against the given pattern . |
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) |
Comparator<String> |
getPatternComparator(String path)
Given a full path, returns a
Comparator suitable for sorting patterns in order of explicitness. |
boolean |
isPattern(String path) |
boolean |
match(String pattern,
String path) |
boolean |
matchStart(String pattern,
String path) |
void |
setPathSeparator(String pathSeparator)
Set the path separator to use for pattern parsing.
|
public static final String DEFAULT_PATH_SEPARATOR
public void setPathSeparator(String pathSeparator)
pathSeparator
- The path separatorpublic boolean isPattern(String path)
path
- The pathpublic boolean match(String pattern, String path)
pattern
- The patternpath
- The pathpublic boolean matchStart(String pattern, String path)
pattern
- The patternpath
- The pathprotected boolean doMatch(String pattern, String path, boolean fullMatch, Map<String,String> uriTemplateVariables)
path
against the given pattern
.pattern
- the pattern to match againstpath
- the path String to testfullMatch
- whether a full pattern match is required (else a pattern match as far as the given
base path goes is sufficient)uriTemplateVariables
- the uri template variablestrue
if the supplied path
matched, false
if it didn'tpublic String extractPathWithinPattern(String pattern, String path)
For example:
/docs/cvs/commit.html
' and '/docs/cvs/commit.html
-> ''/docs/*
' and '/docs/cvs/commit
-> 'cvs/commit
'/docs/cvs/*.html
' and '/docs/cvs/commit.html
-> 'commit.html
'/docs/**
' and '/docs/cvs/commit
-> 'cvs/commit
'/docs/**\/*.html
' and '/docs/cvs/commit.html
-> 'cvs/commit.html
'/*.html
' and '/docs/cvs/commit.html
-> 'docs/cvs/commit.html
'*.html
' and '/docs/cvs/commit.html
-> '/docs/cvs/commit.html
'*
' and '/docs/cvs/commit.html
-> '/docs/cvs/commit.html
'Assumes that match(java.lang.String, java.lang.String)
returns true
for 'pattern
' and 'path
', but
does not enforce this.
pattern
- The patternpath
- The pathpublic Map<String,String> extractUriTemplateVariables(String pattern, String path)
pattern
- The patternpath
- The pathpublic String combine(String pattern1, String pattern2)
This implementation simply concatenates the two patterns, unless the first pattern
contains a file extension match (such as *.html
. In that case, the second pattern
should be included in the first, or an IllegalArgumentException
is thrown.
For example:
Pattern 1 | Pattern 2 | Result |
---|---|---|
/hotels | null | /hotels |
null | /hotels | /hotels |
/hotels | /bookings | /hotels/bookings |
/hotels | bookings | /hotels/bookings |
/hotels/* | /bookings | /hotels/bookings |
/hotels/** | /bookings | /hotels/**/bookings |
/hotels | {hotel} | /hotels/{hotel} |
/hotels/* | {hotel} | /hotels/{hotel} |
/hotels/** | {hotel} | /hotels/**/{hotel} |
/*.html | /hotels.html | /hotels.html |
/*.html | /hotels | /hotels.html |
/*.html | /*.txt | IllegalArgumentException |
pattern1
- the first patternpattern2
- the second patternIllegalArgumentException
- when the two patterns cannot be combinedpublic Comparator<String> getPatternComparator(String path)
Comparator
suitable for sorting patterns in order of explicitness.
The returned Comparator
will sort a list so that more specific patterns (without uri templates or wild cards) come before
generic patterns. So given a list with the following patterns:
/hotels/new
/hotels/{hotel}
/hotels/*
The full path given as parameter is used to test for exact matches. So when the given path is /hotels/2
,
the pattern /hotels/2
will be sorted before /hotels/1
.
path
- the full path to use for comparison