| <!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.Ini;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.config.IniFactorySupport;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.io.ResourceUtils;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.util.*;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.web.config.IniFilterChainResolverFactory;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.shiro.web.config.WebIniSecurityManagerFactory;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.shiro.web.filter.mgt.FilterChainResolver;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.shiro.web.mgt.WebSecurityManager;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.shiro.web.util.WebUtils;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.slf4j.Logger;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.slf4j.LoggerFactory;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import javax.servlet.ServletContext;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import java.io.IOException;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import java.io.InputStream;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import java.util.HashMap;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import java.util.Map;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span>/**<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * {@link WebEnvironment} implementation configured by an {@link Ini} instance or {@code Ini} resource locations.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> *<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @since 1.2<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>public class IniWebEnvironment extends ResourceBasedWebEnvironment implements Initializable, Destroyable {<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> public static final String DEFAULT_WEB_INI_RESOURCE_PATH = "/WEB-INF/shiro.ini";<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> public static final String FILTER_CHAIN_RESOLVER_NAME = "filterChainResolver";<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> private static final Logger log = LoggerFactory.getLogger(IniWebEnvironment.class);<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> /**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * The Ini that configures this WebEnvironment instance.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private Ini ini;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private WebIniSecurityManagerFactory factory;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> public IniWebEnvironment() {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> factory = new WebIniSecurityManagerFactory();<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> /**<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * Initializes this instance by resolving any potential (explicit or resource-configured) {@link Ini}<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * configuration and calling {@link #configure() configure} for actual instance configuration.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> public void init() {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> setIni(parseConfig());<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> configure();<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> }<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> /**<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * Loads configuration {@link Ini} from {@link #getConfigLocations()} if set, otherwise falling back<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * to the {@link #getDefaultConfigLocations()}. Finally any Ini objects will be merged with the value returned<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * from {@link #getFrameworkIni()}<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @return Ini configuration to be used by this Environment.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @since 1.4<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> protected Ini parseConfig() {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> Ini ini = getIni();<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> String[] configLocations = getConfigLocations();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> if (log.isWarnEnabled() && !CollectionUtils.isEmpty(ini) &&<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> configLocations != null && configLocations.length > 0) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> log.warn("Explicit INI instance has been provided, but configuration locations have also been " +<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> "specified. The {} implementation does not currently support multiple Ini config, but this may " +<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> "be supported in the future. Only the INI instance will be used for configuration.",<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> IniWebEnvironment.class.getName());<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> }<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> if (CollectionUtils.isEmpty(ini)) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> log.debug("Checking any specified config locations.");<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> ini = getSpecifiedIni(configLocations);<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> }<a name="line.97"></a> |
| <span class="sourceLineNo">098</span><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> if (CollectionUtils.isEmpty(ini)) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> log.debug("No INI instance or config locations specified. Trying default config locations.");<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> ini = getDefaultIni();<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> // Allow for integrations to provide default that will be merged other configuration.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> // to retain backwards compatibility this must be a different method then 'getDefaultIni()'<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> ini = mergeIni(getFrameworkIni(), ini);<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> if (CollectionUtils.isEmpty(ini)) {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> String msg = "Shiro INI configuration was either not found or discovered to be empty/unconfigured.";<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> throw new ConfigurationException(msg);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> return ini;<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> protected void configure() {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> this.objects.clear();<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> WebSecurityManager securityManager = createWebSecurityManager();<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> setWebSecurityManager(securityManager);<a name="line.120"></a> |
| <span class="sourceLineNo">121</span><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> FilterChainResolver resolver = createFilterChainResolver();<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> if (resolver != null) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> setFilterChainResolver(resolver);<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><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> /**<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * Extension point to allow subclasses to provide an {@link Ini} configuration that will be merged into the<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * users configuration. The users configuration will override anything set here.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * <p><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * <strong>NOTE:</strong> Framework developers should use with caution. It is possible a user could provide<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * configuration that would conflict with the frameworks configuration. For example: if this method returns an<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * Ini object with the following configuration:<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * <pre><code><a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * [main]<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * realm = com.myco.FoobarRealm<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * realm.foobarSpecificField = A string<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * </code></pre><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * And the user provides a similar configuration:<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * <pre><code><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * [main]<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * realm = net.differentco.MyCustomRealm<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * </code></pre><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> *<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * This would merge into:<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * <pre><code><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * [main]<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * realm = net.differentco.MyCustomRealm<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * realm.foobarSpecificField = A string<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * </code></pre><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> *<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * This may cause a configuration error if <code>MyCustomRealm</code> does not contain the field <code>foobarSpecificField</code>.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * This can be avoided if the Framework Ini uses more unique names, such as <code>foobarRealm</code>. which would result<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * in a merged configuration that looks like:<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * <pre><code><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * [main]<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * foobarRealm = com.myco.FoobarRealm<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * foobarRealm.foobarSpecificField = A string<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * realm = net.differentco.MyCustomRealm<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * </code></pre><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> *<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * </p><a name="line.163"></a> |
| <span class="sourceLineNo">164</span> *<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * @return Ini configuration used by the framework integrations.<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @since 1.4<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> */<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> protected Ini getFrameworkIni() {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> return null;<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> protected Ini getSpecifiedIni(String[] configLocations) throws ConfigurationException {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> Ini ini = null;<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> if (configLocations != null && configLocations.length > 0) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> if (configLocations.length > 1) {<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> log.warn("More than one Shiro .ini config location has been specified. Only the first will be " +<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> "used for configuration as the {} implementation does not currently support multiple " +<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> "files. This may be supported in the future however.", IniWebEnvironment.class.getName());<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> }<a name="line.182"></a> |
| <span class="sourceLineNo">183</span><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> //required, as it is user specified:<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> ini = createIni(configLocations[0], true);<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> }<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> return ini;<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> }<a name="line.189"></a> |
| <span class="sourceLineNo">190</span><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> protected Ini mergeIni(Ini ini1, Ini ini2) {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span><a name="line.192"></a> |
| <span class="sourceLineNo">193</span> if (ini1 == null) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> return ini2;<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span><a name="line.196"></a> |
| <span class="sourceLineNo">197</span> if (ini2 == null) {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> return ini1;<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> // at this point we have two valid ini objects, create a new one and merge the contents of 2 into 1<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> Ini iniResult = new Ini(ini1);<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> iniResult.merge(ini2);<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> return iniResult;<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span><a name="line.207"></a> |
| <span class="sourceLineNo">208</span> protected Ini getDefaultIni() {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span><a name="line.209"></a> |
| <span class="sourceLineNo">210</span> Ini ini = null;<a name="line.210"></a> |
| <span class="sourceLineNo">211</span><a name="line.211"></a> |
| <span class="sourceLineNo">212</span> String[] configLocations = getDefaultConfigLocations();<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> if (configLocations != null) {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> for (String location : configLocations) {<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> ini = createIni(location, false);<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> if (!CollectionUtils.isEmpty(ini)) {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> log.debug("Discovered non-empty INI configuration at location '{}'. Using for configuration.",<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> location);<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> break;<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> }<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> }<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> }<a name="line.222"></a> |
| <span class="sourceLineNo">223</span><a name="line.223"></a> |
| <span class="sourceLineNo">224</span> return ini;<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> /**<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * Creates an {@link Ini} instance reflecting the specified path, or {@code null} if the path does not exist and<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * is not required.<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * <p/><a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * If the path is required and does not exist or is empty, a {@link ConfigurationException} will be thrown.<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> *<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * @param configLocation the resource path to load into an {@code Ini} instance.<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * @param required if the path must exist and be converted to a non-empty {@link Ini} instance.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * @return an {@link Ini} instance reflecting the specified path, or {@code null} if the path does not exist and<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * is not required.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * @throws ConfigurationException if the path is required but results in a null or empty Ini instance.<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> */<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> protected Ini createIni(String configLocation, boolean required) throws ConfigurationException {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> Ini ini = null;<a name="line.241"></a> |
| <span class="sourceLineNo">242</span><a name="line.242"></a> |
| <span class="sourceLineNo">243</span> if (configLocation != null) {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> ini = convertPathToIni(configLocation, required);<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> }<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> if (required && CollectionUtils.isEmpty(ini)) {<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> String msg = "Required configuration location '" + configLocation + "' does not exist or did not " +<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> "contain any INI configuration.";<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> throw new ConfigurationException(msg);<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<a name="line.250"></a> |
| <span class="sourceLineNo">251</span><a name="line.251"></a> |
| <span class="sourceLineNo">252</span> return ini;<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> }<a name="line.253"></a> |
| <span class="sourceLineNo">254</span><a name="line.254"></a> |
| <span class="sourceLineNo">255</span> protected FilterChainResolver createFilterChainResolver() {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span><a name="line.256"></a> |
| <span class="sourceLineNo">257</span> FilterChainResolver resolver = null;<a name="line.257"></a> |
| <span class="sourceLineNo">258</span><a name="line.258"></a> |
| <span class="sourceLineNo">259</span> Ini ini = getIni();<a name="line.259"></a> |
| <span class="sourceLineNo">260</span><a name="line.260"></a> |
| <span class="sourceLineNo">261</span> if (!CollectionUtils.isEmpty(ini)) {<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> //only create a resolver if the 'filters' or 'urls' sections are defined:<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> Ini.Section urls = ini.getSection(IniFilterChainResolverFactory.URLS);<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> Ini.Section filters = ini.getSection(IniFilterChainResolverFactory.FILTERS);<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> if (!CollectionUtils.isEmpty(urls) || !CollectionUtils.isEmpty(filters)) {<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> //either the urls section or the filters section was defined. Go ahead and create the resolver:<a name="line.266"></a> |
| <span class="sourceLineNo">267</span><a name="line.267"></a> |
| <span class="sourceLineNo">268</span> Factory<FilterChainResolver> factory = (Factory<FilterChainResolver>) this.objects.get(FILTER_CHAIN_RESOLVER_NAME);<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> if (factory instanceof IniFactorySupport) {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> IniFactorySupport iniFactory = (IniFactorySupport) factory;<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> iniFactory.setIni(ini);<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> iniFactory.setDefaults(this.objects);<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> }<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> resolver = factory.getInstance();<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> }<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> }<a name="line.276"></a> |
| <span class="sourceLineNo">277</span><a name="line.277"></a> |
| <span class="sourceLineNo">278</span> return resolver;<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span><a name="line.280"></a> |
| <span class="sourceLineNo">281</span> protected WebSecurityManager createWebSecurityManager() {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span><a name="line.282"></a> |
| <span class="sourceLineNo">283</span> Ini ini = getIni();<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> if (!CollectionUtils.isEmpty(ini)) {<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> factory.setIni(ini);<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> }<a name="line.286"></a> |
| <span class="sourceLineNo">287</span><a name="line.287"></a> |
| <span class="sourceLineNo">288</span> Map<String, Object> defaults = getDefaults();<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> if (!CollectionUtils.isEmpty(defaults)) {<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> factory.setDefaults(defaults);<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> WebSecurityManager wsm = (WebSecurityManager)factory.getInstance();<a name="line.293"></a> |
| <span class="sourceLineNo">294</span><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> //SHIRO-306 - get beans after they've been created (the call was before the factory.getInstance() call,<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> //which always returned null.<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> Map<String, ?> beans = factory.getBeans();<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> if (!CollectionUtils.isEmpty(beans)) {<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> this.objects.putAll(beans);<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> }<a name="line.300"></a> |
| <span class="sourceLineNo">301</span><a name="line.301"></a> |
| <span class="sourceLineNo">302</span> return wsm;<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> }<a name="line.303"></a> |
| <span class="sourceLineNo">304</span><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> /**<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * Returns an array with two elements, {@code /WEB-INF/shiro.ini} and {@code classpath:shiro.ini}.<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> *<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * @return an array with two elements, {@code /WEB-INF/shiro.ini} and {@code classpath:shiro.ini}.<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> */<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> protected String[] getDefaultConfigLocations() {<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> return new String[]{<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> DEFAULT_WEB_INI_RESOURCE_PATH,<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> IniFactorySupport.DEFAULT_INI_RESOURCE_PATH<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> };<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> }<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> * Converts the specified file path to an {@link Ini} instance.<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * <p/><a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * If the path does not have a resource prefix as defined by {@link org.apache.shiro.io.ResourceUtils#hasResourcePrefix(String)}, the<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * path is expected to be resolvable by the {@code ServletContext} via<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * {@link javax.servlet.ServletContext#getResourceAsStream(String)}.<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> *<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * @param path the path of the INI resource to load into an INI instance.<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * @param required if the specified path must exist<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * @return an INI instance populated based on the given INI resource path.<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> */<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> private Ini convertPathToIni(String path, boolean required) {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span><a name="line.329"></a> |
| <span class="sourceLineNo">330</span> //TODO - this logic is ugly - it'd be ideal if we had a Resource API to polymorphically encaspulate this behavior<a name="line.330"></a> |
| <span class="sourceLineNo">331</span><a name="line.331"></a> |
| <span class="sourceLineNo">332</span> Ini ini = null;<a name="line.332"></a> |
| <span class="sourceLineNo">333</span><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> if (StringUtils.hasText(path)) {<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> InputStream is = null;<a name="line.335"></a> |
| <span class="sourceLineNo">336</span><a name="line.336"></a> |
| <span class="sourceLineNo">337</span> //SHIRO-178: Check for servlet context resource and not only resource paths:<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> if (!ResourceUtils.hasResourcePrefix(path)) {<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> is = getServletContextResourceStream(path);<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> } else {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> try {<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> is = ResourceUtils.getInputStreamForPath(path);<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> } catch (IOException e) {<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> if (required) {<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> throw new ConfigurationException(e);<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> } else {<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> if (log.isDebugEnabled()) {<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> log.debug("Unable to load optional path '" + path + "'.", e);<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> }<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> }<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> |
| <span class="sourceLineNo">353</span> if (is != null) {<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> ini = new Ini();<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> ini.load(is);<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> } else {<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> if (required) {<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> throw new ConfigurationException("Unable to load resource path '" + path + "'");<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> }<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> }<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> }<a name="line.361"></a> |
| <span class="sourceLineNo">362</span><a name="line.362"></a> |
| <span class="sourceLineNo">363</span> return ini;<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> }<a name="line.364"></a> |
| <span class="sourceLineNo">365</span><a name="line.365"></a> |
| <span class="sourceLineNo">366</span> //TODO - this logic is ugly - it'd be ideal if we had a Resource API to polymorphically encaspulate this behavior<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> private InputStream getServletContextResourceStream(String path) {<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> InputStream is = null;<a name="line.368"></a> |
| <span class="sourceLineNo">369</span><a name="line.369"></a> |
| <span class="sourceLineNo">370</span> path = WebUtils.normalize(path);<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> ServletContext sc = getServletContext();<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> if (sc != null) {<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> is = sc.getResourceAsStream(path);<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> }<a name="line.374"></a> |
| <span class="sourceLineNo">375</span><a name="line.375"></a> |
| <span class="sourceLineNo">376</span> return is;<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> }<a name="line.377"></a> |
| <span class="sourceLineNo">378</span><a name="line.378"></a> |
| <span class="sourceLineNo">379</span> /**<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * Returns the {@code Ini} instance reflecting this WebEnvironment's configuration.<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> *<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * @return the {@code Ini} instance reflecting this WebEnvironment's configuration.<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> */<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> public Ini getIni() {<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> return this.ini;<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> }<a name="line.386"></a> |
| <span class="sourceLineNo">387</span><a name="line.387"></a> |
| <span class="sourceLineNo">388</span> /**<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> * Allows for configuration via a direct {@link Ini} instance instead of via<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> * {@link #getConfigLocations() config locations}.<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> * <p/><a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * If the specified instance is null or empty, the fallback/default resource-based configuration will be used.<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> *<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> * @param ini the ini instance to use for creation.<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> */<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> public void setIni(Ini ini) {<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> this.ini = ini;<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> }<a name="line.398"></a> |
| <span class="sourceLineNo">399</span><a name="line.399"></a> |
| <span class="sourceLineNo">400</span> protected Map<String, Object> getDefaults() {<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> Map<String, Object> defaults = new HashMap<String, Object>();<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> defaults.put(FILTER_CHAIN_RESOLVER_NAME, new IniFilterChainResolverFactory());<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> return defaults;<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> }<a name="line.404"></a> |
| <span class="sourceLineNo">405</span><a name="line.405"></a> |
| <span class="sourceLineNo">406</span> /**<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> * Returns the SecurityManager factory used by this WebEnvironment.<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> *<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> * @return the SecurityManager factory used by this WebEnvironment.<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * @since 1.4<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> */<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> @SuppressWarnings("unused")<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> protected WebIniSecurityManagerFactory getSecurityManagerFactory() {<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> return factory;<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> }<a name="line.415"></a> |
| <span class="sourceLineNo">416</span><a name="line.416"></a> |
| <span class="sourceLineNo">417</span> /**<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> * Allows for setting the SecurityManager factory which will be used to create the SecurityManager.<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> *<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> * @param factory the SecurityManager factory to used.<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> * @since 1.4<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> */<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> protected void setSecurityManagerFactory(WebIniSecurityManagerFactory factory) {<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> this.factory = factory;<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> }<a name="line.425"></a> |
| <span class="sourceLineNo">426</span>}<a name="line.426"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
