| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="fr"> |
| <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>import java.util.ArrayList;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.Iterator;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.List;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import java.util.ServiceLoader;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>/**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * An {@code EnvironmentLoader} is responsible for loading a web application's Shiro {@link WebEnvironment}<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * (which includes the web app's {@link org.apache.shiro.web.mgt.WebSecurityManager WebSecurityManager}) into the<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * {@code ServletContext} at application startup.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <p/><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * In Shiro 1.1 and earlier, the Shiro ServletFilter was responsible for creating the {@code WebSecurityManager} and<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * any additional objects (security filters, etc). However, any component not filtered by the Shiro Filter (such<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * as other context listeners) was not able to easily acquire the these objects to perform security operations.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <p/><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Due to this, in Shiro 1.2 and later, this {@code EnvironmentLoader} (or more likely, the<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * {@link EnvironmentLoaderListener} subclass) is the preferred mechanism to initialize<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * a Shiro environment. The Shiro Filter, while still required for request filtering, will not perform this<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * initialization at startup if the {@code EnvironmentLoader} (or listener) runs first.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <h2>Usage</h2><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * This implementation will look for two servlet context {@code context-param}s in {@code web.xml}:<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * {@code shiroEnvironmentClass} and {@code shiroConfigLocations} that customize how the {@code WebEnvironment} instance<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * will be initialized.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * <h3>shiroEnvironmentClass</h3><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * The {@code shiroEnvironmentClass} {@code context-param}, if it exists, allows you to specify the<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * fully-qualified implementation class name of the {@link WebEnvironment} to instantiate. For example:<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <pre><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * &lt;context-param&gt;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * &lt;param-name&gt;shiroEnvironmentClass&lt;/param-name&gt;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * &lt;param-value&gt;com.foo.bar.shiro.MyWebEnvironment&lt;/param-value&gt;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * &lt;/context-param&gt;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * </pre><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * If not specified, the default value is the {@link IniWebEnvironment} class, which assumes Shiro's default<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * <a href="http://shiro.apache.org/configuration.html">INI configuration format</a><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <h3>shiroConfigLocations</h3><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * The {@code shiroConfigLocations} {@code context-param}, if it exists, allows you to specify the config location(s)<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * (resource path(s)) that will be relayed to the instantiated {@link WebEnvironment}. For example:<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <pre><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * &lt;context-param&gt;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * &lt;param-name&gt;shiroConfigLocations&lt;/param-name&gt;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * &lt;param-value&gt;/WEB-INF/someLocation/shiro.ini&lt;/param-value&gt;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * &lt;/context-param&gt;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * </pre><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * The {@code WebEnvironment} implementation must implement the {@link ResourceConfigurable} interface if it is to<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * acquire the {@code shiroConfigLocations} value.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <p/><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * If this {@code context-param} is not specified, the {@code WebEnvironment} instance determines default resource<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * lookup behavior. For example, the {@link IniWebEnvironment} will check the following two locations for INI config<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * by default (in order):<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * <ol><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <li>/WEB-INF/shiro.ini</li><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <li>classpath:shiro.ini</li><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * </ol><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <h2>Web Security Enforcement</h2><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Using this loader will only initialize Shiro's environment in a web application - it will not filter web requests or<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * perform web-specific security operations. To do this, you must ensure that you have also configured the<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * {@link org.apache.shiro.web.servlet.ShiroFilter ShiroFilter} in {@code web.xml}.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * <p/><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * Finally, it should be noted that this implementation was based on ideas in Spring 3's<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * {@code org.springframework.web.context.ContextLoader} implementation - no need to reinvent the wheel for this common<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * behavior.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> *<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @see EnvironmentLoaderListener<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @see org.apache.shiro.web.servlet.ShiroFilter ShiroFilter<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @since 1.2<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span>public class EnvironmentLoader {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> /**<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * Servlet Context config param for specifying the {@link WebEnvironment} implementation class to use:<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * {@code shiroEnvironmentClass}<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> */<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> public static final String ENVIRONMENT_CLASS_PARAM = "shiroEnvironmentClass";<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /**<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * Servlet Context config param for the resource path to use for configuring the {@link WebEnvironment} instance:<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * {@code shiroConfigLocations}<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public static final String CONFIG_LOCATIONS_PARAM = "shiroConfigLocations";<a name="line.109"></a> |
| <span class="sourceLineNo">110</span><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> public static final String ENVIRONMENT_ATTRIBUTE_KEY = EnvironmentLoader.class.getName() + ".ENVIRONMENT_ATTRIBUTE_KEY";<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> private static final Logger log = LoggerFactory.getLogger(EnvironmentLoader.class);<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> /**<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * Initializes Shiro's {@link WebEnvironment} instance for the specified {@code ServletContext} based on the<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * {@link #CONFIG_LOCATIONS_PARAM} value.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> *<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param servletContext current servlet context<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @return the new Shiro {@code WebEnvironment} instance.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @throws IllegalStateException if an existing WebEnvironment has already been initialized and associated with<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * the specified {@code ServletContext}.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> */<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> public WebEnvironment initEnvironment(ServletContext servletContext) throws IllegalStateException {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> if (servletContext.getAttribute(ENVIRONMENT_ATTRIBUTE_KEY) != null) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> String msg = "There is already a Shiro environment associated with the current ServletContext. " +<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> "Check if you have multiple EnvironmentLoader* definitions in your web.xml!";<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> throw new IllegalStateException(msg);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> servletContext.log("Initializing Shiro environment");<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> log.info("Starting Shiro environment initialization.");<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> long startTime = System.currentTimeMillis();<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> try {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> WebEnvironment environment = createEnvironment(servletContext);<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> servletContext.setAttribute(ENVIRONMENT_ATTRIBUTE_KEY,environment);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> log.debug("Published WebEnvironment as ServletContext attribute with name [{}]",<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> ENVIRONMENT_ATTRIBUTE_KEY);<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> if (log.isInfoEnabled()) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> long elapsed = System.currentTimeMillis() - startTime;<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> log.info("Shiro environment initialized in {} ms.", elapsed);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> return environment;<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> } catch (RuntimeException ex) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> log.error("Shiro environment initialization failed", ex);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> servletContext.setAttribute(ENVIRONMENT_ATTRIBUTE_KEY, ex);<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> throw ex;<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> } catch (Error err) {<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> log.error("Shiro environment initialization failed", err);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> servletContext.setAttribute(ENVIRONMENT_ATTRIBUTE_KEY, err);<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> throw err;<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> }<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> }<a name="line.160"></a> |
| <span class="sourceLineNo">161</span><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> /**<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * Return the WebEnvironment implementation class to use, either the default<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * {@link IniWebEnvironment} or a custom class if specified.<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> *<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @param servletContext current servlet context<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * @return the WebEnvironment implementation class to use<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @see #ENVIRONMENT_CLASS_PARAM<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @see IniWebEnvironment<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @see #determineWebEnvironment(ServletContext)<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * @see #getDefaultWebEnvironmentClass()<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * @deprecated This method is not longer used by Shiro, and will be removed in future versions,<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * use {@link #determineWebEnvironment(ServletContext)} or {@link #determineWebEnvironment(ServletContext)}<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> */<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> @Deprecated<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> protected Class<?> determineWebEnvironmentClass(ServletContext servletContext) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> Class<? extends WebEnvironment> webEnvironmentClass = webEnvironmentClassFromServletContext(servletContext);<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> if( webEnvironmentClass != null) {<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> return webEnvironmentClass;<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> } else {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> return getDefaultWebEnvironmentClass();<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> }<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> }<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> private Class<? extends WebEnvironment> webEnvironmentClassFromServletContext(ServletContext servletContext) {<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> Class<? extends WebEnvironment> webEnvironmentClass = null;<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> String className = servletContext.getInitParameter(ENVIRONMENT_CLASS_PARAM);<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> if (className != null) {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> try {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> webEnvironmentClass = ClassUtils.forName(className);<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> } catch (UnknownClassException ex) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> throw new ConfigurationException(<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> "Failed to load custom WebEnvironment class [" + className + "]", ex);<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> }<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> return webEnvironmentClass;<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> private WebEnvironment webEnvironmentFromServiceLoader() {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span><a name="line.202"></a> |
| <span class="sourceLineNo">203</span> WebEnvironment webEnvironment = null;<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> // try to load WebEnvironment as a service<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> ServiceLoader<WebEnvironment> serviceLoader = ServiceLoader.load(WebEnvironment.class);<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> Iterator<WebEnvironment> iterator = serviceLoader.iterator();<a name="line.206"></a> |
| <span class="sourceLineNo">207</span><a name="line.207"></a> |
| <span class="sourceLineNo">208</span> // Use the first one<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> if (iterator.hasNext()) {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> webEnvironment = iterator.next();<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> // if there are others, throw an error<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> if (iterator.hasNext()) {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> List<String> allWebEnvironments = new ArrayList<String>();<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> allWebEnvironments.add(webEnvironment.getClass().getName());<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> while (iterator.hasNext()) {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> allWebEnvironments.add(iterator.next().getClass().getName());<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> }<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> throw new ConfigurationException("ServiceLoader for class [" + WebEnvironment.class + "] returned more then one " +<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> "result. ServiceLoader must return zero or exactly one result for this class. Select one using the " +<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> "servlet init parameter '"+ ENVIRONMENT_CLASS_PARAM +"'. Found: " + allWebEnvironments);<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> }<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> return webEnvironment;<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> /**<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * Returns the default WebEnvironment class, which is unless overridden: {@link IniWebEnvironment}.<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * @return the default WebEnvironment class.<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> */<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> protected Class<? extends WebEnvironment> getDefaultWebEnvironmentClass() {<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> return IniWebEnvironment.class;<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> }<a name="line.232"></a> |
| <span class="sourceLineNo">233</span><a name="line.233"></a> |
| <span class="sourceLineNo">234</span> /**<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * Return the WebEnvironment implementation class to use, based on the order of:<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * <ul><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * <li>A custom WebEnvironment class - specified in the {@code servletContext} {@link #ENVIRONMENT_ATTRIBUTE_KEY} property</li><a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * <li>{@code ServiceLoader.load(WebEnvironment.class)} - (if more then one instance is found a {@link ConfigurationException} will be thrown</li><a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * <li>A call to {@link #getDefaultWebEnvironmentClass()} (default: {@link IniWebEnvironment})</li><a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * </ul><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> *<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * @param servletContext current servlet context<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * @return the WebEnvironment implementation class to use<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * @see #ENVIRONMENT_CLASS_PARAM<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * @param servletContext the {@code servletContext} to query the {@code ENVIRONMENT_ATTRIBUTE_KEY} property from<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * @return the {@code WebEnvironment} to be used<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> */<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> protected WebEnvironment determineWebEnvironment(ServletContext servletContext) {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span><a name="line.249"></a> |
| <span class="sourceLineNo">250</span> Class<? extends WebEnvironment> webEnvironmentClass = webEnvironmentClassFromServletContext(servletContext);<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> WebEnvironment webEnvironment = null;<a name="line.251"></a> |
| <span class="sourceLineNo">252</span><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> // try service loader next<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> if (webEnvironmentClass == null) {<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> webEnvironment = webEnvironmentFromServiceLoader();<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> }<a name="line.256"></a> |
| <span class="sourceLineNo">257</span><a name="line.257"></a> |
| <span class="sourceLineNo">258</span> // if webEnvironment is not set, and ENVIRONMENT_CLASS_PARAM prop was not set, use the default<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> if (webEnvironmentClass == null && webEnvironment == null) {<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> webEnvironmentClass = getDefaultWebEnvironmentClass();<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> // at this point, we anything is set for the webEnvironmentClass, load it.<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> if (webEnvironmentClass != null) {<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> webEnvironment = (WebEnvironment) ClassUtils.newInstance(webEnvironmentClass);<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> }<a name="line.266"></a> |
| <span class="sourceLineNo">267</span><a name="line.267"></a> |
| <span class="sourceLineNo">268</span> return webEnvironment;<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> }<a name="line.269"></a> |
| <span class="sourceLineNo">270</span><a name="line.270"></a> |
| <span class="sourceLineNo">271</span> /**<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * Instantiates a {@link WebEnvironment} based on the specified ServletContext.<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * <p/><a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * This implementation {@link #determineWebEnvironmentClass(javax.servlet.ServletContext) determines} a<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * {@link WebEnvironment} implementation class to use. That class is instantiated, configured, and returned.<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * <p/><a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * This allows custom {@code WebEnvironment} implementations to be specified via a ServletContext init-param if<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * desired. If not specified, the default {@link IniWebEnvironment} implementation will be used.<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> *<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * @param sc current servlet context<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * @return the constructed Shiro WebEnvironment instance<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * @see MutableWebEnvironment<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * @see ResourceConfigurable<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> */<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> protected WebEnvironment createEnvironment(ServletContext sc) {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span><a name="line.286"></a> |
| <span class="sourceLineNo">287</span> WebEnvironment webEnvironment = determineWebEnvironment(sc);<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> if (!MutableWebEnvironment.class.isInstance(webEnvironment)) {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> throw new ConfigurationException("Custom WebEnvironment class [" + webEnvironment.getClass().getName() +<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> "] is not of required type [" + MutableWebEnvironment.class.getName() + "]");<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> }<a name="line.291"></a> |
| <span class="sourceLineNo">292</span><a name="line.292"></a> |
| <span class="sourceLineNo">293</span> String configLocations = sc.getInitParameter(CONFIG_LOCATIONS_PARAM);<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> boolean configSpecified = StringUtils.hasText(configLocations);<a name="line.294"></a> |
| <span class="sourceLineNo">295</span><a name="line.295"></a> |
| <span class="sourceLineNo">296</span> if (configSpecified && !(ResourceConfigurable.class.isInstance(webEnvironment))) {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> String msg = "WebEnvironment class [" + webEnvironment.getClass().getName() + "] does not implement the " +<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> ResourceConfigurable.class.getName() + "interface. This is required to accept any " +<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> "configured " + CONFIG_LOCATIONS_PARAM + "value(s).";<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> throw new ConfigurationException(msg);<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> }<a name="line.301"></a> |
| <span class="sourceLineNo">302</span><a name="line.302"></a> |
| <span class="sourceLineNo">303</span> MutableWebEnvironment environment = (MutableWebEnvironment) webEnvironment;<a name="line.303"></a> |
| <span class="sourceLineNo">304</span><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> environment.setServletContext(sc);<a name="line.305"></a> |
| <span class="sourceLineNo">306</span><a name="line.306"></a> |
| <span class="sourceLineNo">307</span> if (configSpecified && (environment instanceof ResourceConfigurable)) {<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> ((ResourceConfigurable) environment).setConfigLocations(configLocations);<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> }<a name="line.309"></a> |
| <span class="sourceLineNo">310</span><a name="line.310"></a> |
| <span class="sourceLineNo">311</span> customizeEnvironment(environment);<a name="line.311"></a> |
| <span class="sourceLineNo">312</span><a name="line.312"></a> |
| <span class="sourceLineNo">313</span> LifecycleUtils.init(environment);<a name="line.313"></a> |
| <span class="sourceLineNo">314</span><a name="line.314"></a> |
| <span class="sourceLineNo">315</span> return environment;<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<a name="line.316"></a> |
| <span class="sourceLineNo">317</span><a name="line.317"></a> |
| <span class="sourceLineNo">318</span> /**<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * Any additional customization of the Environment can be by overriding this method. For example setup shared<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * resources, etc. By default this method does nothing.<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * @param environment<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> */<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> protected void customizeEnvironment(WebEnvironment environment) {<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> }<a name="line.324"></a> |
| <span class="sourceLineNo">325</span><a name="line.325"></a> |
| <span class="sourceLineNo">326</span> /**<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> * Destroys the {@link WebEnvironment} for the given servlet context.<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> *<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * @param servletContext the ServletContext attributed to the WebSecurityManager<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> */<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> public void destroyEnvironment(ServletContext servletContext) {<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> servletContext.log("Cleaning up Shiro Environment");<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> try {<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> Object environment = servletContext.getAttribute(ENVIRONMENT_ATTRIBUTE_KEY);<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> if (environment instanceof WebEnvironment) {<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> finalizeEnvironment((WebEnvironment) environment);<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> }<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> LifecycleUtils.destroy(environment);<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> } finally {<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> servletContext.removeAttribute(ENVIRONMENT_ATTRIBUTE_KEY);<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> }<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> }<a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> /**<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * Any additional cleanup of the Environment can be done by overriding this method. For example clean up shared<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> * resources, etc. By default this method does nothing.<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> * @param environment<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> * @since 1.3<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> */<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> protected void finalizeEnvironment(WebEnvironment environment) {<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> }<a name="line.351"></a> |
| <span class="sourceLineNo">352</span>}<a name="line.352"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
