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