| <!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 (1.8.0_92) on Mon Sep 12 21:42:53 EDT 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DefaultFilterChainManager (Apache Shiro 1.3.2 API)</title> |
| <meta name="date" content="2016-09-12"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DefaultFilterChainManager (Apache Shiro 1.3.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/DefaultFilterChainManager.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/DefaultFilter.html" title="enum in org.apache.shiro.web.filter.mgt"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html" target="_top">Frames</a></li> |
| <li><a href="DefaultFilterChainManager.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 DefaultFilterChainManager" class="title">Class DefaultFilterChainManager</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.DefaultFilterChainManager</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/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.47">DefaultFilterChainManager</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/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></pre> |
| <div class="block">Default <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt"><code>FilterChainManager</code></a> implementation maintaining a map of <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> instances |
| (key: filter name, value: Filter) as well as a map of <a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt"><code>NamedFilterList</code></a>s created from these |
| <code>Filter</code>s (key: filter chain name, value: NamedFilterList). The <code>NamedFilterList</code> is essentially a |
| <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> that also has a name property by which it can be looked up.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt"><code>NamedFilterList</code></a></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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#DefaultFilterChainManager--">DefaultFilterChainManager</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#DefaultFilterChainManager-javax.servlet.FilterConfig-">DefaultFilterChainManager</a></span>(<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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#addDefaultFilters-boolean-">addDefaultFilters</a></span>(boolean init)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#addFilter-java.lang.String-javax.servlet.Filter-">addFilter</a></span>(<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> name, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a> filter)</code> |
| <div class="block">Adds a filter to the 'pool' of available filters that can be used when |
| <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addToChain-java.lang.String-java.lang.String-java.lang.String-"><code>creating filter chains</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#addFilter-java.lang.String-javax.servlet.Filter-boolean-">addFilter</a></span>(<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> name, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a> filter, |
| boolean init)</code> |
| <div class="block">Adds a filter to the 'pool' of available filters that can be used when |
| <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addToChain-java.lang.String-java.lang.String-java.lang.String-"><code>creating filter chains</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#addFilter-java.lang.String-javax.servlet.Filter-boolean-boolean-">addFilter</a></span>(<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> name, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a> filter, |
| boolean init, |
| boolean overwrite)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#addToChain-java.lang.String-java.lang.String-">addToChain</a></span>(<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> chainName, |
| <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> filterName)</code> |
| <div class="block">Adds (appends) a filter to the filter chain identified by the given <code>chainName</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#addToChain-java.lang.String-java.lang.String-java.lang.String-">addToChain</a></span>(<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> chainName, |
| <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> filterName, |
| <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> chainSpecificFilterConfig)</code> |
| <div class="block">Adds (appends) a filter to the filter chain identified by the given <code>chainName</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#applyChainConfig-java.lang.String-javax.servlet.Filter-java.lang.String-">applyChainConfig</a></span>(<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> chainName, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a> filter, |
| <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> chainSpecificFilterConfig)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#createChain-java.lang.String-java.lang.String-">createChain</a></span>(<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> chainName, |
| <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> chainDefinition)</code> |
| <div class="block">Creates a filter chain for the given <code>chainName</code> with the specified <code>chainDefinition</code> |
| String.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt">NamedFilterList</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#ensureChain-java.lang.String-">ensureChain</a></span>(<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> chainName)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt">NamedFilterList</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#getChain-java.lang.String-">getChain</a></span>(<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> chainName)</code> |
| <div class="block">Returns the filter chain identified by the specified <code>chainName</code> or <code>null</code> if there is no chain with |
| that name.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#getChainNames--">getChainNames</a></span>()</code> |
| <div class="block">Returns the names of all configured chains or an empty <code>Set</code> if no chains have been configured.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#getFilter-java.lang.String-">getFilter</a></span>(<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> name)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt">NamedFilterList</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#getFilterChains--">getFilterChains</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#getFilterConfig--">getFilterConfig</a></span>()</code> |
| <div class="block">Returns the <code>FilterConfig</code> provided by the Servlet container at webapp startup.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#getFilters--">getFilters</a></span>()</code> |
| <div class="block">Returns the pool of available <code>Filter</code>s managed by this manager, keyed by <code>name</code>.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#hasChains--">hasChains</a></span>()</code> |
| <div class="block">Returns <code>true</code> if one or more configured chains are available, <code>false</code> if none are configured.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#initFilter-javax.servlet.Filter-">initFilter</a></span>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a> filter)</code> |
| <div class="block">Initializes the filter by calling <code>filter.init( <a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#getFilterConfig--"><code>getFilterConfig()</code></a> );</code>.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <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><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#proxy-javax.servlet.FilterChain-java.lang.String-">proxy</a></span>(<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> original, |
| <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> chainName)</code> |
| <div class="block">Proxies the specified <code>original</code> FilterChain with the named chain.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#setFilterChains-java.util.Map-">setFilterChains</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt">NamedFilterList</a>> filterChains)</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#setFilterConfig-javax.servlet.FilterConfig-">setFilterConfig</a></span>(<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> |
| <div class="block">Sets the <code>FilterConfig</code> provided by the Servlet container at webapp startup.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#setFilters-java.util.Map-">setFilters</a></span>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a>> filters)</code> </td> |
| </tr> |
| <tr id="i21" 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><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#splitChainDefinition-java.lang.String-">splitChainDefinition</a></span>(<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> chainDefinition)</code> |
| <div class="block">Splits the comma-delimited filter chain definition line into individual filter definition tokens.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <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><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#toNameConfigPair-java.lang.String-">toNameConfigPair</a></span>(<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> token)</code> |
| <div class="block">Based on the given filter chain definition token (e.g.</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="DefaultFilterChainManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DefaultFilterChainManager</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.57">DefaultFilterChainManager</a>()</pre> |
| </li> |
| </ul> |
| <a name="DefaultFilterChainManager-javax.servlet.FilterConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultFilterChainManager</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.63">DefaultFilterChainManager</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="getFilterConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterConfig</h4> |
| <pre>public <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> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.75">getFilterConfig</a>()</pre> |
| <div class="block">Returns the <code>FilterConfig</code> provided by the Servlet container at webapp startup.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>FilterConfig</code> provided by the Servlet container at webapp startup.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFilterConfig-javax.servlet.FilterConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFilterConfig</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.84">setFilterConfig</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> |
| <div class="block">Sets the <code>FilterConfig</code> provided by the Servlet container at webapp startup.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filterConfig</code> - the <code>FilterConfig</code> provided by the Servlet container at webapp startup.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFilters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilters</h4> |
| <pre>public <a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a>> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.88">getFilters</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#getFilters--">FilterChainManager</a></code></span></div> |
| <div class="block">Returns the pool of available <code>Filter</code>s managed by this manager, keyed by <code>name</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#getFilters--">getFilters</a></code> in interface <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the pool of available <code>Filter</code>s managed by this manager, keyed by <code>name</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFilters-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFilters</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.93">setFilters</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a>> filters)</pre> |
| </li> |
| </ul> |
| <a name="getFilterChains--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterChains</h4> |
| <pre>public <a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt">NamedFilterList</a>> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.97">getFilterChains</a>()</pre> |
| </li> |
| </ul> |
| <a name="setFilterChains-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFilterChains</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.102">setFilterChains</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</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>,<a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt">NamedFilterList</a>> filterChains)</pre> |
| </li> |
| </ul> |
| <a name="getFilter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilter</h4> |
| <pre>public <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.106">getFilter</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> name)</pre> |
| </li> |
| </ul> |
| <a name="addFilter-java.lang.String-javax.servlet.Filter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFilter</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.110">addFilter</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> name, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a> filter)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addFilter-java.lang.String-javax.servlet.Filter-">FilterChainManager</a></code></span></div> |
| <div class="block">Adds a filter to the 'pool' of available filters that can be used when |
| <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addToChain-java.lang.String-java.lang.String-java.lang.String-"><code>creating filter chains</code></a>. |
| <p/> |
| Calling this method is effectively the same as calling |
| <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addFilter-java.lang.String-javax.servlet.Filter-boolean-"><code>addFilter</code></a>(name, filter, <b>false</b>);</code></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addFilter-java.lang.String-javax.servlet.Filter-">addFilter</a></code> in interface <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name to assign to the filter, used to reference the filter in chain definitions</dd> |
| <dd><code>filter</code> - the filter to initialize and then add to the pool of available filters that can be used</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFilter-java.lang.String-javax.servlet.Filter-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFilter</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.114">addFilter</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> name, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a> filter, |
| boolean init)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addFilter-java.lang.String-javax.servlet.Filter-boolean-">FilterChainManager</a></code></span></div> |
| <div class="block">Adds a filter to the 'pool' of available filters that can be used when |
| <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addToChain-java.lang.String-java.lang.String-java.lang.String-"><code>creating filter chains</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addFilter-java.lang.String-javax.servlet.Filter-boolean-">addFilter</a></code> in interface <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name to assign to the filter, used to reference the filter in chain definitions</dd> |
| <dd><code>filter</code> - the filter to assign to the filter pool</dd> |
| <dd><code>init</code> - whether or not the <code>Filter</code> should be |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true#init-javax.servlet.FilterConfig-" title="class or interface in javax.servlet"><code>initialized</code></a> first before being added to the pool.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createChain-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createChain</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.118">createChain</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> chainName, |
| <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> chainDefinition)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#createChain-java.lang.String-java.lang.String-">FilterChainManager</a></code></span></div> |
| <div class="block">Creates a filter chain for the given <code>chainName</code> with the specified <code>chainDefinition</code> |
| String. |
| <h3>Conventional Use</h3> |
| Because the <code>FilterChainManager</code> interface does not impose any restrictions on filter chain names, |
| (it expects only Strings), a convenient convention is to make the chain name an actual URL path expression |
| (such as an <a href="../../../../../../org/apache/shiro/util/AntPathMatcher.html" title="class in org.apache.shiro.util"><code>Ant path expression</code></a>). For example: |
| <p/> |
| <code>createChain(<b><em>path_expression</em></b>, <em>path_specific_filter_chain_definition</em>);</code> |
| This convention can be used by a <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt"><code>FilterChainResolver</code></a> to inspect request URL paths |
| against the chain name (path) and, if a match is found, return the corresponding chain for runtime filtering. |
| <h3>Chain Definition Format</h3> |
| The <code>chainDefinition</code> method argument is expected to conform to the following format: |
| <pre> |
| filter1[optional_config1], filter2[optional_config2], ..., filterN[optional_configN]</pre> |
| where |
| <ol> |
| <li><code>filterN</code> is the name of a filter previously |
| <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addFilter-java.lang.String-javax.servlet.Filter-"><code>registered</code></a> with the manager, and</li> |
| <li><code>[optional_configN]</code> is an optional bracketed string that has meaning for that particular filter for |
| <em>this particular chain</em></li> |
| </ol> |
| If the filter does not need specific config for that chain name/URL path, |
| you may discard the brackets - that is, <code>filterN[]</code> just becomes <code>filterN</code>. |
| <p/> |
| And because this method does create a chain, remember that order matters! The comma-delimited filter tokens in |
| the <code>chainDefinition</code> specify the chain's execution order. |
| <h3>Examples</h3> |
| <pre>/account/** = authcBasic</pre> |
| This example says "Create a filter named '<code>/account/**</code>' consisting of only the '<code>authcBasic</code>' |
| filter". Also because the <code>authcBasic</code> filter does not need any path-specific |
| config, it doesn't have any config brackets <code>[]</code>. |
| <p/> |
| <pre>/remoting/** = authcBasic, roles[b2bClient], perms["remote:invoke:wan,lan"]</pre> |
| This example by contrast uses the 'roles' and 'perms' filters which <em>do</em> use bracket notation. This |
| definition says: |
| <p/> |
| Construct a filter chain named '<code>/remoting/**</code>' which |
| <ol> |
| <li>ensures the user is first authenticated (<code>authcBasic</code>) then</li> |
| <li>ensures that user has the <code>b2bClient</code> role, and then finally</li> |
| <li>ensures that they have the <code>remote:invoke:lan,wan</code> permission.</li> |
| </ol> |
| <p/> |
| <b>Note</b>: because elements within brackets [ ] can be comma-delimited themselves, you must quote the |
| internal bracket definition if commas are needed (the above example has 'lan,wan'). If we didn't do that, the |
| parser would interpret the chain definition as four tokens: |
| <ol> |
| <li>authcBasic</li> |
| <li>roles[b2bclient]</li> |
| <li>perms[remote:invoke:lan</li> |
| <li>wan]</li> |
| </ol> |
| which is obviously incorrect. So remember to use quotes if your internal bracket definitions need to use commas.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#createChain-java.lang.String-java.lang.String-">createChain</a></code> in interface <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>chainName</code> - the name to associate with the chain, conventionally a URL path pattern.</dd> |
| <dd><code>chainDefinition</code> - the string-formatted chain definition used to construct an actual |
| <a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt"><code>NamedFilterList</code></a> chain instance.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt"><code>FilterChainResolver</code></a>, |
| <a href="../../../../../../org/apache/shiro/util/AntPathMatcher.html" title="class in org.apache.shiro.util"><code>AntPathMatcher</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="splitChainDefinition-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>splitChainDefinition</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/DefaultFilterChainManager.html#line.170">splitChainDefinition</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> chainDefinition)</pre> |
| <div class="block">Splits the comma-delimited filter chain definition line into individual filter definition tokens. |
| <p/> |
| Example Input: |
| <pre> |
| foo, bar[baz], blah[x, y] |
| </pre> |
| Resulting Output: |
| <pre> |
| output[0] == foo |
| output[1] == bar[baz] |
| output[2] == blah[x, y] |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>chainDefinition</code> - the comma-delimited filter chain definition.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array of filter definition tokens</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://issues.apache.org/jira/browse/SHIRO-205">SHIRO-205</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toNameConfigPair-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toNameConfigPair</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/DefaultFilterChainManager.html#line.197">toNameConfigPair</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> token) |
| throws <a href="../../../../../../org/apache/shiro/config/ConfigurationException.html" title="class in org.apache.shiro.config">ConfigurationException</a></pre> |
| <div class="block">Based on the given filter chain definition token (e.g. 'foo' or 'foo[bar, baz]'), this will return the token |
| as a name/value pair, removing any brackets as necessary. Examples: |
| <table> |
| <tr> |
| <th>Input</th> |
| <th>Result</th> |
| </tr> |
| <tr> |
| <td><code>foo</code></td> |
| <td>returned[0] == <code>foo</code><br/>returned[1] == <code>null</code></td> |
| </tr> |
| <tr> |
| <td><code>foo[bar, baz]</code></td> |
| <td>returned[0] == <code>foo</code><br/>returned[1] == <code>bar, baz</code></td> |
| </tr> |
| </table></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>token</code> - the filter chain definition token</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A name/value pair representing the filter name and a (possibly null) config value.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/config/ConfigurationException.html" title="class in org.apache.shiro.config">ConfigurationException</a></code> - if the token cannot be parsed</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://issues.apache.org/jira/browse/SHIRO-205">SHIRO-205</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFilter-java.lang.String-javax.servlet.Filter-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFilter</h4> |
| <pre>protected void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.242">addFilter</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> name, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a> filter, |
| boolean init, |
| boolean overwrite)</pre> |
| </li> |
| </ul> |
| <a name="addToChain-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addToChain</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.255">addToChain</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> chainName, |
| <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> filterName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addToChain-java.lang.String-java.lang.String-">FilterChainManager</a></code></span></div> |
| <div class="block">Adds (appends) a filter to the filter chain identified by the given <code>chainName</code>. If there is no chain |
| with the given name, a new one is created and the filter will be the first in the chain.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addToChain-java.lang.String-java.lang.String-">addToChain</a></code> in interface <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>chainName</code> - the name of the chain where the filter will be appended.</dd> |
| <dd><code>filterName</code> - the name of the <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addFilter-java.lang.String-javax.servlet.Filter-"><code>registered</code></a> filter to add to the chain.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addToChain-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addToChain</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.259">addToChain</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> chainName, |
| <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> filterName, |
| <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> chainSpecificFilterConfig)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addToChain-java.lang.String-java.lang.String-java.lang.String-">FilterChainManager</a></code></span></div> |
| <div class="block">Adds (appends) a filter to the filter chain identified by the given <code>chainName</code>. If there is no chain |
| with the given name, a new one is created and the filter will be the first in the chain. |
| <p/> |
| Note that the final argument expects the associated filter to be an instance of |
| a <a href="../../../../../../org/apache/shiro/web/filter/PathConfigProcessor.html" title="interface in org.apache.shiro.web.filter"><code>PathConfigProcessor</code></a> to accept per-chain configuration. |
| If it is not, a <a href="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addToChain-java.lang.String-java.lang.String-java.lang.String-">addToChain</a></code> in interface <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>chainName</code> - the name of the chain where the filter will be appended.</dd> |
| <dd><code>filterName</code> - the name of the <a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#addFilter-java.lang.String-javax.servlet.Filter-"><code>registered</code></a> filter to add to the chain.</dd> |
| <dd><code>chainSpecificFilterConfig</code> - the filter-specific configuration that should be applied for only the specified |
| filter chain.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="applyChainConfig-java.lang.String-javax.servlet.Filter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyChainConfig</h4> |
| <pre>protected void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.276">applyChainConfig</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> chainName, |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a> filter, |
| <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> chainSpecificFilterConfig)</pre> |
| </li> |
| </ul> |
| <a name="ensureChain-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ensureChain</h4> |
| <pre>protected <a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt">NamedFilterList</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.296">ensureChain</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> chainName)</pre> |
| </li> |
| </ul> |
| <a name="getChain-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChain</h4> |
| <pre>public <a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html" title="interface in org.apache.shiro.web.filter.mgt">NamedFilterList</a> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.305">getChain</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> chainName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#getChain-java.lang.String-">FilterChainManager</a></code></span></div> |
| <div class="block">Returns the filter chain identified by the specified <code>chainName</code> or <code>null</code> if there is no chain with |
| that name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#getChain-java.lang.String-">getChain</a></code> in interface <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>chainName</code> - the name identifying the filter chain.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the filter chain identified by the specified <code>chainName</code> or <code>null</code> if there is no chain with |
| that name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasChains--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasChains</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.309">hasChains</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#hasChains--">FilterChainManager</a></code></span></div> |
| <div class="block">Returns <code>true</code> if one or more configured chains are available, <code>false</code> if none are configured.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#hasChains--">hasChains</a></code> in interface <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if one or more configured chains are available, <code>false</code> if none are configured.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getChainNames--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChainNames</h4> |
| <pre>public <a href="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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>> <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.313">getChainNames</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#getChainNames--">FilterChainManager</a></code></span></div> |
| <div class="block">Returns the names of all configured chains or an empty <code>Set</code> if no chains have been configured.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#getChainNames--">getChainNames</a></code> in interface <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the names of all configured chains or an empty <code>Set</code> if no chains have been configured.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="proxy-javax.servlet.FilterChain-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>proxy</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/DefaultFilterChainManager.html#line.318">proxy</a>(<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> original, |
| <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> chainName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#proxy-javax.servlet.FilterChain-java.lang.String-">FilterChainManager</a></code></span></div> |
| <div class="block">Proxies the specified <code>original</code> FilterChain with the named chain. The returned |
| <code>FilterChain</code> instance will first execute the configured named chain and then lastly invoke the given |
| <code>original</code> chain.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html#proxy-javax.servlet.FilterChain-java.lang.String-">proxy</a></code> in interface <code><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainManager</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>original</code> - the original FilterChain to proxy</dd> |
| <dd><code>chainName</code> - the name of the internal configured filter chain that should 'sit in front' of the specified |
| original chain.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>FilterChain</code> instance that will execute the named chain and then finally the |
| specified <code>original</code> FilterChain instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initFilter-javax.servlet.Filter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initFilter</h4> |
| <pre>protected void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.332">initFilter</a>(<a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet">Filter</a> filter)</pre> |
| <div class="block">Initializes the filter by calling <code>filter.init( <a href="../../../../../../org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#getFilterConfig--"><code>getFilterConfig()</code></a> );</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - the filter to initialize with the <code>FilterConfig</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addDefaultFilters-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addDefaultFilters</h4> |
| <pre>protected void <a href="../../../../../../src-html/org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html#line.345">addDefaultFilters</a>(boolean init)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/DefaultFilterChainManager.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/DefaultFilter.html" title="enum in org.apache.shiro.web.filter.mgt"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/shiro/web/filter/mgt/FilterChainManager.html" title="interface in org.apache.shiro.web.filter.mgt"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/shiro/web/filter/mgt/DefaultFilterChainManager.html" target="_top">Frames</a></li> |
| <li><a href="DefaultFilterChainManager.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-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
