| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.web.servlet;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.config.ConfigurationException;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.config.Ini;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.config.IniFactorySupport;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.io.ResourceUtils;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.mgt.SecurityManager;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.util.CollectionUtils;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.shiro.util.StringUtils;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.apache.shiro.web.config.IniFilterChainResolverFactory;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.apache.shiro.web.config.WebIniSecurityManagerFactory;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import org.apache.shiro.web.filter.mgt.FilterChainResolver;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import org.apache.shiro.web.mgt.WebSecurityManager;<a name="line.31"></a> |
| <FONT color="green">032</FONT> import org.apache.shiro.web.util.WebUtils;<a name="line.32"></a> |
| <FONT color="green">033</FONT> import org.slf4j.Logger;<a name="line.33"></a> |
| <FONT color="green">034</FONT> import org.slf4j.LoggerFactory;<a name="line.34"></a> |
| <FONT color="green">035</FONT> <a name="line.35"></a> |
| <FONT color="green">036</FONT> import java.io.InputStream;<a name="line.36"></a> |
| <FONT color="green">037</FONT> import java.util.Map;<a name="line.37"></a> |
| <FONT color="green">038</FONT> <a name="line.38"></a> |
| <FONT color="green">039</FONT> /**<a name="line.39"></a> |
| <FONT color="green">040</FONT> * <h1>Deprecated</h1><a name="line.40"></a> |
| <FONT color="green">041</FONT> * This filter has been deprecated as of Shiro 1.2 in favor of using the {@link ShiroFilter} in {@code web.xml} instead.<a name="line.41"></a> |
| <FONT color="green">042</FONT> * See the {@link ShiroFilter} JavaDoc for usage.<a name="line.42"></a> |
| <FONT color="green">043</FONT> * <p/><a name="line.43"></a> |
| <FONT color="green">044</FONT> * ======================<a name="line.44"></a> |
| <FONT color="green">045</FONT> * <p/><a name="line.45"></a> |
| <FONT color="green">046</FONT> * Servlet Filter that configures and enables all Shiro functions within a web application by using the<a name="line.46"></a> |
| <FONT color="green">047</FONT> * <a href="http://en.wikipedia.org/wiki/INI_file">INI</a> configuration format.<a name="line.47"></a> |
| <FONT color="green">048</FONT> * <p/><a name="line.48"></a> |
| <FONT color="green">049</FONT> * The actual INI configuration contents are not covered here, but instead in Shiro's<a name="line.49"></a> |
| <FONT color="green">050</FONT> * <a href="http://shiro.apache.org/configuration.html">Configuration Documentation</a> and additional web-specific<a name="line.50"></a> |
| <FONT color="green">051</FONT> * <a href="http://shiro.apache.org/web.html">Web Documentation</a>.<a name="line.51"></a> |
| <FONT color="green">052</FONT> * <h2>Usage</h2><a name="line.52"></a> |
| <FONT color="green">053</FONT> * <h3>Default</h3><a name="line.53"></a> |
| <FONT color="green">054</FONT> * By default, the simplest filter declaration expects a {@code shiro.ini} resource to be located at<a name="line.54"></a> |
| <FONT color="green">055</FONT> * {@code /WEB-INF/shiro.ini}, or, if not there, falls back to checking the root of the classpath<a name="line.55"></a> |
| <FONT color="green">056</FONT> * (i.e. {@code classpath:shiro.ini}):<a name="line.56"></a> |
| <FONT color="green">057</FONT> * <pre><a name="line.57"></a> |
| <FONT color="green">058</FONT> * &lt;filter&gt;<a name="line.58"></a> |
| <FONT color="green">059</FONT> * &lt;filter-name&gt;ShiroFilter&lt;/filter-name&gt;<a name="line.59"></a> |
| <FONT color="green">060</FONT> * &lt;filter-class&gt;org.apache.shiro.web.servlet.IniShiroFilter&lt;/filter-class&gt;<a name="line.60"></a> |
| <FONT color="green">061</FONT> * &lt;/filter&gt;<a name="line.61"></a> |
| <FONT color="green">062</FONT> * </pre><a name="line.62"></a> |
| <FONT color="green">063</FONT> * <h3>Custom Path</h3><a name="line.63"></a> |
| <FONT color="green">064</FONT> * If you want the INI configuration to be somewhere other than {@code /WEB-INF/shiro.ini} or<a name="line.64"></a> |
| <FONT color="green">065</FONT> * {@code classpath:shiro.ini}, you may specify an alternate location via the {@code configPath init-param}:<a name="line.65"></a> |
| <FONT color="green">066</FONT> * <pre><a name="line.66"></a> |
| <FONT color="green">067</FONT> * &lt;filter&gt;<a name="line.67"></a> |
| <FONT color="green">068</FONT> * &lt;filter-name&gt;ShiroFilter&lt;/filter-name&gt;<a name="line.68"></a> |
| <FONT color="green">069</FONT> * &lt;filter-class&gt;org.apache.shiro.web.servlet.IniShiroFilter&lt;/filter-class&gt;<a name="line.69"></a> |
| <FONT color="green">070</FONT> * &lt;init-param&gt;<a name="line.70"></a> |
| <FONT color="green">071</FONT> * &lt;param-name&gt;configPath&lt;/param-name&gt;<a name="line.71"></a> |
| <FONT color="green">072</FONT> * &lt;param-value&gt;/WEB-INF/someFile.ini&lt;/param-value&gt;<a name="line.72"></a> |
| <FONT color="green">073</FONT> * &lt;/init-param&gt;<a name="line.73"></a> |
| <FONT color="green">074</FONT> * &lt;/filter&gt;<a name="line.74"></a> |
| <FONT color="green">075</FONT> * </pre><a name="line.75"></a> |
| <FONT color="green">076</FONT> * Unqualified (schemeless or 'non-prefixed') paths are assumed to be {@code ServletContext} resource paths, resolvable<a name="line.76"></a> |
| <FONT color="green">077</FONT> * via {@link javax.servlet.ServletContext#getResourceAsStream(String) ServletContext#getResourceAsStream}.<a name="line.77"></a> |
| <FONT color="green">078</FONT> * <p/><a name="line.78"></a> |
| <FONT color="green">079</FONT> * Non-ServletContext resources may be loaded from qualified locations by specifying prefixes indicating the source,<a name="line.79"></a> |
| <FONT color="green">080</FONT> * e.g. {@code file:}, {@code url:}, and {@code classpath:}. See the<a name="line.80"></a> |
| <FONT color="green">081</FONT> * {@link ResourceUtils#getInputStreamForPath(String)} JavaDoc for more.<a name="line.81"></a> |
| <FONT color="green">082</FONT> * <h3>Inline</h3><a name="line.82"></a> |
| <FONT color="green">083</FONT> * For relatively simple environments, you can embed the INI config directly inside the filter declaration with<a name="line.83"></a> |
| <FONT color="green">084</FONT> * the {@code config init-param}:<a name="line.84"></a> |
| <FONT color="green">085</FONT> * <pre><a name="line.85"></a> |
| <FONT color="green">086</FONT> * &lt;filter&gt;<a name="line.86"></a> |
| <FONT color="green">087</FONT> * &lt;filter-name&gt;ShiroFilter&lt;/filter-name&gt;<a name="line.87"></a> |
| <FONT color="green">088</FONT> * &lt;filter-class&gt;org.apache.shiro.web.servlet.IniShiroFilter&lt;/filter-class&gt;<a name="line.88"></a> |
| <FONT color="green">089</FONT> * &lt;init-param&gt;<a name="line.89"></a> |
| <FONT color="green">090</FONT> * &lt;param-name&gt;config&lt;/param-name&gt;<a name="line.90"></a> |
| <FONT color="green">091</FONT> * &lt;param-value&gt;<a name="line.91"></a> |
| <FONT color="green">092</FONT> * #INI config goes here...<a name="line.92"></a> |
| <FONT color="green">093</FONT> * &lt;/param-value&gt;<a name="line.93"></a> |
| <FONT color="green">094</FONT> * &lt;/init-param&gt;<a name="line.94"></a> |
| <FONT color="green">095</FONT> * &lt;/filter&gt;<a name="line.95"></a> |
| <FONT color="green">096</FONT> * </pre><a name="line.96"></a> |
| <FONT color="green">097</FONT> * Although this is typically not recommended because any Shiro configuration changes would contribute to version control<a name="line.97"></a> |
| <FONT color="green">098</FONT> * 'noise' in the web.xml file.<a name="line.98"></a> |
| <FONT color="green">099</FONT> * <p/><a name="line.99"></a> |
| <FONT color="green">100</FONT> * When creating the shiro.ini configuration itself, please see Shiro's<a name="line.100"></a> |
| <FONT color="green">101</FONT> * <a href="http://shiro.apache.org/configuration.html">Configuration Documentation</a> and<a name="line.101"></a> |
| <FONT color="green">102</FONT> * <a href="http://shiro.apache.org/web.html">Web Documentation</a>.<a name="line.102"></a> |
| <FONT color="green">103</FONT> *<a name="line.103"></a> |
| <FONT color="green">104</FONT> * @see <a href="http://shiro.apache.org/configuration.html">Apache Shiro INI Configuration</a><a name="line.104"></a> |
| <FONT color="green">105</FONT> * @see <a href="http://shiro.apache.org/web.html">Apache Shiro Web Documentation</a><a name="line.105"></a> |
| <FONT color="green">106</FONT> * @since 1.0<a name="line.106"></a> |
| <FONT color="green">107</FONT> * @deprecated in 1.2 in favor of using the {@link ShiroFilter}<a name="line.107"></a> |
| <FONT color="green">108</FONT> */<a name="line.108"></a> |
| <FONT color="green">109</FONT> @Deprecated<a name="line.109"></a> |
| <FONT color="green">110</FONT> public class IniShiroFilter extends AbstractShiroFilter {<a name="line.110"></a> |
| <FONT color="green">111</FONT> <a name="line.111"></a> |
| <FONT color="green">112</FONT> public static final String CONFIG_INIT_PARAM_NAME = "config";<a name="line.112"></a> |
| <FONT color="green">113</FONT> public static final String CONFIG_PATH_INIT_PARAM_NAME = "configPath";<a name="line.113"></a> |
| <FONT color="green">114</FONT> <a name="line.114"></a> |
| <FONT color="green">115</FONT> public static final String DEFAULT_WEB_INI_RESOURCE_PATH = "/WEB-INF/shiro.ini";<a name="line.115"></a> |
| <FONT color="green">116</FONT> <a name="line.116"></a> |
| <FONT color="green">117</FONT> private static final Logger log = LoggerFactory.getLogger(IniShiroFilter.class);<a name="line.117"></a> |
| <FONT color="green">118</FONT> <a name="line.118"></a> |
| <FONT color="green">119</FONT> private String config;<a name="line.119"></a> |
| <FONT color="green">120</FONT> private String configPath;<a name="line.120"></a> |
| <FONT color="green">121</FONT> <a name="line.121"></a> |
| <FONT color="green">122</FONT> public IniShiroFilter() {<a name="line.122"></a> |
| <FONT color="green">123</FONT> }<a name="line.123"></a> |
| <FONT color="green">124</FONT> <a name="line.124"></a> |
| <FONT color="green">125</FONT> /**<a name="line.125"></a> |
| <FONT color="green">126</FONT> * Returns the actual INI configuration text to use to build the {@link SecurityManager} and<a name="line.126"></a> |
| <FONT color="green">127</FONT> * {@link FilterChainResolver} used by the web application or {@code null} if the<a name="line.127"></a> |
| <FONT color="green">128</FONT> * {@link #getConfigPath() configPath} should be used to load a fallback INI source.<a name="line.128"></a> |
| <FONT color="green">129</FONT> * <p/><a name="line.129"></a> |
| <FONT color="green">130</FONT> * This value is {@code null} by default, but it will be automatically set to the value of the<a name="line.130"></a> |
| <FONT color="green">131</FONT> * '{@code config}' {@code init-param} if it exists in the {@code FilterConfig} provided by the servlet<a name="line.131"></a> |
| <FONT color="green">132</FONT> * container at startup.<a name="line.132"></a> |
| <FONT color="green">133</FONT> *<a name="line.133"></a> |
| <FONT color="green">134</FONT> * @return the actual INI configuration text to use to build the {@link SecurityManager} and<a name="line.134"></a> |
| <FONT color="green">135</FONT> * {@link FilterChainResolver} used by the web application or {@code null} if the<a name="line.135"></a> |
| <FONT color="green">136</FONT> * {@link #getConfigPath() configPath} should be used to load a fallback INI source.<a name="line.136"></a> |
| <FONT color="green">137</FONT> */<a name="line.137"></a> |
| <FONT color="green">138</FONT> public String getConfig() {<a name="line.138"></a> |
| <FONT color="green">139</FONT> return this.config;<a name="line.139"></a> |
| <FONT color="green">140</FONT> }<a name="line.140"></a> |
| <FONT color="green">141</FONT> <a name="line.141"></a> |
| <FONT color="green">142</FONT> /**<a name="line.142"></a> |
| <FONT color="green">143</FONT> * Sets the actual INI configuration text to use to build the {@link SecurityManager} and<a name="line.143"></a> |
| <FONT color="green">144</FONT> * {@link FilterChainResolver} used by the web application. If this value is {@code null}, the<a name="line.144"></a> |
| <FONT color="green">145</FONT> * {@link #getConfigPath() configPath} will be checked to see if a .ini file should be loaded instead.<a name="line.145"></a> |
| <FONT color="green">146</FONT> * <p/><a name="line.146"></a> |
| <FONT color="green">147</FONT> * This value is {@code null} by default, but it will be automatically set to the value of the<a name="line.147"></a> |
| <FONT color="green">148</FONT> * '{@code config}' {@code init-param} if it exists in the {@code FilterConfig} provided by the servlet<a name="line.148"></a> |
| <FONT color="green">149</FONT> * container at startup.<a name="line.149"></a> |
| <FONT color="green">150</FONT> *<a name="line.150"></a> |
| <FONT color="green">151</FONT> * @param config the actual INI configuration text to use to build the {@link SecurityManager} and<a name="line.151"></a> |
| <FONT color="green">152</FONT> * {@link FilterChainResolver} used by the web application.<a name="line.152"></a> |
| <FONT color="green">153</FONT> */<a name="line.153"></a> |
| <FONT color="green">154</FONT> public void setConfig(String config) {<a name="line.154"></a> |
| <FONT color="green">155</FONT> this.config = config;<a name="line.155"></a> |
| <FONT color="green">156</FONT> }<a name="line.156"></a> |
| <FONT color="green">157</FONT> <a name="line.157"></a> |
| <FONT color="green">158</FONT> /**<a name="line.158"></a> |
| <FONT color="green">159</FONT> * Returns the config path to be used to load a .ini file for configuration if a configuration is<a name="line.159"></a> |
| <FONT color="green">160</FONT> * not specified via the {@link #getConfig() config} attribute.<a name="line.160"></a> |
| <FONT color="green">161</FONT> * <p/><a name="line.161"></a> |
| <FONT color="green">162</FONT> * This value is {@code null} by default, but it will be automatically set to the value of the<a name="line.162"></a> |
| <FONT color="green">163</FONT> * '{@code configPath}' {@code init-param} if it exists in the {@code FilterConfig} provided by the servlet<a name="line.163"></a> |
| <FONT color="green">164</FONT> * container at startup.<a name="line.164"></a> |
| <FONT color="green">165</FONT> *<a name="line.165"></a> |
| <FONT color="green">166</FONT> * @return the config path to be used to load a .ini file for configuration if a configuration is<a name="line.166"></a> |
| <FONT color="green">167</FONT> * not specified via the {@link #getConfig() config} attribute.<a name="line.167"></a> |
| <FONT color="green">168</FONT> */<a name="line.168"></a> |
| <FONT color="green">169</FONT> public String getConfigPath() {<a name="line.169"></a> |
| <FONT color="green">170</FONT> return configPath;<a name="line.170"></a> |
| <FONT color="green">171</FONT> }<a name="line.171"></a> |
| <FONT color="green">172</FONT> <a name="line.172"></a> |
| <FONT color="green">173</FONT> /**<a name="line.173"></a> |
| <FONT color="green">174</FONT> * Sets the config path to be used to load a .ini file for configuration if a configuration is<a name="line.174"></a> |
| <FONT color="green">175</FONT> * not specified via the {@link #getConfig() config} attribute.<a name="line.175"></a> |
| <FONT color="green">176</FONT> * <p/><a name="line.176"></a> |
| <FONT color="green">177</FONT> * This value is {@code null} by default, but it will be automatically set to the value of the<a name="line.177"></a> |
| <FONT color="green">178</FONT> * '{@code configPath}' {@code init-param} if it exists in the {@code FilterConfig} provided by the servlet<a name="line.178"></a> |
| <FONT color="green">179</FONT> * container at startup.<a name="line.179"></a> |
| <FONT color="green">180</FONT> *<a name="line.180"></a> |
| <FONT color="green">181</FONT> * @param configPath the config path to be used to load a .ini file for configuration if a configuration is<a name="line.181"></a> |
| <FONT color="green">182</FONT> * not specified via the {@link #getConfig() config} attribute.<a name="line.182"></a> |
| <FONT color="green">183</FONT> */<a name="line.183"></a> |
| <FONT color="green">184</FONT> public void setConfigPath(String configPath) {<a name="line.184"></a> |
| <FONT color="green">185</FONT> this.configPath = StringUtils.clean(configPath);<a name="line.185"></a> |
| <FONT color="green">186</FONT> }<a name="line.186"></a> |
| <FONT color="green">187</FONT> <a name="line.187"></a> |
| <FONT color="green">188</FONT> public void init() throws Exception {<a name="line.188"></a> |
| <FONT color="green">189</FONT> applyInitParams();<a name="line.189"></a> |
| <FONT color="green">190</FONT> configure();<a name="line.190"></a> |
| <FONT color="green">191</FONT> }<a name="line.191"></a> |
| <FONT color="green">192</FONT> <a name="line.192"></a> |
| <FONT color="green">193</FONT> protected void applyInitParams() throws Exception {<a name="line.193"></a> |
| <FONT color="green">194</FONT> String config = getInitParam(CONFIG_INIT_PARAM_NAME);<a name="line.194"></a> |
| <FONT color="green">195</FONT> if (config != null) {<a name="line.195"></a> |
| <FONT color="green">196</FONT> setConfig(config);<a name="line.196"></a> |
| <FONT color="green">197</FONT> }<a name="line.197"></a> |
| <FONT color="green">198</FONT> String configPath = getInitParam(CONFIG_PATH_INIT_PARAM_NAME);<a name="line.198"></a> |
| <FONT color="green">199</FONT> if (configPath != null) {<a name="line.199"></a> |
| <FONT color="green">200</FONT> setConfigPath(configPath);<a name="line.200"></a> |
| <FONT color="green">201</FONT> }<a name="line.201"></a> |
| <FONT color="green">202</FONT> }<a name="line.202"></a> |
| <FONT color="green">203</FONT> <a name="line.203"></a> |
| <FONT color="green">204</FONT> protected void configure() throws Exception {<a name="line.204"></a> |
| <FONT color="green">205</FONT> Ini ini = loadIniFromConfig();<a name="line.205"></a> |
| <FONT color="green">206</FONT> <a name="line.206"></a> |
| <FONT color="green">207</FONT> if (CollectionUtils.isEmpty(ini)) {<a name="line.207"></a> |
| <FONT color="green">208</FONT> log.info("Null or empty configuration specified via 'config' init-param. " +<a name="line.208"></a> |
| <FONT color="green">209</FONT> "Checking path-based configuration.");<a name="line.209"></a> |
| <FONT color="green">210</FONT> ini = loadIniFromPath();<a name="line.210"></a> |
| <FONT color="green">211</FONT> }<a name="line.211"></a> |
| <FONT color="green">212</FONT> //added for SHIRO-178:<a name="line.212"></a> |
| <FONT color="green">213</FONT> if (CollectionUtils.isEmpty(ini)) {<a name="line.213"></a> |
| <FONT color="green">214</FONT> log.info("Null or empty configuration specified via '" + CONFIG_INIT_PARAM_NAME + "' or '" +<a name="line.214"></a> |
| <FONT color="green">215</FONT> CONFIG_PATH_INIT_PARAM_NAME + "' filter parameters. Trying the default " +<a name="line.215"></a> |
| <FONT color="green">216</FONT> DEFAULT_WEB_INI_RESOURCE_PATH + " file.");<a name="line.216"></a> |
| <FONT color="green">217</FONT> ini = getServletContextIniResource(DEFAULT_WEB_INI_RESOURCE_PATH);<a name="line.217"></a> |
| <FONT color="green">218</FONT> }<a name="line.218"></a> |
| <FONT color="green">219</FONT> //although the preferred default is /WEB-INF/shiro.ini per SHIRO-178, keep this<a name="line.219"></a> |
| <FONT color="green">220</FONT> //for backwards compatibility:<a name="line.220"></a> |
| <FONT color="green">221</FONT> if (CollectionUtils.isEmpty(ini)) {<a name="line.221"></a> |
| <FONT color="green">222</FONT> log.info("Null or empty configuration specified via '" + CONFIG_INIT_PARAM_NAME + "' or '" +<a name="line.222"></a> |
| <FONT color="green">223</FONT> CONFIG_PATH_INIT_PARAM_NAME + "' filter parameters. Trying the default " +<a name="line.223"></a> |
| <FONT color="green">224</FONT> IniFactorySupport.DEFAULT_INI_RESOURCE_PATH + " file.");<a name="line.224"></a> |
| <FONT color="green">225</FONT> ini = IniFactorySupport.loadDefaultClassPathIni();<a name="line.225"></a> |
| <FONT color="green">226</FONT> }<a name="line.226"></a> |
| <FONT color="green">227</FONT> <a name="line.227"></a> |
| <FONT color="green">228</FONT> Map<String, ?> objects = applySecurityManager(ini);<a name="line.228"></a> |
| <FONT color="green">229</FONT> applyFilterChainResolver(ini, objects);<a name="line.229"></a> |
| <FONT color="green">230</FONT> }<a name="line.230"></a> |
| <FONT color="green">231</FONT> <a name="line.231"></a> |
| <FONT color="green">232</FONT> protected Ini loadIniFromConfig() {<a name="line.232"></a> |
| <FONT color="green">233</FONT> Ini ini = null;<a name="line.233"></a> |
| <FONT color="green">234</FONT> String config = getConfig();<a name="line.234"></a> |
| <FONT color="green">235</FONT> if (config != null) {<a name="line.235"></a> |
| <FONT color="green">236</FONT> ini = convertConfigToIni(config);<a name="line.236"></a> |
| <FONT color="green">237</FONT> }<a name="line.237"></a> |
| <FONT color="green">238</FONT> return ini;<a name="line.238"></a> |
| <FONT color="green">239</FONT> }<a name="line.239"></a> |
| <FONT color="green">240</FONT> <a name="line.240"></a> |
| <FONT color="green">241</FONT> protected Ini loadIniFromPath() {<a name="line.241"></a> |
| <FONT color="green">242</FONT> Ini ini = null;<a name="line.242"></a> |
| <FONT color="green">243</FONT> String path = getConfigPath();<a name="line.243"></a> |
| <FONT color="green">244</FONT> if (path != null) {<a name="line.244"></a> |
| <FONT color="green">245</FONT> ini = convertPathToIni(path);<a name="line.245"></a> |
| <FONT color="green">246</FONT> }<a name="line.246"></a> |
| <FONT color="green">247</FONT> return ini;<a name="line.247"></a> |
| <FONT color="green">248</FONT> }<a name="line.248"></a> |
| <FONT color="green">249</FONT> <a name="line.249"></a> |
| <FONT color="green">250</FONT> protected Map<String, ?> applySecurityManager(Ini ini) {<a name="line.250"></a> |
| <FONT color="green">251</FONT> WebIniSecurityManagerFactory factory;<a name="line.251"></a> |
| <FONT color="green">252</FONT> if (CollectionUtils.isEmpty(ini)) {<a name="line.252"></a> |
| <FONT color="green">253</FONT> factory = new WebIniSecurityManagerFactory();<a name="line.253"></a> |
| <FONT color="green">254</FONT> } else {<a name="line.254"></a> |
| <FONT color="green">255</FONT> factory = new WebIniSecurityManagerFactory(ini);<a name="line.255"></a> |
| <FONT color="green">256</FONT> }<a name="line.256"></a> |
| <FONT color="green">257</FONT> <a name="line.257"></a> |
| <FONT color="green">258</FONT> // Create the security manager and check that it implements WebSecurityManager.<a name="line.258"></a> |
| <FONT color="green">259</FONT> // Otherwise, it can't be used with the filter.<a name="line.259"></a> |
| <FONT color="green">260</FONT> SecurityManager securityManager = factory.getInstance();<a name="line.260"></a> |
| <FONT color="green">261</FONT> if (!(securityManager instanceof WebSecurityManager)) {<a name="line.261"></a> |
| <FONT color="green">262</FONT> String msg = "The configured security manager is not an instance of WebSecurityManager, so " +<a name="line.262"></a> |
| <FONT color="green">263</FONT> "it can not be used with the Shiro servlet filter.";<a name="line.263"></a> |
| <FONT color="green">264</FONT> throw new ConfigurationException(msg);<a name="line.264"></a> |
| <FONT color="green">265</FONT> }<a name="line.265"></a> |
| <FONT color="green">266</FONT> <a name="line.266"></a> |
| <FONT color="green">267</FONT> setSecurityManager((WebSecurityManager) securityManager);<a name="line.267"></a> |
| <FONT color="green">268</FONT> <a name="line.268"></a> |
| <FONT color="green">269</FONT> return factory.getBeans();<a name="line.269"></a> |
| <FONT color="green">270</FONT> }<a name="line.270"></a> |
| <FONT color="green">271</FONT> <a name="line.271"></a> |
| <FONT color="green">272</FONT> protected void applyFilterChainResolver(Ini ini, Map<String, ?> defaults) {<a name="line.272"></a> |
| <FONT color="green">273</FONT> if (ini == null || ini.isEmpty()) {<a name="line.273"></a> |
| <FONT color="green">274</FONT> //nothing to use to create the resolver, just return<a name="line.274"></a> |
| <FONT color="green">275</FONT> //(the AbstractShiroFilter allows a null resolver, in which case the original FilterChain is<a name="line.275"></a> |
| <FONT color="green">276</FONT> // always used).<a name="line.276"></a> |
| <FONT color="green">277</FONT> return;<a name="line.277"></a> |
| <FONT color="green">278</FONT> }<a name="line.278"></a> |
| <FONT color="green">279</FONT> <a name="line.279"></a> |
| <FONT color="green">280</FONT> //only create a resolver if the 'filters' or 'urls' sections are defined:<a name="line.280"></a> |
| <FONT color="green">281</FONT> Ini.Section urls = ini.getSection(IniFilterChainResolverFactory.URLS);<a name="line.281"></a> |
| <FONT color="green">282</FONT> Ini.Section filters = ini.getSection(IniFilterChainResolverFactory.FILTERS);<a name="line.282"></a> |
| <FONT color="green">283</FONT> if ((urls != null && !urls.isEmpty()) || (filters != null && !filters.isEmpty())) {<a name="line.283"></a> |
| <FONT color="green">284</FONT> //either the urls section or the filters section was defined. Go ahead and create the resolver<a name="line.284"></a> |
| <FONT color="green">285</FONT> //and set it:<a name="line.285"></a> |
| <FONT color="green">286</FONT> IniFilterChainResolverFactory filterChainResolverFactory = new IniFilterChainResolverFactory(ini, defaults);<a name="line.286"></a> |
| <FONT color="green">287</FONT> filterChainResolverFactory.setFilterConfig(getFilterConfig());<a name="line.287"></a> |
| <FONT color="green">288</FONT> FilterChainResolver resolver = filterChainResolverFactory.getInstance();<a name="line.288"></a> |
| <FONT color="green">289</FONT> setFilterChainResolver(resolver);<a name="line.289"></a> |
| <FONT color="green">290</FONT> }<a name="line.290"></a> |
| <FONT color="green">291</FONT> }<a name="line.291"></a> |
| <FONT color="green">292</FONT> <a name="line.292"></a> |
| <FONT color="green">293</FONT> protected Ini convertConfigToIni(String config) {<a name="line.293"></a> |
| <FONT color="green">294</FONT> Ini ini = new Ini();<a name="line.294"></a> |
| <FONT color="green">295</FONT> ini.load(config);<a name="line.295"></a> |
| <FONT color="green">296</FONT> return ini;<a name="line.296"></a> |
| <FONT color="green">297</FONT> }<a name="line.297"></a> |
| <FONT color="green">298</FONT> <a name="line.298"></a> |
| <FONT color="green">299</FONT> /**<a name="line.299"></a> |
| <FONT color="green">300</FONT> * Returns the INI instance reflecting the specified servlet context resource path or {@code null} if no<a name="line.300"></a> |
| <FONT color="green">301</FONT> * resource was found.<a name="line.301"></a> |
| <FONT color="green">302</FONT> *<a name="line.302"></a> |
| <FONT color="green">303</FONT> * @param servletContextPath the servlet context resource path of the INI file to load<a name="line.303"></a> |
| <FONT color="green">304</FONT> * @return the INI instance reflecting the specified servlet context resource path or {@code null} if no<a name="line.304"></a> |
| <FONT color="green">305</FONT> * resource was found.<a name="line.305"></a> |
| <FONT color="green">306</FONT> * @since 1.2<a name="line.306"></a> |
| <FONT color="green">307</FONT> */<a name="line.307"></a> |
| <FONT color="green">308</FONT> protected Ini getServletContextIniResource(String servletContextPath) {<a name="line.308"></a> |
| <FONT color="green">309</FONT> String path = WebUtils.normalize(servletContextPath);<a name="line.309"></a> |
| <FONT color="green">310</FONT> if (getServletContext() != null) {<a name="line.310"></a> |
| <FONT color="green">311</FONT> InputStream is = getServletContext().getResourceAsStream(path);<a name="line.311"></a> |
| <FONT color="green">312</FONT> if (is != null) {<a name="line.312"></a> |
| <FONT color="green">313</FONT> Ini ini = new Ini();<a name="line.313"></a> |
| <FONT color="green">314</FONT> ini.load(is);<a name="line.314"></a> |
| <FONT color="green">315</FONT> if (CollectionUtils.isEmpty(ini)) {<a name="line.315"></a> |
| <FONT color="green">316</FONT> log.warn("ServletContext INI resource '" + servletContextPath + "' exists, but it did not contain " +<a name="line.316"></a> |
| <FONT color="green">317</FONT> "any data.");<a name="line.317"></a> |
| <FONT color="green">318</FONT> }<a name="line.318"></a> |
| <FONT color="green">319</FONT> return ini;<a name="line.319"></a> |
| <FONT color="green">320</FONT> }<a name="line.320"></a> |
| <FONT color="green">321</FONT> }<a name="line.321"></a> |
| <FONT color="green">322</FONT> return null;<a name="line.322"></a> |
| <FONT color="green">323</FONT> }<a name="line.323"></a> |
| <FONT color="green">324</FONT> <a name="line.324"></a> |
| <FONT color="green">325</FONT> /**<a name="line.325"></a> |
| <FONT color="green">326</FONT> * Converts the specified file path to an {@link Ini} instance.<a name="line.326"></a> |
| <FONT color="green">327</FONT> * <p/><a name="line.327"></a> |
| <FONT color="green">328</FONT> * If the path does not have a resource prefix as defined by {@link ResourceUtils#hasResourcePrefix(String)}, the<a name="line.328"></a> |
| <FONT color="green">329</FONT> * path is expected to be resolvable by the {@code ServletContext} via<a name="line.329"></a> |
| <FONT color="green">330</FONT> * {@link javax.servlet.ServletContext#getResourceAsStream(String)}.<a name="line.330"></a> |
| <FONT color="green">331</FONT> *<a name="line.331"></a> |
| <FONT color="green">332</FONT> * @param path the path of the INI resource to load into an INI instance.<a name="line.332"></a> |
| <FONT color="green">333</FONT> * @return an INI instance populated based on the given INI resource path.<a name="line.333"></a> |
| <FONT color="green">334</FONT> */<a name="line.334"></a> |
| <FONT color="green">335</FONT> protected Ini convertPathToIni(String path) {<a name="line.335"></a> |
| <FONT color="green">336</FONT> <a name="line.336"></a> |
| <FONT color="green">337</FONT> Ini ini = new Ini();<a name="line.337"></a> |
| <FONT color="green">338</FONT> <a name="line.338"></a> |
| <FONT color="green">339</FONT> //SHIRO-178: Check for servlet context resource and not<a name="line.339"></a> |
| <FONT color="green">340</FONT> //only resource paths:<a name="line.340"></a> |
| <FONT color="green">341</FONT> if (!ResourceUtils.hasResourcePrefix(path)) {<a name="line.341"></a> |
| <FONT color="green">342</FONT> ini = getServletContextIniResource(path);<a name="line.342"></a> |
| <FONT color="green">343</FONT> if (ini == null) {<a name="line.343"></a> |
| <FONT color="green">344</FONT> String msg = "There is no servlet context resource corresponding to configPath '" + path + "' If " +<a name="line.344"></a> |
| <FONT color="green">345</FONT> "the resource is located elsewhere (not immediately resolveable in the servlet context), " +<a name="line.345"></a> |
| <FONT color="green">346</FONT> "specify an appropriate classpath:, url:, or file: resource prefix accordingly.";<a name="line.346"></a> |
| <FONT color="green">347</FONT> throw new ConfigurationException(msg);<a name="line.347"></a> |
| <FONT color="green">348</FONT> }<a name="line.348"></a> |
| <FONT color="green">349</FONT> } else {<a name="line.349"></a> |
| <FONT color="green">350</FONT> //normal resource path - load as usual:<a name="line.350"></a> |
| <FONT color="green">351</FONT> ini.loadFromPath(path);<a name="line.351"></a> |
| <FONT color="green">352</FONT> }<a name="line.352"></a> |
| <FONT color="green">353</FONT> <a name="line.353"></a> |
| <FONT color="green">354</FONT> return ini;<a name="line.354"></a> |
| <FONT color="green">355</FONT> }<a name="line.355"></a> |
| <FONT color="green">356</FONT> }<a name="line.356"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
