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