| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>PathMatchingFilterChainResolver (Apache Shiro 1.12.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PathMatchingFilterChainResolver (Apache Shiro 1.12.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"><!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code --> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.shiro.web.filter.mgt</a></div> |
| <h2 title="Class PathMatchingFilterChainResolver" class="title">Class PathMatchingFilterChainResolver</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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><code><a href="FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainResolver</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.44">PathMatchingFilterChainResolver</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="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="https://docs.oracle.com/javaee/5/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet" class="externalLink"><code>FilterChain</code></a>s based on url path |
| matching, as determined by a configurable <a href="#setPathMatcher(org.apache.shiro.util.PatternMatcher)"><code>PathMatcher</code></a>. |
| <p/> |
| This implementation functions by consulting a <a href="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="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">PathMatchingFilterChainResolver</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(javax.servlet.FilterConfig)">PathMatchingFilterChainResolver</a></span>​(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/FilterConfig.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">FilterConfig</a> filterConfig)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">FilterChain</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChain(javax.servlet.ServletRequest,javax.servlet.ServletResponse,javax.servlet.FilterChain)">getChain</a></span>​(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletResponse</a> response, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">FilterChain</a> originalChain)</code></th> |
| <td class="colLast"> |
| <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 id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFilterChainManager()">getFilterChainManager</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../util/PatternMatcher.html" title="interface in org.apache.shiro.util">PatternMatcher</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPathMatcher()">getPathMatcher</a></span>()</code></th> |
| <td class="colLast"> |
| <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 id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPathWithinApplication(javax.servlet.ServletRequest)">getPathWithinApplication</a></span>​(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletRequest</a> request)</code></th> |
| <td class="colLast"> |
| <div class="block">Merely returns |
| <code>WebUtils.<a href="../../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 id="i4" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pathMatches(java.lang.String,java.lang.String)">pathMatches</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path)</code></th> |
| <td class="colLast"> |
| <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 id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFilterChainManager(org.apache.shiro.web.filter.mgt.FilterChainManager)">setFilterChainManager</a></span>​(<a href="FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a> filterChainManager)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPathMatcher(org.apache.shiro.util.PatternMatcher)">setPathMatcher</a></span>​(<a href="../../../util/PatternMatcher.html" title="interface in org.apache.shiro.util">PatternMatcher</a> pathMatcher)</code></th> |
| <td class="colLast"> |
| <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 id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </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.54">PathMatchingFilterChainResolver</a>()</pre> |
| </li> |
| </ul> |
| <a id="<init>(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.59">PathMatchingFilterChainResolver</a>​(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/FilterConfig.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">FilterConfig</a> filterConfig)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getPathMatcher()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPathMatcher</h4> |
| <pre class="methodSignature">public <a href="../../../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.72">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="../../../util/AntPathMatcher.html" title="class in org.apache.shiro.util"><code>AntPathMatcher</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">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 id="setPathMatcher(org.apache.shiro.util.PatternMatcher)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPathMatcher</h4> |
| <pre class="methodSignature">public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.84">setPathMatcher</a>​(<a href="../../../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="../../../util/AntPathMatcher.html" title="class in org.apache.shiro.util"><code>AntPathMatcher</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">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 id="getFilterChainManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterChainManager</h4> |
| <pre class="methodSignature">public <a href="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.88">getFilterChainManager</a>()</pre> |
| </li> |
| </ul> |
| <a id="setFilterChainManager(org.apache.shiro.web.filter.mgt.FilterChainManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFilterChainManager</h4> |
| <pre class="methodSignature">public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.92">setFilterChainManager</a>​(<a href="FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a> filterChainManager)</pre> |
| </li> |
| </ul> |
| <a id="getChain(javax.servlet.ServletRequest,javax.servlet.ServletResponse,javax.servlet.FilterChain)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChain</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">FilterChain</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.97">getChain</a>​(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletRequest</a> request, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletResponse</a> response, |
| <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">FilterChain</a> originalChain)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="FilterChainResolver.html#getChain(javax.servlet.ServletRequest,javax.servlet.ServletResponse,javax.servlet.FilterChain)">FilterChainResolver</a></code></span></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="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink"><code>Filter</code></a> |
| chains for any given request or URL pattern.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="FilterChainResolver.html#getChain(javax.servlet.ServletRequest,javax.servlet.ServletResponse,javax.servlet.FilterChain)">getChain</a></code> in interface <code><a href="FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainResolver</a></code></dd> |
| <dt><span class="paramLabel">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="returnLabel">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 id="pathMatches(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pathMatches</h4> |
| <pre class="methodSignature">protected boolean <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.152">pathMatches</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">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="#getPathMatcher()"><code>getPathMatcher()</code></a>.<a href="../../../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="paramLabel">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="returnLabel">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 id="getPathWithinApplication(javax.servlet.ServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPathWithinApplication</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/PathMatchingFilterChainResolver.html#line.165">getPathWithinApplication</a>​(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletRequest.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletRequest</a> request)</pre> |
| <div class="block">Merely returns |
| <code>WebUtils.<a href="../../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="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the incoming <code>ServletRequest</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the request's path within the appliation.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |