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