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