public class AntPathMatcher
extends java.lang.Object
PathMatcher implementation for Ant-style path patterns. Examples are provided below.
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.jspcom/*.jsp - matches all .jsp files in the com directorycom/**/test.jsp - matches all test.jsp files underneath the com pathorg/apache/shiro/**/*.jsp - matches all .jsp files underneath the org/apache/shiro pathorg/**/servlet/bla.jsp - matches org/apache/shiro/servlet/bla.jsp but also org/apache/shiro/testing/servlet/bla.jsp and org/servlet/bla.jspN.B.: This class was borrowed (with much appreciation) from the Spring Framework with modifications. We didn't want to reinvent the wheel of great work they've done, but also didn't want to force every Shiro user to depend on Spring
As per the Apache 2.0 license, the original copyright notice and all author and copyright information have remained in tact.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
DEFAULT_PATH_SEPARATOR
Default path separator: "/"
|
| Constructor and Description |
|---|
AntPathMatcher() |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
doMatch(java.lang.String pattern,
java.lang.String path,
boolean fullMatch)
Actually match the given
path against the given pattern. |
java.lang.String |
extractPathWithinPattern(java.lang.String pattern,
java.lang.String path)
Given a pattern and a full path, determine the pattern-mapped part.
|
boolean |
isPattern(java.lang.String path) |
boolean |
match(java.lang.String pattern,
java.lang.String path) |
boolean |
matches(java.lang.String pattern,
java.lang.String source) |
boolean |
matchStart(java.lang.String pattern,
java.lang.String path) |
void |
setPathSeparator(java.lang.String pathSeparator)
Set the path separator to use for pattern parsing.
|
public static final java.lang.String DEFAULT_PATH_SEPARATOR
public void setPathSeparator(java.lang.String pathSeparator)
pathSeparator - separatorpublic boolean isPattern(java.lang.String path)
public boolean matches(java.lang.String pattern,
java.lang.String source)
public boolean match(java.lang.String pattern,
java.lang.String path)
public boolean matchStart(java.lang.String pattern,
java.lang.String path)
protected boolean doMatch(java.lang.String pattern,
java.lang.String path,
boolean fullMatch)
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)true if the supplied path matched, false if it didn'tpublic java.lang.String extractPathWithinPattern(java.lang.String pattern,
java.lang.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 - patternpath - path