blob: c9257f02e6bf48fd517be1ad31e8dc8df91b2ed4 [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 org.apache.shiro.config.ConfigurationException;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.config.ResourceConfigurable;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.util.ClassUtils;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.util.LifecycleUtils;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.util.StringUtils;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.util.UnknownClassException;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.slf4j.Logger;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.slf4j.LoggerFactory;<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> import javax.servlet.ServletContext;<a name="line.30"></a>
<FONT color="green">031</FONT> <a name="line.31"></a>
<FONT color="green">032</FONT> /**<a name="line.32"></a>
<FONT color="green">033</FONT> * An {@code EnvironmentLoader} is responsible for loading a web application's Shiro {@link WebEnvironment}<a name="line.33"></a>
<FONT color="green">034</FONT> * (which includes the web app's {@link org.apache.shiro.web.mgt.WebSecurityManager WebSecurityManager}) into the<a name="line.34"></a>
<FONT color="green">035</FONT> * {@code ServletContext} at application startup.<a name="line.35"></a>
<FONT color="green">036</FONT> * &lt;p/&gt;<a name="line.36"></a>
<FONT color="green">037</FONT> * In Shiro 1.1 and earlier, the Shiro ServletFilter was responsible for creating the {@code WebSecurityManager} and<a name="line.37"></a>
<FONT color="green">038</FONT> * any additional objects (security filters, etc). However, any component not filtered by the Shiro Filter (such<a name="line.38"></a>
<FONT color="green">039</FONT> * as other context listeners) was not able to easily acquire the these objects to perform security operations.<a name="line.39"></a>
<FONT color="green">040</FONT> * &lt;p/&gt;<a name="line.40"></a>
<FONT color="green">041</FONT> * Due to this, in Shiro 1.2 and later, this {@code EnvironmentLoader} (or more likely, the<a name="line.41"></a>
<FONT color="green">042</FONT> * {@link EnvironmentLoaderListener} subclass) is the preferred mechanism to initialize<a name="line.42"></a>
<FONT color="green">043</FONT> * a Shiro environment. The Shiro Filter, while still required for request filtering, will not perform this<a name="line.43"></a>
<FONT color="green">044</FONT> * initialization at startup if the {@code EnvironmentLoader} (or listener) runs first.<a name="line.44"></a>
<FONT color="green">045</FONT> * &lt;h2&gt;Usage&lt;/h2&gt;<a name="line.45"></a>
<FONT color="green">046</FONT> * This implementation will look for two servlet context {@code context-param}s in {@code web.xml}:<a name="line.46"></a>
<FONT color="green">047</FONT> * {@code shiroEnvironmentClass} and {@code shiroConfigLocations} that customize how the {@code WebEnvironment} instance<a name="line.47"></a>
<FONT color="green">048</FONT> * will be initialized.<a name="line.48"></a>
<FONT color="green">049</FONT> * &lt;h3&gt;shiroEnvironmentClass&lt;/h3&gt;<a name="line.49"></a>
<FONT color="green">050</FONT> * The {@code shiroEnvironmentClass} {@code context-param}, if it exists, allows you to specify the<a name="line.50"></a>
<FONT color="green">051</FONT> * fully-qualified implementation class name of the {@link WebEnvironment} to instantiate. For example:<a name="line.51"></a>
<FONT color="green">052</FONT> * &lt;pre&gt;<a name="line.52"></a>
<FONT color="green">053</FONT> * &amp;lt;context-param&amp;gt;<a name="line.53"></a>
<FONT color="green">054</FONT> * &amp;lt;param-name&amp;gt;shiroEnvironmentClass&amp;lt;/param-name&amp;gt;<a name="line.54"></a>
<FONT color="green">055</FONT> * &amp;lt;param-value&amp;gt;com.foo.bar.shiro.MyWebEnvironment&amp;lt;/param-value&amp;gt;<a name="line.55"></a>
<FONT color="green">056</FONT> * &amp;lt;/context-param&amp;gt;<a name="line.56"></a>
<FONT color="green">057</FONT> * &lt;/pre&gt;<a name="line.57"></a>
<FONT color="green">058</FONT> * If not specified, the default value is the {@link IniWebEnvironment} class, which assumes Shiro's default<a name="line.58"></a>
<FONT color="green">059</FONT> * &lt;a href="http://shiro.apache.org/configuration.html"&gt;INI configuration format&lt;/a&gt;<a name="line.59"></a>
<FONT color="green">060</FONT> * &lt;h3&gt;shiroConfigLocations&lt;/h3&gt;<a name="line.60"></a>
<FONT color="green">061</FONT> * The {@code shiroConfigLocations} {@code context-param}, if it exists, allows you to specify the config location(s)<a name="line.61"></a>
<FONT color="green">062</FONT> * (resource path(s)) that will be relayed to the instantiated {@link WebEnvironment}. For example:<a name="line.62"></a>
<FONT color="green">063</FONT> * &lt;pre&gt;<a name="line.63"></a>
<FONT color="green">064</FONT> * &amp;lt;context-param&amp;gt;<a name="line.64"></a>
<FONT color="green">065</FONT> * &amp;lt;param-name&amp;gt;shiroConfigLocations&amp;lt;/param-name&amp;gt;<a name="line.65"></a>
<FONT color="green">066</FONT> * &amp;lt;param-value&amp;gt;/WEB-INF/someLocation/shiro.ini&amp;lt;/param-value&amp;gt;<a name="line.66"></a>
<FONT color="green">067</FONT> * &amp;lt;/context-param&amp;gt;<a name="line.67"></a>
<FONT color="green">068</FONT> * &lt;/pre&gt;<a name="line.68"></a>
<FONT color="green">069</FONT> * The {@code WebEnvironment} implementation must implement the {@link ResourceConfigurable} interface if it is to<a name="line.69"></a>
<FONT color="green">070</FONT> * acquire the {@code shiroConfigLocations} value.<a name="line.70"></a>
<FONT color="green">071</FONT> * &lt;p/&gt;<a name="line.71"></a>
<FONT color="green">072</FONT> * If this {@code context-param} is not specified, the {@code WebEnvironment} instance determines default resource<a name="line.72"></a>
<FONT color="green">073</FONT> * lookup behavior. For example, the {@link IniWebEnvironment} will check the following two locations for INI config<a name="line.73"></a>
<FONT color="green">074</FONT> * by default (in order):<a name="line.74"></a>
<FONT color="green">075</FONT> * &lt;ol&gt;<a name="line.75"></a>
<FONT color="green">076</FONT> * &lt;li&gt;/WEB-INF/shiro.ini&lt;/li&gt;<a name="line.76"></a>
<FONT color="green">077</FONT> * &lt;li&gt;classpath:shiro.ini&lt;/li&gt;<a name="line.77"></a>
<FONT color="green">078</FONT> * &lt;/ol&gt;<a name="line.78"></a>
<FONT color="green">079</FONT> * &lt;h2&gt;Web Security Enforcement&lt;/h2&gt;<a name="line.79"></a>
<FONT color="green">080</FONT> * Using this loader will only initialize Shiro's environment in a web application - it will not filter web requests or<a name="line.80"></a>
<FONT color="green">081</FONT> * perform web-specific security operations. To do this, you must ensure that you have also configured the<a name="line.81"></a>
<FONT color="green">082</FONT> * {@link org.apache.shiro.web.servlet.ShiroFilter ShiroFilter} in {@code web.xml}.<a name="line.82"></a>
<FONT color="green">083</FONT> * &lt;p/&gt;<a name="line.83"></a>
<FONT color="green">084</FONT> * Finally, it should be noted that this implementation was based on ideas in Spring 3's<a name="line.84"></a>
<FONT color="green">085</FONT> * {@code org.springframework.web.context.ContextLoader} implementation - no need to reinvent the wheel for this common<a name="line.85"></a>
<FONT color="green">086</FONT> * behavior.<a name="line.86"></a>
<FONT color="green">087</FONT> *<a name="line.87"></a>
<FONT color="green">088</FONT> * @see EnvironmentLoaderListener<a name="line.88"></a>
<FONT color="green">089</FONT> * @see org.apache.shiro.web.servlet.ShiroFilter ShiroFilter<a name="line.89"></a>
<FONT color="green">090</FONT> * @since 1.2<a name="line.90"></a>
<FONT color="green">091</FONT> */<a name="line.91"></a>
<FONT color="green">092</FONT> public class EnvironmentLoader {<a name="line.92"></a>
<FONT color="green">093</FONT> <a name="line.93"></a>
<FONT color="green">094</FONT> /**<a name="line.94"></a>
<FONT color="green">095</FONT> * Servlet Context config param for specifying the {@link WebEnvironment} implementation class to use:<a name="line.95"></a>
<FONT color="green">096</FONT> * {@code shiroEnvironmentClass}<a name="line.96"></a>
<FONT color="green">097</FONT> */<a name="line.97"></a>
<FONT color="green">098</FONT> public static final String ENVIRONMENT_CLASS_PARAM = "shiroEnvironmentClass";<a name="line.98"></a>
<FONT color="green">099</FONT> <a name="line.99"></a>
<FONT color="green">100</FONT> /**<a name="line.100"></a>
<FONT color="green">101</FONT> * Servlet Context config param for the resource path to use for configuring the {@link WebEnvironment} instance:<a name="line.101"></a>
<FONT color="green">102</FONT> * {@code shiroConfigLocations}<a name="line.102"></a>
<FONT color="green">103</FONT> */<a name="line.103"></a>
<FONT color="green">104</FONT> public static final String CONFIG_LOCATIONS_PARAM = "shiroConfigLocations";<a name="line.104"></a>
<FONT color="green">105</FONT> <a name="line.105"></a>
<FONT color="green">106</FONT> public static final String ENVIRONMENT_ATTRIBUTE_KEY = EnvironmentLoader.class.getName() + ".ENVIRONMENT_ATTRIBUTE_KEY";<a name="line.106"></a>
<FONT color="green">107</FONT> <a name="line.107"></a>
<FONT color="green">108</FONT> private static final Logger log = LoggerFactory.getLogger(EnvironmentLoader.class);<a name="line.108"></a>
<FONT color="green">109</FONT> <a name="line.109"></a>
<FONT color="green">110</FONT> /**<a name="line.110"></a>
<FONT color="green">111</FONT> * Initializes Shiro's {@link WebEnvironment} instance for the specified {@code ServletContext} based on the<a name="line.111"></a>
<FONT color="green">112</FONT> * {@link #CONFIG_LOCATIONS_PARAM} value.<a name="line.112"></a>
<FONT color="green">113</FONT> *<a name="line.113"></a>
<FONT color="green">114</FONT> * @param servletContext current servlet context<a name="line.114"></a>
<FONT color="green">115</FONT> * @return the new Shiro {@code WebEnvironment} instance.<a name="line.115"></a>
<FONT color="green">116</FONT> * @throws IllegalStateException if an existing WebEnvironment has already been initialized and associated with<a name="line.116"></a>
<FONT color="green">117</FONT> * the specified {@code ServletContext}.<a name="line.117"></a>
<FONT color="green">118</FONT> */<a name="line.118"></a>
<FONT color="green">119</FONT> public WebEnvironment initEnvironment(ServletContext servletContext) throws IllegalStateException {<a name="line.119"></a>
<FONT color="green">120</FONT> <a name="line.120"></a>
<FONT color="green">121</FONT> if (servletContext.getAttribute(ENVIRONMENT_ATTRIBUTE_KEY) != null) {<a name="line.121"></a>
<FONT color="green">122</FONT> String msg = "There is already a Shiro environment associated with the current ServletContext. " +<a name="line.122"></a>
<FONT color="green">123</FONT> "Check if you have multiple EnvironmentLoader* definitions in your web.xml!";<a name="line.123"></a>
<FONT color="green">124</FONT> throw new IllegalStateException(msg);<a name="line.124"></a>
<FONT color="green">125</FONT> }<a name="line.125"></a>
<FONT color="green">126</FONT> <a name="line.126"></a>
<FONT color="green">127</FONT> servletContext.log("Initializing Shiro environment");<a name="line.127"></a>
<FONT color="green">128</FONT> log.info("Starting Shiro environment initialization.");<a name="line.128"></a>
<FONT color="green">129</FONT> <a name="line.129"></a>
<FONT color="green">130</FONT> long startTime = System.currentTimeMillis();<a name="line.130"></a>
<FONT color="green">131</FONT> <a name="line.131"></a>
<FONT color="green">132</FONT> try {<a name="line.132"></a>
<FONT color="green">133</FONT> WebEnvironment environment = createEnvironment(servletContext);<a name="line.133"></a>
<FONT color="green">134</FONT> servletContext.setAttribute(ENVIRONMENT_ATTRIBUTE_KEY, environment);<a name="line.134"></a>
<FONT color="green">135</FONT> <a name="line.135"></a>
<FONT color="green">136</FONT> log.debug("Published WebEnvironment as ServletContext attribute with name [{}]",<a name="line.136"></a>
<FONT color="green">137</FONT> ENVIRONMENT_ATTRIBUTE_KEY);<a name="line.137"></a>
<FONT color="green">138</FONT> <a name="line.138"></a>
<FONT color="green">139</FONT> if (log.isInfoEnabled()) {<a name="line.139"></a>
<FONT color="green">140</FONT> long elapsed = System.currentTimeMillis() - startTime;<a name="line.140"></a>
<FONT color="green">141</FONT> log.info("Shiro environment initialized in {} ms.", elapsed);<a name="line.141"></a>
<FONT color="green">142</FONT> }<a name="line.142"></a>
<FONT color="green">143</FONT> <a name="line.143"></a>
<FONT color="green">144</FONT> return environment;<a name="line.144"></a>
<FONT color="green">145</FONT> } catch (RuntimeException ex) {<a name="line.145"></a>
<FONT color="green">146</FONT> log.error("Shiro environment initialization failed", ex);<a name="line.146"></a>
<FONT color="green">147</FONT> servletContext.setAttribute(ENVIRONMENT_ATTRIBUTE_KEY, ex);<a name="line.147"></a>
<FONT color="green">148</FONT> throw ex;<a name="line.148"></a>
<FONT color="green">149</FONT> } catch (Error err) {<a name="line.149"></a>
<FONT color="green">150</FONT> log.error("Shiro environment initialization failed", err);<a name="line.150"></a>
<FONT color="green">151</FONT> servletContext.setAttribute(ENVIRONMENT_ATTRIBUTE_KEY, err);<a name="line.151"></a>
<FONT color="green">152</FONT> throw err;<a name="line.152"></a>
<FONT color="green">153</FONT> }<a name="line.153"></a>
<FONT color="green">154</FONT> }<a name="line.154"></a>
<FONT color="green">155</FONT> <a name="line.155"></a>
<FONT color="green">156</FONT> /**<a name="line.156"></a>
<FONT color="green">157</FONT> * Return the WebEnvironment implementation class to use, either the default<a name="line.157"></a>
<FONT color="green">158</FONT> * {@link IniWebEnvironment} or a custom class if specified.<a name="line.158"></a>
<FONT color="green">159</FONT> *<a name="line.159"></a>
<FONT color="green">160</FONT> * @param servletContext current servlet context<a name="line.160"></a>
<FONT color="green">161</FONT> * @return the WebEnvironment implementation class to use<a name="line.161"></a>
<FONT color="green">162</FONT> * @see #ENVIRONMENT_CLASS_PARAM<a name="line.162"></a>
<FONT color="green">163</FONT> * @see IniWebEnvironment<a name="line.163"></a>
<FONT color="green">164</FONT> */<a name="line.164"></a>
<FONT color="green">165</FONT> protected Class&lt;?&gt; determineWebEnvironmentClass(ServletContext servletContext) {<a name="line.165"></a>
<FONT color="green">166</FONT> String className = servletContext.getInitParameter(ENVIRONMENT_CLASS_PARAM);<a name="line.166"></a>
<FONT color="green">167</FONT> if (className != null) {<a name="line.167"></a>
<FONT color="green">168</FONT> try {<a name="line.168"></a>
<FONT color="green">169</FONT> return ClassUtils.forName(className);<a name="line.169"></a>
<FONT color="green">170</FONT> } catch (UnknownClassException ex) {<a name="line.170"></a>
<FONT color="green">171</FONT> throw new ConfigurationException(<a name="line.171"></a>
<FONT color="green">172</FONT> "Failed to load custom WebEnvironment class [" + className + "]", ex);<a name="line.172"></a>
<FONT color="green">173</FONT> }<a name="line.173"></a>
<FONT color="green">174</FONT> } else {<a name="line.174"></a>
<FONT color="green">175</FONT> return IniWebEnvironment.class;<a name="line.175"></a>
<FONT color="green">176</FONT> }<a name="line.176"></a>
<FONT color="green">177</FONT> }<a name="line.177"></a>
<FONT color="green">178</FONT> <a name="line.178"></a>
<FONT color="green">179</FONT> /**<a name="line.179"></a>
<FONT color="green">180</FONT> * Instantiates a {@link WebEnvironment} based on the specified ServletContext.<a name="line.180"></a>
<FONT color="green">181</FONT> * &lt;p/&gt;<a name="line.181"></a>
<FONT color="green">182</FONT> * This implementation {@link #determineWebEnvironmentClass(javax.servlet.ServletContext) determines} a<a name="line.182"></a>
<FONT color="green">183</FONT> * {@link WebEnvironment} implementation class to use. That class is instantiated, configured, and returned.<a name="line.183"></a>
<FONT color="green">184</FONT> * &lt;p/&gt;<a name="line.184"></a>
<FONT color="green">185</FONT> * This allows custom {@code WebEnvironment} implementations to be specified via a ServletContext init-param if<a name="line.185"></a>
<FONT color="green">186</FONT> * desired. If not specified, the default {@link IniWebEnvironment} implementation will be used.<a name="line.186"></a>
<FONT color="green">187</FONT> *<a name="line.187"></a>
<FONT color="green">188</FONT> * @param sc current servlet context<a name="line.188"></a>
<FONT color="green">189</FONT> * @return the constructed Shiro WebEnvironment instance<a name="line.189"></a>
<FONT color="green">190</FONT> * @see MutableWebEnvironment<a name="line.190"></a>
<FONT color="green">191</FONT> * @see ResourceConfigurable<a name="line.191"></a>
<FONT color="green">192</FONT> */<a name="line.192"></a>
<FONT color="green">193</FONT> protected WebEnvironment createEnvironment(ServletContext sc) {<a name="line.193"></a>
<FONT color="green">194</FONT> <a name="line.194"></a>
<FONT color="green">195</FONT> Class&lt;?&gt; clazz = determineWebEnvironmentClass(sc);<a name="line.195"></a>
<FONT color="green">196</FONT> if (!MutableWebEnvironment.class.isAssignableFrom(clazz)) {<a name="line.196"></a>
<FONT color="green">197</FONT> throw new ConfigurationException("Custom WebEnvironment class [" + clazz.getName() +<a name="line.197"></a>
<FONT color="green">198</FONT> "] is not of required type [" + WebEnvironment.class.getName() + "]");<a name="line.198"></a>
<FONT color="green">199</FONT> }<a name="line.199"></a>
<FONT color="green">200</FONT> <a name="line.200"></a>
<FONT color="green">201</FONT> String configLocations = sc.getInitParameter(CONFIG_LOCATIONS_PARAM);<a name="line.201"></a>
<FONT color="green">202</FONT> boolean configSpecified = StringUtils.hasText(configLocations);<a name="line.202"></a>
<FONT color="green">203</FONT> <a name="line.203"></a>
<FONT color="green">204</FONT> if (configSpecified &amp;&amp; !(ResourceConfigurable.class.isAssignableFrom(clazz))) {<a name="line.204"></a>
<FONT color="green">205</FONT> String msg = "WebEnvironment class [" + clazz.getName() + "] does not implement the " +<a name="line.205"></a>
<FONT color="green">206</FONT> ResourceConfigurable.class.getName() + "interface. This is required to accept any " +<a name="line.206"></a>
<FONT color="green">207</FONT> "configured " + CONFIG_LOCATIONS_PARAM + "value(s).";<a name="line.207"></a>
<FONT color="green">208</FONT> throw new ConfigurationException(msg);<a name="line.208"></a>
<FONT color="green">209</FONT> }<a name="line.209"></a>
<FONT color="green">210</FONT> <a name="line.210"></a>
<FONT color="green">211</FONT> MutableWebEnvironment environment = (MutableWebEnvironment) ClassUtils.newInstance(clazz);<a name="line.211"></a>
<FONT color="green">212</FONT> <a name="line.212"></a>
<FONT color="green">213</FONT> environment.setServletContext(sc);<a name="line.213"></a>
<FONT color="green">214</FONT> <a name="line.214"></a>
<FONT color="green">215</FONT> if (configSpecified &amp;&amp; (environment instanceof ResourceConfigurable)) {<a name="line.215"></a>
<FONT color="green">216</FONT> ((ResourceConfigurable) environment).setConfigLocations(configLocations);<a name="line.216"></a>
<FONT color="green">217</FONT> }<a name="line.217"></a>
<FONT color="green">218</FONT> <a name="line.218"></a>
<FONT color="green">219</FONT> customizeEnvironment(environment);<a name="line.219"></a>
<FONT color="green">220</FONT> <a name="line.220"></a>
<FONT color="green">221</FONT> LifecycleUtils.init(environment);<a name="line.221"></a>
<FONT color="green">222</FONT> <a name="line.222"></a>
<FONT color="green">223</FONT> return environment;<a name="line.223"></a>
<FONT color="green">224</FONT> }<a name="line.224"></a>
<FONT color="green">225</FONT> <a name="line.225"></a>
<FONT color="green">226</FONT> protected void customizeEnvironment(WebEnvironment environment) {<a name="line.226"></a>
<FONT color="green">227</FONT> }<a name="line.227"></a>
<FONT color="green">228</FONT> <a name="line.228"></a>
<FONT color="green">229</FONT> /**<a name="line.229"></a>
<FONT color="green">230</FONT> * Destroys the {@link WebEnvironment} for the given servlet context.<a name="line.230"></a>
<FONT color="green">231</FONT> *<a name="line.231"></a>
<FONT color="green">232</FONT> * @param servletContext the ServletContext attributed to the WebSecurityManager<a name="line.232"></a>
<FONT color="green">233</FONT> */<a name="line.233"></a>
<FONT color="green">234</FONT> public void destroyEnvironment(ServletContext servletContext) {<a name="line.234"></a>
<FONT color="green">235</FONT> servletContext.log("Cleaning up Shiro Environment");<a name="line.235"></a>
<FONT color="green">236</FONT> try {<a name="line.236"></a>
<FONT color="green">237</FONT> Object environment = servletContext.getAttribute(ENVIRONMENT_ATTRIBUTE_KEY);<a name="line.237"></a>
<FONT color="green">238</FONT> LifecycleUtils.destroy(environment);<a name="line.238"></a>
<FONT color="green">239</FONT> } finally {<a name="line.239"></a>
<FONT color="green">240</FONT> servletContext.removeAttribute(ENVIRONMENT_ATTRIBUTE_KEY);<a name="line.240"></a>
<FONT color="green">241</FONT> }<a name="line.241"></a>
<FONT color="green">242</FONT> }<a name="line.242"></a>
<FONT color="green">243</FONT> }<a name="line.243"></a>
</PRE>
</BODY>
</HTML>