Deprecated
This filter has been deprecated as of Shiro 1.2 in favor of using the
ShiroFilter in
web.xml instead.
See the
ShiroFilter JavaDoc for usage.
======================
Servlet Filter that configures and enables all Shiro functions within a web application by using the
INI configuration format.
The actual INI configuration contents are not covered here, but instead in Shiro's
Configuration Documentation and additional web-specific
Web Documentation.
Usage
Default
By default, the simplest filter declaration expects a
shiro.ini resource to be located at
/WEB-INF/shiro.ini, or, if not there, falls back to checking the root of the classpath
(i.e.
classpath:shiro.ini):
<filter>
<filter-name>ShiroFilter</filter-name>
<filter-class>org.apache.shiro.web.servlet.IniShiroFilter</filter-class>
</filter>
Custom Path
If you want the INI configuration to be somewhere other than
/WEB-INF/shiro.ini or
classpath:shiro.ini, you may specify an alternate location via the
configPath init-param:
<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>
Unqualified (schemeless or 'non-prefixed') paths are assumed to be
ServletContext resource paths, resolvable
via
javax.servlet.ServletContext#getResourceAsStream(String).
Non-ServletContext resources may be loaded from qualified locations by specifying prefixes indicating the source,
e.g.
file:,
url:, and
classpath:. See the
ResourceUtils#getInputStreamForPath(String) JavaDoc for more.
Inline
For relatively simple environments, you can embed the INI config directly inside the filter declaration with
the
config init-param:
<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>
Although this is typically not recommended because any Shiro configuration changes would contribute to version control
'noise' in the web.xml file.
When creating the shiro.ini configuration itself, please see Shiro's
Configuration Documentation and
Web Documentation.