| <!DOCTYPE HTML> |
| <html lang="fr"> |
| <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.env;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import javax.servlet.ServletContextEvent;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import javax.servlet.ServletContextListener;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">/**</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * Bootstrap listener to startup and shutdown the web application's Shiro</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * {@link WebEnvironment} at ServletContext startup and shutdown respectively. This class exists only to</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * implement the {@link ServletContextListener} interface. All 'real' logic is done in the parent</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * {@link EnvironmentLoader} class.</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * <h2>Usage</h2></a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * Define the following in {@code web.xml}:</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * <pre></a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * &lt;listener&gt;</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * &lt;listener-class&gt;<code>org.apache.shiro.web.env.EnvironmentLoaderListener</code>&lt;/listener-class&gt;</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * &lt;/listener&gt;</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * </pre></a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * Configuration options, such as the {@code WebEnvironment} class to instantiate as well as Shiro configuration</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * resource locations are specified as {@code ServletContext} {@code context-param}s and are documented in the</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * {@link EnvironmentLoader} JavaDoc.</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * <h2>Shiro Filter</h2></a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * This listener is almost always defined in conjunction with the</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * {@link org.apache.shiro.web.servlet.ShiroFilter ShiroFilter} to ensure security operations for web requests. Please</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * see the {@link org.apache.shiro.web.servlet.ShiroFilter ShiroFilter} JavaDoc for more.</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> *</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> *</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * @see EnvironmentLoader</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * @see org.apache.shiro.web.servlet.ShiroFilter ShiroFilter</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * @since 1.2</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> */</a> |
| <span class="sourceLineNo">049</span><a id="line.49">public class EnvironmentLoaderListener extends EnvironmentLoader implements ServletContextListener {</a> |
| <span class="sourceLineNo">050</span><a id="line.50"></a> |
| <span class="sourceLineNo">051</span><a id="line.51"> /**</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * Initializes the Shiro {@code WebEnvironment} and binds it to the {@code ServletContext} at application</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * startup for future reference.</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> *</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @param sce the ServletContextEvent triggered upon application startup</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> */</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> public void contextInitialized(ServletContextEvent sce) {</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> initEnvironment(sce.getServletContext());</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> }</a> |
| <span class="sourceLineNo">060</span><a id="line.60"></a> |
| <span class="sourceLineNo">061</span><a id="line.61"> /**</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * Destroys any previously created/bound {@code WebEnvironment} instance created by</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * the {@link #contextInitialized(javax.servlet.ServletContextEvent)} method.</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> *</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * @param sce the ServletContextEvent triggered upon application shutdown</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> */</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> public void contextDestroyed(ServletContextEvent sce) {</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> destroyEnvironment(sce.getServletContext());</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> }</a> |
| <span class="sourceLineNo">070</span><a id="line.70">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
