| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_21) on Thu May 30 14:51:27 PDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>PathMatchingFilterChainResolver (Apache Shiro 1.2.1 API)</title> |
| <meta name="date" content="2013-05-30"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PathMatchingFilterChainResolver (Apache Shiro 1.2.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PathMatchingFilterChainResolver.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/mgt/SimpleNamedFilterList.html" title="class in org.apache.shiro.web.filter.mgt"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html" target="_top">Frames</a></li> |
| <li><a href="PathMatchingFilterChainResolver.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.shiro.web.filter.mgt</div> |
| <h2 title="Class PathMatchingFilterChainResolver" class="title">Class PathMatchingFilterChainResolver</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainResolver</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.42">PathMatchingFilterChainResolver</a> |
| extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainResolver</a></pre> |
| <div class="block">A <code>FilterChainResolver</code> that resolves <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet"><code>FilterChain</code></a>s based on url path |
| matching, as determined by a configurable <a href="../../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#setPathMatcher(org.apache.shiro.util.PatternMatcher)"><code>PathMatcher</code></a>. |
| <p/> |
| This implementation functions by consulting a <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt"><code>FilterChainManager</code></a> for all configured filter chains (keyed |
| by configured path pattern). If an incoming Request path matches one of the configured path patterns (via |
| the <code>PathMatcher</code>, the corresponding configured <code>FilterChain</code> is returned.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.0</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#PathMatchingFilterChainResolver()">PathMatchingFilterChainResolver</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#PathMatchingFilterChainResolver(javax.servlet.FilterConfig)">PathMatchingFilterChainResolver</a></strong>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/FilterConfig.html?is-external=true" title="class or interface in javax.servlet">FilterConfig</a> filterConfig)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet">FilterChain</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#getChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)">getChain</a></strong>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet">FilterChain</a> originalChain)</code> |
| <div class="block">Returns the filter chain that should be executed for the given request, or <code>null</code> if the |
| original chain should be used.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#getFilterChainManager()">getFilterChainManager</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/shiro/util/PatternMatcher.html" title="interface in org.apache.shiro.util">PatternMatcher</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#getPathMatcher()">getPathMatcher</a></strong>()</code> |
| <div class="block">Returns the <code>PatternMatcher</code> used when determining if an incoming request's path |
| matches a configured filter chain.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#getPathWithinApplication(javax.servlet.ServletRequest)">getPathWithinApplication</a></strong>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request)</code> |
| <div class="block">Merely returns |
| <code>WebUtils.<a href="../../../../../../org/apache/shiro/web/util/WebUtils.html#getPathWithinApplication(javax.servlet.http.HttpServletRequest)"><code>getPathWithinApplication(request)</code></a></code> |
| and can be overridden by subclasses for custom request-to-application-path resolution behavior.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#pathMatches(java.lang.String, java.lang.String)">pathMatches</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pattern, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code> |
| <div class="block">Returns <code>true</code> if an incoming request path (the <code>path</code> argument) |
| matches a configured filter chain path (the <code>pattern</code> argument), <code>false</code> otherwise.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#setFilterChainManager(org.apache.shiro.web.filter.mgt.FilterChainManager)">setFilterChainManager</a></strong>(<a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a> filterChainManager)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#setPathMatcher(org.apache.shiro.util.PatternMatcher)">setPathMatcher</a></strong>(<a href="../../../../../../org/apache/shiro/util/PatternMatcher.html" title="interface in org.apache.shiro.util">PatternMatcher</a> pathMatcher)</code> |
| <div class="block">Sets the <code>PatternMatcher</code> used when determining if an incoming request's path |
| matches a configured filter chain.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="PathMatchingFilterChainResolver()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PathMatchingFilterChainResolver</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.50">PathMatchingFilterChainResolver</a>()</pre> |
| </li> |
| </ul> |
| <a name="PathMatchingFilterChainResolver(javax.servlet.FilterConfig)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PathMatchingFilterChainResolver</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.55">PathMatchingFilterChainResolver</a>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/FilterConfig.html?is-external=true" title="class or interface in javax.servlet">FilterConfig</a> filterConfig)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPathMatcher()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPathMatcher</h4> |
| <pre>public <a href="../../../../../../org/apache/shiro/util/PatternMatcher.html" title="interface in org.apache.shiro.util">PatternMatcher</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.68">getPathMatcher</a>()</pre> |
| <div class="block">Returns the <code>PatternMatcher</code> used when determining if an incoming request's path |
| matches a configured filter chain. Unless overridden, the |
| default implementation is an <a href="../../../../../../org/apache/shiro/util/AntPathMatcher.html" title="class in org.apache.shiro.util"><code>AntPathMatcher</code></a>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the <code>PatternMatcher</code> used when determining if an incoming request's path |
| matches a configured filter chain.</dd></dl> |
| </li> |
| </ul> |
| <a name="setPathMatcher(org.apache.shiro.util.PatternMatcher)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPathMatcher</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.80">setPathMatcher</a>(<a href="../../../../../../org/apache/shiro/util/PatternMatcher.html" title="interface in org.apache.shiro.util">PatternMatcher</a> pathMatcher)</pre> |
| <div class="block">Sets the <code>PatternMatcher</code> used when determining if an incoming request's path |
| matches a configured filter chain. Unless overridden, the |
| default implementation is an <a href="../../../../../../org/apache/shiro/util/AntPathMatcher.html" title="class in org.apache.shiro.util"><code>AntPathMatcher</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pathMatcher</code> - the <code>PatternMatcher</code> used when determining if an incoming request's path |
| matches a configured filter chain.</dd></dl> |
| </li> |
| </ul> |
| <a name="getFilterChainManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterChainManager</h4> |
| <pre>public <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.84">getFilterChainManager</a>()</pre> |
| </li> |
| </ul> |
| <a name="setFilterChainManager(org.apache.shiro.web.filter.mgt.FilterChainManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFilterChainManager</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.89">setFilterChainManager</a>(<a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a> filterChainManager)</pre> |
| </li> |
| </ul> |
| <a name="getChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChain</h4> |
| <pre>public <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet">FilterChain</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.93">getChain</a>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet">ServletResponse</a> response, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet">FilterChain</a> originalChain)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html#getChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)">FilterChainResolver</a></code></strong></div> |
| <div class="block">Returns the filter chain that should be executed for the given request, or <code>null</code> if the |
| original chain should be used. |
| <p/> |
| This method allows a implementation to define arbitrary security <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet"><code>Filter</code></a> |
| chains for any given request or URL pattern.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html#getChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)">getChain</a></code> in interface <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainResolver</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the incoming ServletRequest</dd><dd><code>response</code> - the outgoing ServletResponse</dd><dd><code>originalChain</code> - the original <code>FilterChain</code> intercepted by the ShiroFilter implementation.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the filter chain that should be executed for the given request, or <code>null</code> if the |
| original chain should be used.</dd></dl> |
| </li> |
| </ul> |
| <a name="pathMatches(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pathMatches</h4> |
| <pre>protected boolean <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.133">pathMatches</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pattern, |
| <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</pre> |
| <div class="block">Returns <code>true</code> if an incoming request path (the <code>path</code> argument) |
| matches a configured filter chain path (the <code>pattern</code> argument), <code>false</code> otherwise. |
| <p/> |
| Simply delegates to |
| <b><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#getPathMatcher()"><code>getPathMatcher()</code></a>.<a href="../../../../../../org/apache/shiro/util/PatternMatcher.html#matches(java.lang.String, java.lang.String)"><code>matches(pattern,path)</code></a></code></b>. |
| Subclass implementors should think carefully before overriding this method, as typically a custom |
| <code>PathMatcher</code> should be configured for custom path matching behavior instead. Favor OO composition |
| rather than inheritance to limit your exposure to Shiro implementation details which may change over time.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pattern</code> - the pattern to match against</dd><dd><code>path</code> - the value to match with the specified <code>pattern</code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the request <code>path</code> matches the specified filter chain url <code>pattern</code>, |
| <code>false</code> otherwise.</dd></dl> |
| </li> |
| </ul> |
| <a name="getPathWithinApplication(javax.servlet.ServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPathWithinApplication</h4> |
| <pre>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.146">getPathWithinApplication</a>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet">ServletRequest</a> request)</pre> |
| <div class="block">Merely returns |
| <code>WebUtils.<a href="../../../../../../org/apache/shiro/web/util/WebUtils.html#getPathWithinApplication(javax.servlet.http.HttpServletRequest)"><code>getPathWithinApplication(request)</code></a></code> |
| and can be overridden by subclasses for custom request-to-application-path resolution behavior.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the incoming <code>ServletRequest</code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the request's path within the appliation.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PathMatchingFilterChainResolver.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/mgt/SimpleNamedFilterList.html" title="class in org.apache.shiro.web.filter.mgt"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html" target="_top">Frames</a></li> |
| <li><a href="PathMatchingFilterChainResolver.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
| |
