Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.3 / apidocs / src-html / org / apache / shiro / web / servlet / ShiroFilter.html
blob: 7ba5d55cedc7f5acbb67b308a877f4ca711bf06f [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.web.servlet;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.web.env.WebEnvironment;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.web.filter.mgt.FilterChainResolver;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.web.util.WebUtils;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> /**<a name="line.25"></a>
<FONT color="green">026</FONT> * Primary Shiro Filter for web applications configuring Shiro via Servlet &amp;lt;listener&amp;gt; in web.xml.<a name="line.26"></a>
<FONT color="green">027</FONT> * &lt;p/&gt;<a name="line.27"></a>
<FONT color="green">028</FONT> * As of Shiro 1.2, this is Shiro's preferred filter for {@code web.xml} configuration. It expects the presence of a<a name="line.28"></a>
<FONT color="green">029</FONT> * Shiro {@link org.apache.shiro.web.env.WebEnvironment WebEnvironment} in the {@code ServletContext}, also<a name="line.29"></a>
<FONT color="green">030</FONT> * configured via {@code web.xml}.<a name="line.30"></a>
<FONT color="green">031</FONT> * &lt;h2&gt;Usage&lt;/h2&gt;<a name="line.31"></a>
<FONT color="green">032</FONT> * As this Filter expects an available {@link org.apache.shiro.web.env.WebEnvironment WebEnvironment} instance to<a name="line.32"></a>
<FONT color="green">033</FONT> * be configured, it must be defined in {@code web.xml} with the companion<a name="line.33"></a>
<FONT color="green">034</FONT> * {@link org.apache.shiro.web.env.EnvironmentLoaderListener EnvironmentLoaderListener}, which performs the necessary<a name="line.34"></a>
<FONT color="green">035</FONT> * environment setup. For example:<a name="line.35"></a>
<FONT color="green">036</FONT> * &lt;pre&gt;<a name="line.36"></a>
<FONT color="green">037</FONT> * &amp;lt;listener&amp;gt;<a name="line.37"></a>
<FONT color="green">038</FONT> * &amp;lt;listener-class&amp;gt;{@link org.apache.shiro.web.env.EnvironmentLoaderListener}&amp;lt;/listener-class&amp;gt;<a name="line.38"></a>
<FONT color="green">039</FONT> * &amp;lt;/listener&amp;gt;<a name="line.39"></a>
<FONT color="green">040</FONT> * ...<a name="line.40"></a>
<FONT color="green">041</FONT> * &amp;lt;filter&amp;gt;<a name="line.41"></a>
<FONT color="green">042</FONT> * &amp;lt;filter-name&amp;gt;ShiroFilter&amp;lt;/filter-name&amp;gt;<a name="line.42"></a>
<FONT color="green">043</FONT> * &amp;lt;filter-class&amp;gt;org.apache.shiro.web.servlet.ShiroFilter&amp;lt;/filter-class&amp;gt;<a name="line.43"></a>
<FONT color="green">044</FONT> * &amp;lt;/filter&amp;gt;<a name="line.44"></a>
<FONT color="green">045</FONT> *<a name="line.45"></a>
<FONT color="green">046</FONT> * &amp;lt;-- Filter all web requests. This filter mapping is typically declared<a name="line.46"></a>
<FONT color="green">047</FONT> * before all others to ensure any other filters are secured as well: --&amp;gt;<a name="line.47"></a>
<FONT color="green">048</FONT> * &amp;lt;filter-mapping&amp;gt;<a name="line.48"></a>
<FONT color="green">049</FONT> * &amp;lt;filter-name&amp;gt;ShiroFilter&amp;lt;/filter-name&amp;gt;<a name="line.49"></a>
<FONT color="green">050</FONT> * &amp;lt;url-pattern&amp;gt;/*&amp;lt;/url-pattern&amp;gt;<a name="line.50"></a>
<FONT color="green">051</FONT> * &amp;lt;/filter-mapping&amp;gt;<a name="line.51"></a>
<FONT color="green">052</FONT> * &lt;/pre&gt;<a name="line.52"></a>
<FONT color="green">053</FONT> * Configuration options (configuration file paths, etc) are specified as part of the<a name="line.53"></a>
<FONT color="green">054</FONT> * {@code EnvironmentLoaderListener} configuration. See the<a name="line.54"></a>
<FONT color="green">055</FONT> * {@link org.apache.shiro.web.env.EnvironmentLoader EnvironmentLoader} JavaDoc for configuration options.<a name="line.55"></a>
<FONT color="green">056</FONT> *<a name="line.56"></a>
<FONT color="green">057</FONT> * @see org.apache.shiro.web.env.EnvironmentLoader EnvironmentLoader<a name="line.57"></a>
<FONT color="green">058</FONT> * @see org.apache.shiro.web.env.EnvironmentLoaderListener EnvironmentLoaderListener<a name="line.58"></a>
<FONT color="green">059</FONT> * @see &lt;a href="http://shiro.apache.org/web.html"&gt;Apache Shiro Web Documentation&lt;/a&gt;<a name="line.59"></a>
<FONT color="green">060</FONT> * @since 1.2<a name="line.60"></a>
<FONT color="green">061</FONT> */<a name="line.61"></a>
<FONT color="green">062</FONT> public class ShiroFilter extends AbstractShiroFilter {<a name="line.62"></a>
<FONT color="green">063</FONT> <a name="line.63"></a>
<FONT color="green">064</FONT> /**<a name="line.64"></a>
<FONT color="green">065</FONT> * Configures this instance based on the existing {@link org.apache.shiro.web.env.WebEnvironment} instance<a name="line.65"></a>
<FONT color="green">066</FONT> * available to the currently accessible {@link #getServletContext() servletContext}.<a name="line.66"></a>
<FONT color="green">067</FONT> *<a name="line.67"></a>
<FONT color="green">068</FONT> * @see org.apache.shiro.web.env.EnvironmentLoaderListener<a name="line.68"></a>
<FONT color="green">069</FONT> * @since 1.2<a name="line.69"></a>
<FONT color="green">070</FONT> */<a name="line.70"></a>
<FONT color="green">071</FONT> @Override<a name="line.71"></a>
<FONT color="green">072</FONT> public void init() throws Exception {<a name="line.72"></a>
<FONT color="green">073</FONT> WebEnvironment env = WebUtils.getRequiredWebEnvironment(getServletContext());<a name="line.73"></a>
<FONT color="green">074</FONT> <a name="line.74"></a>
<FONT color="green">075</FONT> setSecurityManager(env.getWebSecurityManager());<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> FilterChainResolver resolver = env.getFilterChainResolver();<a name="line.77"></a>
<FONT color="green">078</FONT> if (resolver != null) {<a name="line.78"></a>
<FONT color="green">079</FONT> setFilterChainResolver(resolver);<a name="line.79"></a>
<FONT color="green">080</FONT> }<a name="line.80"></a>
<FONT color="green">081</FONT> }<a name="line.81"></a>
<FONT color="green">082</FONT> }<a name="line.82"></a>
</PRE>
</BODY>
</HTML>