|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.shiro.util.AntPathMatcher
public class AntPathMatcher
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.jsp
com/*.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.jsp
N.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.
Field Summary | |
---|---|
static String |
DEFAULT_PATH_SEPARATOR
Default path separator: "/" |
Constructor Summary | |
---|---|
AntPathMatcher()
|
Method Summary | |
---|---|
protected boolean |
doMatch(String pattern,
String path,
boolean fullMatch)
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. |
boolean |
isPattern(String path)
|
boolean |
match(String pattern,
String path)
|
boolean |
matches(String pattern,
String source)
Returns true if the given source matches the specified pattern ,
false otherwise. |
boolean |
matchStart(String pattern,
String path)
|
void |
setPathSeparator(String pathSeparator)
Set the path separator to use for pattern parsing. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_PATH_SEPARATOR
Constructor Detail |
---|
public AntPathMatcher()
Method Detail |
---|
public void setPathSeparator(String pathSeparator)
public boolean isPattern(String path)
public boolean matches(String pattern, String source)
PatternMatcher
true
if the given source
matches the specified pattern
,
false
otherwise.
matches
in interface PatternMatcher
pattern
- the pattern to match againstsource
- the source to match
true
if the given source
matches the specified pattern
,
false
otherwise.public boolean match(String pattern, String path)
public boolean matchStart(String pattern, String path)
protected boolean doMatch(String pattern, 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 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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |