| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_65) on Tue Feb 25 18:15:52 EST 2014 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| IniShiroFilter (Apache Shiro 1.2.3 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2014-02-25"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IniShiroFilter (Apache Shiro 1.2.3 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IniShiroFilter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/shiro/web/servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/shiro/web/servlet/IniShiroFilter.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IniShiroFilter.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.shiro.web.servlet</FONT> |
| <BR> |
| Class IniShiroFilter</H2> |
| <PRE> |
| <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> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.ServletContextSupport</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.AbstractFilter</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.NameableFilter</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.OncePerRequestFilter</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html" title="class in org.apache.shiro.web.servlet">org.apache.shiro.web.servlet.AbstractShiroFilter</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.shiro.web.servlet.IniShiroFilter</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <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> |
| <B>Deprecated.</B> <I>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></I> |
| <P> |
| <DL> |
| <DT><PRE><FONT SIZE="-1"><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> |
| </FONT>public class <A HREF="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.110"><B>IniShiroFilter</B></A><DT>extends <A HREF="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html" title="class in org.apache.shiro.web.servlet">AbstractShiroFilter</A></DL> |
| </PRE> |
| |
| <P> |
| <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>. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.0</DD> |
| <DT><B>See Also:</B><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></DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#CONFIG_INIT_PARAM_NAME">CONFIG_INIT_PARAM_NAME</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#CONFIG_PATH_INIT_PARAM_NAME">CONFIG_PATH_INIT_PARAM_NAME</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#DEFAULT_WEB_INI_RESOURCE_PATH">DEFAULT_WEB_INI_RESOURCE_PATH</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.shiro.web.servlet.OncePerRequestFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html#ALREADY_FILTERED_SUFFIX">ALREADY_FILTERED_SUFFIX</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.shiro.web.servlet.AbstractFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#filterConfig">filterConfig</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#IniShiroFilter()">IniShiroFilter</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#applyFilterChainResolver(org.apache.shiro.config.Ini, java.util.Map)">applyFilterChainResolver</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#applyInitParams()">applyInitParams</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#applySecurityManager(org.apache.shiro.config.Ini)">applySecurityManager</A></B>(<A HREF="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</A> ini)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#configure()">configure</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#convertConfigToIni(java.lang.String)">convertConfigToIni</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#convertPathToIni(java.lang.String)">convertPathToIni</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfig()">getConfig</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getConfigPath()">getConfigPath</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#getServletContextIniResource(java.lang.String)">getServletContextIniResource</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> Returns the INI instance reflecting the specified servlet context resource path or <code>null</code> if no |
| resource was found.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#init()">init</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#loadIniFromConfig()">loadIniFromConfig</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#loadIniFromPath()">loadIniFromPath</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#setConfig(java.lang.String)">setConfig</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html#setConfigPath(java.lang.String)">setConfigPath</A></B>(<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> |
| |
| <BR> |
| <B>Deprecated.</B> 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.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.servlet.AbstractShiroFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.servlet.OncePerRequestFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.servlet.NameableFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.servlet.AbstractFilter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.shiro.web.servlet.ServletContextSupport"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="CONFIG_INIT_PARAM_NAME"><!-- --></A><H3> |
| CONFIG_INIT_PARAM_NAME</H3> |
| <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"><B>CONFIG_INIT_PARAM_NAME</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.shiro.web.servlet.IniShiroFilter.CONFIG_INIT_PARAM_NAME">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="CONFIG_PATH_INIT_PARAM_NAME"><!-- --></A><H3> |
| CONFIG_PATH_INIT_PARAM_NAME</H3> |
| <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"><B>CONFIG_PATH_INIT_PARAM_NAME</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.shiro.web.servlet.IniShiroFilter.CONFIG_PATH_INIT_PARAM_NAME">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="DEFAULT_WEB_INI_RESOURCE_PATH"><!-- --></A><H3> |
| DEFAULT_WEB_INI_RESOURCE_PATH</H3> |
| <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"><B>DEFAULT_WEB_INI_RESOURCE_PATH</B></A></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.shiro.web.servlet.IniShiroFilter.DEFAULT_WEB_INI_RESOURCE_PATH">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="IniShiroFilter()"><!-- --></A><H3> |
| IniShiroFilter</H3> |
| <PRE> |
| public <A HREF="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.122"><B>IniShiroFilter</B></A>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getConfig()"><!-- --></A><H3> |
| getConfig</H3> |
| <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"><B>getConfig</B></A>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>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. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><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.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setConfig(java.lang.String)"><!-- --></A><H3> |
| setConfig</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.154"><B>setConfig</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><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.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getConfigPath()"><!-- --></A><H3> |
| getConfigPath</H3> |
| <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"><B>getConfigPath</B></A>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>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. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><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.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setConfigPath(java.lang.String)"><!-- --></A><H3> |
| setConfigPath</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.184"><B>setConfigPath</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><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.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="init()"><!-- --></A><H3> |
| init</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.188"><B>init</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD><DL> |
| <DT><B>Overrides:</B><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></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="applyInitParams()"><!-- --></A><H3> |
| applyInitParams</H3> |
| <PRE> |
| protected void <A HREF="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.193"><B>applyInitParams</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="configure()"><!-- --></A><H3> |
| configure</H3> |
| <PRE> |
| protected void <A HREF="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.204"><B>configure</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadIniFromConfig()"><!-- --></A><H3> |
| loadIniFromConfig</H3> |
| <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"><B>loadIniFromConfig</B></A>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadIniFromPath()"><!-- --></A><H3> |
| loadIniFromPath</H3> |
| <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"><B>loadIniFromPath</B></A>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="applySecurityManager(org.apache.shiro.config.Ini)"><!-- --></A><H3> |
| applySecurityManager</H3> |
| <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"><B>applySecurityManager</B></A>(<A HREF="../../../../../org/apache/shiro/config/Ini.html" title="class in org.apache.shiro.config">Ini</A> ini)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="applyFilterChainResolver(org.apache.shiro.config.Ini, java.util.Map)"><!-- --></A><H3> |
| applyFilterChainResolver</H3> |
| <PRE> |
| protected void <A HREF="../../../../../src-html/org/apache/shiro/web/servlet/IniShiroFilter.html#line.272"><B>applyFilterChainResolver</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="convertConfigToIni(java.lang.String)"><!-- --></A><H3> |
| convertConfigToIni</H3> |
| <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"><B>convertConfigToIni</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getServletContextIniResource(java.lang.String)"><!-- --></A><H3> |
| getServletContextIniResource</H3> |
| <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"><B>getServletContextIniResource</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Returns the INI instance reflecting the specified servlet context resource path or <code>null</code> if no |
| resource was found. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>servletContextPath</CODE> - the servlet context resource path of the INI file to load |
| <DT><B>Returns:</B><DD>the INI instance reflecting the specified servlet context resource path or <code>null</code> if no |
| resource was found.<DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="convertPathToIni(java.lang.String)"><!-- --></A><H3> |
| convertPathToIni</H3> |
| <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"><B>convertPathToIni</B></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> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>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>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - the path of the INI resource to load into an INI instance. |
| <DT><B>Returns:</B><DD>an INI instance populated based on the given INI resource path.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IniShiroFilter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/shiro/web/servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/shiro/web/servlet/IniShiroFilter.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IniShiroFilter.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |