| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="fr"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_77) on Sun May 14 11:51:27 CEST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>IniShiroFilter (Apache Shiro 1.4.0 API)</title> |
| <meta name="date" content="2017-05-14"> |
| <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="IniShiroFilter (Apache Shiro 1.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":42,"i5":42,"i6":42,"i7":42,"i8":42,"i9":42,"i10":42,"i11":42,"i12":42,"i13":42}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/IniShiroFilter.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/servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/web/servlet/IniShiroFilter.html" target="_top">Frames</a></li> |
| <li><a href="IniShiroFilter.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.servlet</div> |
| <h2 title="Class IniShiroFilter" class="title">Class IniShiroFilter</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><a href="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.ServletContextSupport</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.AbstractFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.NameableFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.OncePerRequestFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.AbstractShiroFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.web.servlet.IniShiroFilter</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><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="../../../../../org/apache/shiro/util/Nameable.html" title="interface in org.apache.shiro.util">Nameable</a></dd> |
| </dl> |
| <hr> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">in 1.2 in favor of using the <a href="../../../../../org/apache/shiro/web/servlet/ShiroFilter.html" title="class in org.apache.shiro.web.servlet"><code>ShiroFilter</code></a></span></div> |
| </div> |
| <br> |
| <pre><a href="http://java.sun.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public class <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.110">IniShiroFilter</a> |
| extends <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html" title="class in org.apache.shiro.web.servlet">AbstractShiroFilter</a></pre> |
| <div class="block"><h1>Deprecated</h1> |
| This filter has been deprecated as of Shiro 1.2 in favor of using the <a href="../../../../../org/apache/shiro/web/servlet/ShiroFilter.html" title="class in org.apache.shiro.web.servlet"><code>ShiroFilter</code></a> in <code>web.xml</code> instead. |
| See the <a href="../../../../../org/apache/shiro/web/servlet/ShiroFilter.html" title="class in org.apache.shiro.web.servlet"><code>ShiroFilter</code></a> JavaDoc for usage. |
| <p/> |
| ====================== |
| <p/> |
| Servlet Filter that configures and enables all Shiro functions within a web application by using the |
| <a href="http://en.wikipedia.org/wiki/INI_file">INI</a> configuration format. |
| <p/> |
| The actual INI configuration contents are not covered here, but instead in Shiro's |
| <a href="http://shiro.apache.org/configuration.html">Configuration Documentation</a> and additional web-specific |
| <a href="http://shiro.apache.org/web.html">Web Documentation</a>. |
| <h2>Usage</h2> |
| <h3>Default</h3> |
| By default, the simplest filter declaration expects a <code>shiro.ini</code> resource to be located at |
| <code>/WEB-INF/shiro.ini</code>, or, if not there, falls back to checking the root of the classpath |
| (i.e. <code>classpath:shiro.ini</code>): |
| <pre> |
| <filter> |
| <filter-name>ShiroFilter</filter-name> |
| <filter-class>org.apache.shiro.web.servlet.IniShiroFilter</filter-class> |
| </filter> |
| </pre> |
| <h3>Custom Path</h3> |
| If you want the INI configuration to be somewhere other than <code>/WEB-INF/shiro.ini</code> or |
| <code>classpath:shiro.ini</code>, you may specify an alternate location via the <code>configPath init-param</code>: |
| <pre> |
| <filter> |
| <filter-name>ShiroFilter</filter-name> |
| <filter-class>org.apache.shiro.web.servlet.IniShiroFilter</filter-class> |
| <init-param> |
| <param-name>configPath</param-name> |
| <param-value>/WEB-INF/someFile.ini</param-value> |
| </init-param> |
| </filter> |
| </pre> |
| Unqualified (schemeless or 'non-prefixed') paths are assumed to be <code>ServletContext</code> resource paths, resolvable |
| via <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletContext.html?is-external=true#getResourceAsStream-java.lang.String-" title="class or interface in javax.servlet"><code>ServletContext#getResourceAsStream</code></a>. |
| <p/> |
| Non-ServletContext resources may be loaded from qualified locations by specifying prefixes indicating the source, |
| e.g. <code>file:</code>, <code>url:</code>, and <code>classpath:</code>. See the |
| <a href="../../../../../org/apache/shiro/io/ResourceUtils.html#getInputStreamForPath-java.lang.String-"><code>ResourceUtils.getInputStreamForPath(String)</code></a> JavaDoc for more. |
| <h3>Inline</h3> |
| For relatively simple environments, you can embed the INI config directly inside the filter declaration with |
| the <code>config init-param</code>: |
| <pre> |
| <filter> |
| <filter-name>ShiroFilter</filter-name> |
| <filter-class>org.apache.shiro.web.servlet.IniShiroFilter</filter-class> |
| <init-param> |
| <param-name>config</param-name> |
| <param-value> |
| #INI config goes here... |
| </param-value> |
| </init-param> |
| </filter> |
| </pre> |
| Although this is typically not recommended because any Shiro configuration changes would contribute to version control |
| 'noise' in the web.xml file. |
| <p/> |
| When creating the shiro.ini configuration itself, please see Shiro's |
| <a href="http://shiro.apache.org/configuration.html">Configuration Documentation</a> and |
| <a href="http://shiro.apache.org/web.html">Web Documentation</a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://shiro.apache.org/configuration.html">Apache Shiro INI Configuration</a>, |
| <a href="http://shiro.apache.org/web.html">Apache Shiro Web Documentation</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/servlet/IniShiroFilter.html#CONFIG_INIT_PARAM_NAME">CONFIG_INIT_PARAM_NAME</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/servlet/IniShiroFilter.html#CONFIG_PATH_INIT_PARAM_NAME">CONFIG_PATH_INIT_PARAM_NAME</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/servlet/IniShiroFilter.html#DEFAULT_WEB_INI_RESOURCE_PATH">DEFAULT_WEB_INI_RESOURCE_PATH</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.servlet.OncePerRequestFilter"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.shiro.web.servlet.<a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">OncePerRequestFilter</a></h3> |
| <code><a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#ALREADY_FILTERED_SUFFIX">ALREADY_FILTERED_SUFFIX</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.servlet.AbstractFilter"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.shiro.web.servlet.<a href="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">AbstractFilter</a></h3> |
| <code><a href="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#filterConfig">filterConfig</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== 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/servlet/IniShiroFilter.html#IniShiroFilter--">IniShiroFilter</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/servlet/IniShiroFilter.html#applyFilterChainResolver-org.apache.shiro.config.Ini-java.util.Map-">applyFilterChainResolver</a></span>(<a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a> ini, |
| <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>,?> defaults)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#applyInitParams--">applyInitParams</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <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>,?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#applySecurityManager-org.apache.shiro.config.Ini-">applySecurityManager</a></span>(<a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a> ini)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </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/servlet/IniShiroFilter.html#configure--">configure</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#convertConfigToIni-java.lang.String-">convertConfigToIni</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> config)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#convertPathToIni-java.lang.String-">convertPathToIni</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> path)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Converts the specified file path to an <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><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/servlet/IniShiroFilter.html#getConfig--">getConfig</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the actual INI configuration text to use to build the <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> and |
| <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt"><code>FilterChainResolver</code></a> used by the web application or <code>null</code> if the |
| <a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfigPath--"><code>configPath</code></a> should be used to load a fallback INI source.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><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/servlet/IniShiroFilter.html#getConfigPath--">getConfigPath</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the config path to be used to load a .ini file for configuration if a configuration is |
| not specified via the <a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfig--"><code>config</code></a> attribute.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getServletContextIniResource-java.lang.String-">getServletContextIniResource</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> servletContextPath)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the INI instance reflecting the specified servlet context resource path or <code>null</code> if no |
| resource was found.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#init--">init</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#loadIniFromConfig--">loadIniFromConfig</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#loadIniFromPath--">loadIniFromPath</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#setConfig-java.lang.String-">setConfig</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> config)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the actual INI configuration text to use to build the <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> and |
| <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt"><code>FilterChainResolver</code></a> used by the web application.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#setConfigPath-java.lang.String-">setConfigPath</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> configPath)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the config path to be used to load a .ini file for configuration if a configuration is |
| not specified via the <a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfig--"><code>config</code></a> attribute.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.AbstractShiroFilter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.web.servlet.<a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html" title="class in org.apache.shiro.web.servlet">AbstractShiroFilter</a></h3> |
| <code><a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#createDefaultSecurityManager--">createDefaultSecurityManager</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#createSubject-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">createSubject</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#doFilterInternal-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">doFilterInternal</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#executeChain-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">executeChain</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#getExecutionChain-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">getExecutionChain</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#getFilterChainResolver--">getFilterChainResolver</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#getSecurityManager--">getSecurityManager</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#isHttpSessions--">isHttpSessions</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#isStaticSecurityManagerEnabled--">isStaticSecurityManagerEnabled</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#onFilterConfigSet--">onFilterConfigSet</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#prepareServletRequest-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">prepareServletRequest</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#prepareServletResponse-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">prepareServletResponse</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#setFilterChainResolver-org.apache.shiro.web.filter.mgt.FilterChainResolver-">setFilterChainResolver</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#setSecurityManager-org.apache.shiro.web.mgt.WebSecurityManager-">setSecurityManager</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#setStaticSecurityManagerEnabled-boolean-">setStaticSecurityManagerEnabled</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#updateSessionLastAccessTime-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">updateSessionLastAccessTime</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#wrapServletRequest-javax.servlet.http.HttpServletRequest-">wrapServletRequest</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#wrapServletResponse-javax.servlet.http.HttpServletResponse-org.apache.shiro.web.servlet.ShiroHttpServletRequest-">wrapServletResponse</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.OncePerRequestFilter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.web.servlet.<a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">OncePerRequestFilter</a></h3> |
| <code><a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#doFilter-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">doFilter</a>, <a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#getAlreadyFilteredAttributeName--">getAlreadyFilteredAttributeName</a>, <a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#isEnabled--">isEnabled</a>, <a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#isEnabled-javax.servlet.ServletRequest-javax.servlet.ServletResponse-">isEnabled</a>, <a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#setEnabled-boolean-">setEnabled</a>, <a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#shouldNotFilter-javax.servlet.ServletRequest-">shouldNotFilter</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.NameableFilter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.web.servlet.<a href="../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet">NameableFilter</a></h3> |
| <code><a href="../../../../../org/apache/shiro/web/servlet/NameableFilter.html#getName--">getName</a>, <a href="../../../../../org/apache/shiro/web/servlet/NameableFilter.html#setName-java.lang.String-">setName</a>, <a href="../../../../../org/apache/shiro/web/servlet/NameableFilter.html#toStringBuilder--">toStringBuilder</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.AbstractFilter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.web.servlet.<a href="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">AbstractFilter</a></h3> |
| <code><a href="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#destroy--">destroy</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#getFilterConfig--">getFilterConfig</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#getInitParam-java.lang.String-">getInitParam</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#init-javax.servlet.FilterConfig-">init</a>, <a href="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#setFilterConfig-javax.servlet.FilterConfig-">setFilterConfig</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.servlet.ServletContextSupport"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.web.servlet.<a href="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html" title="class in org.apache.shiro.web.servlet">ServletContextSupport</a></h3> |
| <code><a href="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#getContextAttribute-java.lang.String-">getContextAttribute</a>, <a href="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#getContextInitParam-java.lang.String-">getContextInitParam</a>, <a href="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#getServletContext--">getServletContext</a>, <a href="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#removeContextAttribute-java.lang.String-">removeContextAttribute</a>, <a href="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#setContextAttribute-java.lang.String-java.lang.Object-">setContextAttribute</a>, <a href="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#setServletContext-javax.servlet.ServletContext-">setServletContext</a>, <a href="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html#toString--">toString</a></code></li> |
| </ul> |
| <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#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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="CONFIG_INIT_PARAM_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONFIG_INIT_PARAM_NAME</h4> |
| <pre>public static final <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/servlet/IniShiroFilter.html#line.112">CONFIG_INIT_PARAM_NAME</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.shiro.web.servlet.IniShiroFilter.CONFIG_INIT_PARAM_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CONFIG_PATH_INIT_PARAM_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONFIG_PATH_INIT_PARAM_NAME</h4> |
| <pre>public static final <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/servlet/IniShiroFilter.html#line.113">CONFIG_PATH_INIT_PARAM_NAME</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.shiro.web.servlet.IniShiroFilter.CONFIG_PATH_INIT_PARAM_NAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_WEB_INI_RESOURCE_PATH"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_WEB_INI_RESOURCE_PATH</h4> |
| <pre>public static final <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/servlet/IniShiroFilter.html#line.115">DEFAULT_WEB_INI_RESOURCE_PATH</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.shiro.web.servlet.IniShiroFilter.DEFAULT_WEB_INI_RESOURCE_PATH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="IniShiroFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>IniShiroFilter</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.122">IniShiroFilter</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfig</h4> |
| <pre>public <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/servlet/IniShiroFilter.html#line.138">getConfig</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the actual INI configuration text to use to build the <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> and |
| <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt"><code>FilterChainResolver</code></a> used by the web application or <code>null</code> if the |
| <a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfigPath--"><code>configPath</code></a> should be used to load a fallback INI source. |
| <p/> |
| This value is <code>null</code> by default, but it will be automatically set to the value of the |
| '<code>config</code>' <code>init-param</code> if it exists in the <code>FilterConfig</code> provided by the servlet |
| container at startup.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the actual INI configuration text to use to build the <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> and |
| <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt"><code>FilterChainResolver</code></a> used by the web application or <code>null</code> if the |
| <a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfigPath--"><code>configPath</code></a> should be used to load a fallback INI source.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConfig-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConfig</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.154">setConfig</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> config)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the actual INI configuration text to use to build the <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> and |
| <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt"><code>FilterChainResolver</code></a> used by the web application. If this value is <code>null</code>, the |
| <a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfigPath--"><code>configPath</code></a> will be checked to see if a .ini file should be loaded instead. |
| <p/> |
| This value is <code>null</code> by default, but it will be automatically set to the value of the |
| '<code>config</code>' <code>init-param</code> if it exists in the <code>FilterConfig</code> provided by the servlet |
| container at startup.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - the actual INI configuration text to use to build the <a href="../../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> and |
| <a href="../../../../../org/apache/shiro/web/filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt"><code>FilterChainResolver</code></a> used by the web application.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConfigPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigPath</h4> |
| <pre>public <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/servlet/IniShiroFilter.html#line.169">getConfigPath</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the config path to be used to load a .ini file for configuration if a configuration is |
| not specified via the <a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfig--"><code>config</code></a> attribute. |
| <p/> |
| This value is <code>null</code> by default, but it will be automatically set to the value of the |
| '<code>configPath</code>' <code>init-param</code> if it exists in the <code>FilterConfig</code> provided by the servlet |
| container at startup.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the config path to be used to load a .ini file for configuration if a configuration is |
| not specified via the <a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfig--"><code>config</code></a> attribute.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConfigPath-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConfigPath</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.184">setConfigPath</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> configPath)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets the config path to be used to load a .ini file for configuration if a configuration is |
| not specified via the <a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfig--"><code>config</code></a> attribute. |
| <p/> |
| This value is <code>null</code> by default, but it will be automatically set to the value of the |
| '<code>configPath</code>' <code>init-param</code> if it exists in the <code>FilterConfig</code> provided by the servlet |
| container at startup.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configPath</code> - the config path to be used to load a .ini file for configuration if a configuration is |
| not specified via the <a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfig--"><code>config</code></a> attribute.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="init--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.188">init</a>() |
| throws <a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html#init--">init</a></code> in class <code><a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html" title="class in org.apache.shiro.web.servlet">AbstractShiroFilter</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="applyInitParams--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyInitParams</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.193">applyInitParams</a>() |
| throws <a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="configure--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configure</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.204">configure</a>() |
| throws <a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="loadIniFromConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadIniFromConfig</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a> <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.232">loadIniFromConfig</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="loadIniFromPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadIniFromPath</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a> <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.241">loadIniFromPath</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="applySecurityManager-org.apache.shiro.config.Ini-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applySecurityManager</h4> |
| <pre>protected <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="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.250">applySecurityManager</a>(<a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a> ini)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="applyFilterChainResolver-org.apache.shiro.config.Ini-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyFilterChainResolver</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.272">applyFilterChainResolver</a>(<a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a> ini, |
| <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>,?> defaults)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="convertConfigToIni-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convertConfigToIni</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a> <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.293">convertConfigToIni</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> config)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </li> |
| </ul> |
| <a name="getServletContextIniResource-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServletContextIniResource</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a> <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.308">getServletContextIniResource</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> servletContextPath)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Returns the INI instance reflecting the specified servlet context resource path or <code>null</code> if no |
| resource was found.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>servletContextPath</code> - the servlet context resource path of the INI file to load</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the INI instance reflecting the specified servlet context resource path or <code>null</code> if no |
| resource was found.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="convertPathToIni-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>convertPathToIni</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</a> <a href="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.335">convertPathToIni</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> path)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Converts the specified file path to an <a href="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> instance. |
| <p/> |
| If the path does not have a resource prefix as defined by <a href="../../../../../org/apache/shiro/io/ResourceUtils.html#hasResourcePrefix-java.lang.String-"><code>ResourceUtils.hasResourcePrefix(String)</code></a>, the |
| path is expected to be resolvable by the <code>ServletContext</code> via |
| <a href="http://java.sun.com/javaee/5/docs/api/javax/servlet/ServletContext.html?is-external=true#getResourceAsStream-java.lang.String-" title="class or interface in javax.servlet"><code>ServletContext.getResourceAsStream(String)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the path of the INI resource to load into an INI instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an INI instance populated based on the given INI resource path.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <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/IniShiroFilter.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/servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/web/servlet/IniShiroFilter.html" target="_top">Frames</a></li> |
| <li><a href="IniShiroFilter.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |