| <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.config;<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.Ini;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.config.IniFactorySupport;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.config.IniSecurityManagerFactory;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.config.ReflectionBuilder;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.util.CollectionUtils;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.util.Factory;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.shiro.web.filter.mgt.FilterChainManager;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.apache.shiro.web.filter.mgt.FilterChainResolver;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.apache.shiro.web.filter.mgt.PathMatchingFilterChainResolver;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import org.slf4j.Logger;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import org.slf4j.LoggerFactory;<a name="line.31"></a> |
| <FONT color="green">032</FONT> <a name="line.32"></a> |
| <FONT color="green">033</FONT> import javax.servlet.Filter;<a name="line.33"></a> |
| <FONT color="green">034</FONT> import javax.servlet.FilterConfig;<a name="line.34"></a> |
| <FONT color="green">035</FONT> import java.util.LinkedHashMap;<a name="line.35"></a> |
| <FONT color="green">036</FONT> import java.util.Map;<a name="line.36"></a> |
| <FONT color="green">037</FONT> <a name="line.37"></a> |
| <FONT color="green">038</FONT> /**<a name="line.38"></a> |
| <FONT color="green">039</FONT> * A {@link Factory} that creates {@link FilterChainResolver} instances based on {@link Ini} configuration.<a name="line.39"></a> |
| <FONT color="green">040</FONT> *<a name="line.40"></a> |
| <FONT color="green">041</FONT> * @since 1.0<a name="line.41"></a> |
| <FONT color="green">042</FONT> */<a name="line.42"></a> |
| <FONT color="green">043</FONT> public class IniFilterChainResolverFactory extends IniFactorySupport<FilterChainResolver> {<a name="line.43"></a> |
| <FONT color="green">044</FONT> <a name="line.44"></a> |
| <FONT color="green">045</FONT> public static final String FILTERS = "filters";<a name="line.45"></a> |
| <FONT color="green">046</FONT> public static final String URLS = "urls";<a name="line.46"></a> |
| <FONT color="green">047</FONT> <a name="line.47"></a> |
| <FONT color="green">048</FONT> private static transient final Logger log = LoggerFactory.getLogger(IniFilterChainResolverFactory.class);<a name="line.48"></a> |
| <FONT color="green">049</FONT> <a name="line.49"></a> |
| <FONT color="green">050</FONT> private FilterConfig filterConfig;<a name="line.50"></a> |
| <FONT color="green">051</FONT> <a name="line.51"></a> |
| <FONT color="green">052</FONT> private Map<String, ?> defaultBeans;<a name="line.52"></a> |
| <FONT color="green">053</FONT> <a name="line.53"></a> |
| <FONT color="green">054</FONT> public IniFilterChainResolverFactory() {<a name="line.54"></a> |
| <FONT color="green">055</FONT> super();<a name="line.55"></a> |
| <FONT color="green">056</FONT> }<a name="line.56"></a> |
| <FONT color="green">057</FONT> <a name="line.57"></a> |
| <FONT color="green">058</FONT> public IniFilterChainResolverFactory(Ini ini) {<a name="line.58"></a> |
| <FONT color="green">059</FONT> super(ini);<a name="line.59"></a> |
| <FONT color="green">060</FONT> }<a name="line.60"></a> |
| <FONT color="green">061</FONT> <a name="line.61"></a> |
| <FONT color="green">062</FONT> public IniFilterChainResolverFactory(Ini ini, Map<String, ?> defaultBeans) {<a name="line.62"></a> |
| <FONT color="green">063</FONT> this(ini);<a name="line.63"></a> |
| <FONT color="green">064</FONT> this.defaultBeans = defaultBeans;<a name="line.64"></a> |
| <FONT color="green">065</FONT> }<a name="line.65"></a> |
| <FONT color="green">066</FONT> <a name="line.66"></a> |
| <FONT color="green">067</FONT> public FilterConfig getFilterConfig() {<a name="line.67"></a> |
| <FONT color="green">068</FONT> return filterConfig;<a name="line.68"></a> |
| <FONT color="green">069</FONT> }<a name="line.69"></a> |
| <FONT color="green">070</FONT> <a name="line.70"></a> |
| <FONT color="green">071</FONT> public void setFilterConfig(FilterConfig filterConfig) {<a name="line.71"></a> |
| <FONT color="green">072</FONT> this.filterConfig = filterConfig;<a name="line.72"></a> |
| <FONT color="green">073</FONT> }<a name="line.73"></a> |
| <FONT color="green">074</FONT> <a name="line.74"></a> |
| <FONT color="green">075</FONT> protected FilterChainResolver createInstance(Ini ini) {<a name="line.75"></a> |
| <FONT color="green">076</FONT> FilterChainResolver filterChainResolver = createDefaultInstance();<a name="line.76"></a> |
| <FONT color="green">077</FONT> if (filterChainResolver instanceof PathMatchingFilterChainResolver) {<a name="line.77"></a> |
| <FONT color="green">078</FONT> PathMatchingFilterChainResolver resolver = (PathMatchingFilterChainResolver) filterChainResolver;<a name="line.78"></a> |
| <FONT color="green">079</FONT> FilterChainManager manager = resolver.getFilterChainManager();<a name="line.79"></a> |
| <FONT color="green">080</FONT> buildChains(manager, ini);<a name="line.80"></a> |
| <FONT color="green">081</FONT> }<a name="line.81"></a> |
| <FONT color="green">082</FONT> return filterChainResolver;<a name="line.82"></a> |
| <FONT color="green">083</FONT> }<a name="line.83"></a> |
| <FONT color="green">084</FONT> <a name="line.84"></a> |
| <FONT color="green">085</FONT> protected FilterChainResolver createDefaultInstance() {<a name="line.85"></a> |
| <FONT color="green">086</FONT> FilterConfig filterConfig = getFilterConfig();<a name="line.86"></a> |
| <FONT color="green">087</FONT> if (filterConfig != null) {<a name="line.87"></a> |
| <FONT color="green">088</FONT> return new PathMatchingFilterChainResolver(filterConfig);<a name="line.88"></a> |
| <FONT color="green">089</FONT> } else {<a name="line.89"></a> |
| <FONT color="green">090</FONT> return new PathMatchingFilterChainResolver();<a name="line.90"></a> |
| <FONT color="green">091</FONT> }<a name="line.91"></a> |
| <FONT color="green">092</FONT> }<a name="line.92"></a> |
| <FONT color="green">093</FONT> <a name="line.93"></a> |
| <FONT color="green">094</FONT> protected void buildChains(FilterChainManager manager, Ini ini) {<a name="line.94"></a> |
| <FONT color="green">095</FONT> //filters section:<a name="line.95"></a> |
| <FONT color="green">096</FONT> Ini.Section section = ini.getSection(FILTERS);<a name="line.96"></a> |
| <FONT color="green">097</FONT> <a name="line.97"></a> |
| <FONT color="green">098</FONT> if (!CollectionUtils.isEmpty(section)) {<a name="line.98"></a> |
| <FONT color="green">099</FONT> String msg = "The [{}] section has been deprecated and will be removed in a future release! Please " +<a name="line.99"></a> |
| <FONT color="green">100</FONT> "move all object configuration (filters and all other objects) to the [{}] section.";<a name="line.100"></a> |
| <FONT color="green">101</FONT> log.warn(msg, FILTERS, IniSecurityManagerFactory.MAIN_SECTION_NAME);<a name="line.101"></a> |
| <FONT color="green">102</FONT> }<a name="line.102"></a> |
| <FONT color="green">103</FONT> <a name="line.103"></a> |
| <FONT color="green">104</FONT> Map<String, Object> defaults = new LinkedHashMap<String, Object>();<a name="line.104"></a> |
| <FONT color="green">105</FONT> <a name="line.105"></a> |
| <FONT color="green">106</FONT> Map<String, Filter> defaultFilters = manager.getFilters();<a name="line.106"></a> |
| <FONT color="green">107</FONT> <a name="line.107"></a> |
| <FONT color="green">108</FONT> //now let's see if there are any object defaults in addition to the filters<a name="line.108"></a> |
| <FONT color="green">109</FONT> //these can be used to configure the filters:<a name="line.109"></a> |
| <FONT color="green">110</FONT> //create a Map of objects to use as the defaults:<a name="line.110"></a> |
| <FONT color="green">111</FONT> if (!CollectionUtils.isEmpty(defaultFilters)) {<a name="line.111"></a> |
| <FONT color="green">112</FONT> defaults.putAll(defaultFilters);<a name="line.112"></a> |
| <FONT color="green">113</FONT> }<a name="line.113"></a> |
| <FONT color="green">114</FONT> //User-provided objects must come _after_ the default filters - to allow the user-provided<a name="line.114"></a> |
| <FONT color="green">115</FONT> //ones to override the default filters if necessary.<a name="line.115"></a> |
| <FONT color="green">116</FONT> if (!CollectionUtils.isEmpty(this.defaultBeans)) {<a name="line.116"></a> |
| <FONT color="green">117</FONT> defaults.putAll(this.defaultBeans);<a name="line.117"></a> |
| <FONT color="green">118</FONT> }<a name="line.118"></a> |
| <FONT color="green">119</FONT> <a name="line.119"></a> |
| <FONT color="green">120</FONT> Map<String, Filter> filters = getFilters(section, defaults);<a name="line.120"></a> |
| <FONT color="green">121</FONT> <a name="line.121"></a> |
| <FONT color="green">122</FONT> //add the filters to the manager:<a name="line.122"></a> |
| <FONT color="green">123</FONT> registerFilters(filters, manager);<a name="line.123"></a> |
| <FONT color="green">124</FONT> <a name="line.124"></a> |
| <FONT color="green">125</FONT> //urls section:<a name="line.125"></a> |
| <FONT color="green">126</FONT> section = ini.getSection(URLS);<a name="line.126"></a> |
| <FONT color="green">127</FONT> createChains(section, manager);<a name="line.127"></a> |
| <FONT color="green">128</FONT> }<a name="line.128"></a> |
| <FONT color="green">129</FONT> <a name="line.129"></a> |
| <FONT color="green">130</FONT> protected void registerFilters(Map<String, Filter> filters, FilterChainManager manager) {<a name="line.130"></a> |
| <FONT color="green">131</FONT> if (!CollectionUtils.isEmpty(filters)) {<a name="line.131"></a> |
| <FONT color="green">132</FONT> boolean init = getFilterConfig() != null; //only call filter.init if there is a FilterConfig available<a name="line.132"></a> |
| <FONT color="green">133</FONT> for (Map.Entry<String, Filter> entry : filters.entrySet()) {<a name="line.133"></a> |
| <FONT color="green">134</FONT> String name = entry.getKey();<a name="line.134"></a> |
| <FONT color="green">135</FONT> Filter filter = entry.getValue();<a name="line.135"></a> |
| <FONT color="green">136</FONT> manager.addFilter(name, filter, init);<a name="line.136"></a> |
| <FONT color="green">137</FONT> }<a name="line.137"></a> |
| <FONT color="green">138</FONT> }<a name="line.138"></a> |
| <FONT color="green">139</FONT> }<a name="line.139"></a> |
| <FONT color="green">140</FONT> <a name="line.140"></a> |
| <FONT color="green">141</FONT> protected Map<String, Filter> getFilters(Map<String, String> section, Map<String, ?> defaults) {<a name="line.141"></a> |
| <FONT color="green">142</FONT> <a name="line.142"></a> |
| <FONT color="green">143</FONT> Map<String, Filter> filters = extractFilters(defaults);<a name="line.143"></a> |
| <FONT color="green">144</FONT> <a name="line.144"></a> |
| <FONT color="green">145</FONT> if (!CollectionUtils.isEmpty(section)) {<a name="line.145"></a> |
| <FONT color="green">146</FONT> ReflectionBuilder builder = new ReflectionBuilder(defaults);<a name="line.146"></a> |
| <FONT color="green">147</FONT> Map<String, ?> built = builder.buildObjects(section);<a name="line.147"></a> |
| <FONT color="green">148</FONT> Map<String,Filter> sectionFilters = extractFilters(built);<a name="line.148"></a> |
| <FONT color="green">149</FONT> <a name="line.149"></a> |
| <FONT color="green">150</FONT> if (CollectionUtils.isEmpty(filters)) {<a name="line.150"></a> |
| <FONT color="green">151</FONT> filters = sectionFilters;<a name="line.151"></a> |
| <FONT color="green">152</FONT> } else {<a name="line.152"></a> |
| <FONT color="green">153</FONT> if (!CollectionUtils.isEmpty(sectionFilters)) {<a name="line.153"></a> |
| <FONT color="green">154</FONT> filters.putAll(sectionFilters);<a name="line.154"></a> |
| <FONT color="green">155</FONT> }<a name="line.155"></a> |
| <FONT color="green">156</FONT> }<a name="line.156"></a> |
| <FONT color="green">157</FONT> }<a name="line.157"></a> |
| <FONT color="green">158</FONT> <a name="line.158"></a> |
| <FONT color="green">159</FONT> return filters;<a name="line.159"></a> |
| <FONT color="green">160</FONT> }<a name="line.160"></a> |
| <FONT color="green">161</FONT> <a name="line.161"></a> |
| <FONT color="green">162</FONT> private Map<String, Filter> extractFilters(Map<String, ?> objects) {<a name="line.162"></a> |
| <FONT color="green">163</FONT> if (CollectionUtils.isEmpty(objects)) {<a name="line.163"></a> |
| <FONT color="green">164</FONT> return null;<a name="line.164"></a> |
| <FONT color="green">165</FONT> }<a name="line.165"></a> |
| <FONT color="green">166</FONT> Map<String, Filter> filterMap = new LinkedHashMap<String, Filter>();<a name="line.166"></a> |
| <FONT color="green">167</FONT> for (Map.Entry<String, ?> entry : objects.entrySet()) {<a name="line.167"></a> |
| <FONT color="green">168</FONT> String key = entry.getKey();<a name="line.168"></a> |
| <FONT color="green">169</FONT> Object value = entry.getValue();<a name="line.169"></a> |
| <FONT color="green">170</FONT> if (value instanceof Filter) {<a name="line.170"></a> |
| <FONT color="green">171</FONT> filterMap.put(key, (Filter) value);<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> return filterMap;<a name="line.174"></a> |
| <FONT color="green">175</FONT> }<a name="line.175"></a> |
| <FONT color="green">176</FONT> <a name="line.176"></a> |
| <FONT color="green">177</FONT> protected void createChains(Map<String, String> urls, FilterChainManager manager) {<a name="line.177"></a> |
| <FONT color="green">178</FONT> if (CollectionUtils.isEmpty(urls)) {<a name="line.178"></a> |
| <FONT color="green">179</FONT> if (log.isDebugEnabled()) {<a name="line.179"></a> |
| <FONT color="green">180</FONT> log.debug("No urls to process.");<a name="line.180"></a> |
| <FONT color="green">181</FONT> }<a name="line.181"></a> |
| <FONT color="green">182</FONT> return;<a name="line.182"></a> |
| <FONT color="green">183</FONT> }<a name="line.183"></a> |
| <FONT color="green">184</FONT> <a name="line.184"></a> |
| <FONT color="green">185</FONT> if (log.isTraceEnabled()) {<a name="line.185"></a> |
| <FONT color="green">186</FONT> log.trace("Before url processing.");<a name="line.186"></a> |
| <FONT color="green">187</FONT> }<a name="line.187"></a> |
| <FONT color="green">188</FONT> <a name="line.188"></a> |
| <FONT color="green">189</FONT> for (Map.Entry<String, String> entry : urls.entrySet()) {<a name="line.189"></a> |
| <FONT color="green">190</FONT> String path = entry.getKey();<a name="line.190"></a> |
| <FONT color="green">191</FONT> String value = entry.getValue();<a name="line.191"></a> |
| <FONT color="green">192</FONT> manager.createChain(path, value);<a name="line.192"></a> |
| <FONT color="green">193</FONT> }<a name="line.193"></a> |
| <FONT color="green">194</FONT> }<a name="line.194"></a> |
| <FONT color="green">195</FONT> }<a name="line.195"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
