| <!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.filter.mgt;<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.util.CollectionUtils;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.util.Nameable;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.util.StringUtils;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.web.filter.PathConfigProcessor;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.slf4j.Logger;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.slf4j.LoggerFactory;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import javax.servlet.Filter;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import javax.servlet.FilterChain;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import javax.servlet.FilterConfig;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import javax.servlet.ServletException;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.Collections;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import java.util.LinkedHashMap;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import java.util.Map;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import java.util.Set;<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> * Default {@link FilterChainManager} implementation maintaining a map of {@link Filter Filter} instances<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * (key: filter name, value: Filter) as well as a map of {@link NamedFilterList NamedFilterList}s created from these<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * {@code Filter}s (key: filter chain name, value: NamedFilterList). The {@code NamedFilterList} is essentially a<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * {@link FilterChain} that also has a name property by which it can be looked up.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> *<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @see NamedFilterList<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * @since 1.0<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>public class DefaultFilterChainManager implements FilterChainManager {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private static transient final Logger log = LoggerFactory.getLogger(DefaultFilterChainManager.class);<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> private FilterConfig filterConfig;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private Map<String, Filter> filters; //pool of filters available for creating chains<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private Map<String, NamedFilterList> filterChains; //key: chain name, value: chain<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> public DefaultFilterChainManager() {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> this.filters = new LinkedHashMap<String, Filter>();<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> this.filterChains = new LinkedHashMap<String, NamedFilterList>();<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> addDefaultFilters(false);<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> public DefaultFilterChainManager(FilterConfig filterConfig) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> this.filters = new LinkedHashMap<String, Filter>();<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> this.filterChains = new LinkedHashMap<String, NamedFilterList>();<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> setFilterConfig(filterConfig);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> addDefaultFilters(true);<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<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> * Returns the {@code FilterConfig} provided by the Servlet container at webapp startup.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> *<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @return the {@code FilterConfig} provided by the Servlet container at webapp startup.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> public FilterConfig getFilterConfig() {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> return filterConfig;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> }<a name="line.77"></a> |
| <span class="sourceLineNo">078</span><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> /**<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * Sets the {@code FilterConfig} provided by the Servlet container at webapp startup.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> *<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param filterConfig the {@code FilterConfig} provided by the Servlet container at webapp startup.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> public void setFilterConfig(FilterConfig filterConfig) {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> this.filterConfig = filterConfig;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> public Map<String, Filter> getFilters() {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> return filters;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> public void setFilters(Map<String, Filter> filters) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> this.filters = filters;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> public Map<String, NamedFilterList> getFilterChains() {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> return filterChains;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> public void setFilterChains(Map<String, NamedFilterList> filterChains) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> this.filterChains = filterChains;<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> }<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> public Filter getFilter(String name) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return this.filters.get(name);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> public void addFilter(String name, Filter filter) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> addFilter(name, filter, false);<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> public void addFilter(String name, Filter filter, boolean init) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> addFilter(name, filter, init, true);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> }<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> public void createChain(String chainName, String chainDefinition) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> if (!StringUtils.hasText(chainName)) {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> throw new NullPointerException("chainName cannot be null or empty.");<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> if (!StringUtils.hasText(chainDefinition)) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> throw new NullPointerException("chainDefinition cannot be null or empty.");<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> }<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> if (log.isDebugEnabled()) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> log.debug("Creating chain [" + chainName + "] from String definition [" + chainDefinition + "]");<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> //parse the value by tokenizing it to get the resulting filter-specific config entries<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> //<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> //e.g. for a value of<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> //<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> // "authc, roles[admin,user], perms[file:edit]"<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> //<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> // the resulting token array would equal<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> //<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> // { "authc", "roles[admin,user]", "perms[file:edit]" }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> //<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> String[] filterTokens = splitChainDefinition(chainDefinition);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> //each token is specific to each filter.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> //strip the name and extract any filter-specific config between brackets [ ]<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> for (String token : filterTokens) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> String[] nameConfigPair = toNameConfigPair(token);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> //now we have the filter name, path and (possibly null) path-specific config. Let's apply them:<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> addToChain(chainName, nameConfigPair[0], nameConfigPair[1]);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> /**<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * Splits the comma-delimited filter chain definition line into individual filter definition tokens.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * <p/><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * Example Input:<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * <pre><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * foo, bar[baz], blah[x, y]<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * </pre><a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * Resulting Output:<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * <pre><a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * output[0] == foo<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * output[1] == bar[baz]<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * output[2] == blah[x, y]<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * </pre><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * @param chainDefinition the comma-delimited filter chain definition.<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @return an array of filter definition tokens<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * @since 1.2<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @see <a href="https://issues.apache.org/jira/browse/SHIRO-205">SHIRO-205</a><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> */<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> protected String[] splitChainDefinition(String chainDefinition) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> return StringUtils.split(chainDefinition, StringUtils.DEFAULT_DELIMITER_CHAR, '[', ']', true, true);<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> /**<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * Based on the given filter chain definition token (e.g. 'foo' or 'foo[bar, baz]'), this will return the token<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * as a name/value pair, removing any brackets as necessary. Examples:<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * <table><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * <tr><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * <th>Input</th><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * <th>Result</th><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * </tr><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * <tr><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * <td>{@code foo}</td><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * <td>returned[0] == {@code foo}<br/>returned[1] == {@code null}</td><a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * </tr><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * <tr><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * <td>{@code foo[bar, baz]}</td><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * <td>returned[0] == {@code foo}<br/>returned[1] == {@code bar, baz}</td><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * </tr><a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * </table><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * @param token the filter chain definition token<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * @return A name/value pair representing the filter name and a (possibly null) config value.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @throws ConfigurationException if the token cannot be parsed<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * @since 1.2<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * @see <a href="https://issues.apache.org/jira/browse/SHIRO-205">SHIRO-205</a><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> */<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> protected String[] toNameConfigPair(String token) throws ConfigurationException {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span><a name="line.198"></a> |
| <span class="sourceLineNo">199</span> try {<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> String[] pair = token.split("\\[", 2);<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> String name = StringUtils.clean(pair[0]);<a name="line.201"></a> |
| <span class="sourceLineNo">202</span><a name="line.202"></a> |
| <span class="sourceLineNo">203</span> if (name == null) {<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> throw new IllegalArgumentException("Filter name not found for filter chain definition token: " + token);<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> }<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> String config = null;<a name="line.206"></a> |
| <span class="sourceLineNo">207</span><a name="line.207"></a> |
| <span class="sourceLineNo">208</span> if (pair.length == 2) {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> config = StringUtils.clean(pair[1]);<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> //if there was an open bracket, it assumed there is a closing bracket, so strip it too:<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> config = config.substring(0, config.length() - 1);<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> config = StringUtils.clean(config);<a name="line.212"></a> |
| <span class="sourceLineNo">213</span><a name="line.213"></a> |
| <span class="sourceLineNo">214</span> //backwards compatibility prior to implementing SHIRO-205:<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> //prior to SHIRO-205 being implemented, it was common for end-users to quote the config inside brackets<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> //if that config required commas. We need to strip those quotes to get to the interior quoted definition<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> //to ensure any existing quoted definitions still function for end users:<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> if (config != null && config.startsWith("\"") && config.endsWith("\"")) {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> String stripped = config.substring(1, config.length() - 1);<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> stripped = StringUtils.clean(stripped);<a name="line.220"></a> |
| <span class="sourceLineNo">221</span><a name="line.221"></a> |
| <span class="sourceLineNo">222</span> //if the stripped value does not have any internal quotes, we can assume that the entire config was<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> //quoted and we can use the stripped value.<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> if (stripped != null && stripped.indexOf('"') == -1) {<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> config = stripped;<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> }<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> //else:<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> //the remaining config does have internal quotes, so we need to assume that each comma delimited<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> //pair might be quoted, in which case we need the leading and trailing quotes that we stripped<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> //So we ignore the stripped value.<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> }<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> }<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> <a name="line.233"></a> |
| <span class="sourceLineNo">234</span> return new String[]{name, config};<a name="line.234"></a> |
| <span class="sourceLineNo">235</span><a name="line.235"></a> |
| <span class="sourceLineNo">236</span> } catch (Exception e) {<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> String msg = "Unable to parse filter chain definition token: " + token;<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> throw new ConfigurationException(msg, e);<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> }<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> }<a name="line.240"></a> |
| <span class="sourceLineNo">241</span><a name="line.241"></a> |
| <span class="sourceLineNo">242</span> protected void addFilter(String name, Filter filter, boolean init, boolean overwrite) {<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> Filter existing = getFilter(name);<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> if (existing == null || overwrite) {<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> if (filter instanceof Nameable) {<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> ((Nameable) filter).setName(name);<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> }<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> if (init) {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> initFilter(filter);<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> this.filters.put(name, filter);<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> }<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> public void addToChain(String chainName, String filterName) {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> addToChain(chainName, filterName, null);<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> }<a name="line.257"></a> |
| <span class="sourceLineNo">258</span><a name="line.258"></a> |
| <span class="sourceLineNo">259</span> public void addToChain(String chainName, String filterName, String chainSpecificFilterConfig) {<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> if (!StringUtils.hasText(chainName)) {<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> throw new IllegalArgumentException("chainName cannot be null or empty.");<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> }<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> Filter filter = getFilter(filterName);<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> if (filter == null) {<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> throw new IllegalArgumentException("There is no filter with name '" + filterName +<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> "' to apply to chain [" + chainName + "] in the pool of available Filters. Ensure a " +<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> "filter with that name/path has first been registered with the addFilter method(s).");<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> }<a name="line.268"></a> |
| <span class="sourceLineNo">269</span><a name="line.269"></a> |
| <span class="sourceLineNo">270</span> applyChainConfig(chainName, filter, chainSpecificFilterConfig);<a name="line.270"></a> |
| <span class="sourceLineNo">271</span><a name="line.271"></a> |
| <span class="sourceLineNo">272</span> NamedFilterList chain = ensureChain(chainName);<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> chain.add(filter);<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> }<a name="line.274"></a> |
| <span class="sourceLineNo">275</span><a name="line.275"></a> |
| <span class="sourceLineNo">276</span> protected void applyChainConfig(String chainName, Filter filter, String chainSpecificFilterConfig) {<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> if (log.isDebugEnabled()) {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> log.debug("Attempting to apply path [" + chainName + "] to filter [" + filter + "] " +<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> "with config [" + chainSpecificFilterConfig + "]");<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> }<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> if (filter instanceof PathConfigProcessor) {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> ((PathConfigProcessor) filter).processPathConfig(chainName, chainSpecificFilterConfig);<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> } else {<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> if (StringUtils.hasText(chainSpecificFilterConfig)) {<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> //they specified a filter configuration, but the Filter doesn't implement PathConfigProcessor<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> //this is an erroneous config:<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> String msg = "chainSpecificFilterConfig was specified, but the underlying " +<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> "Filter instance is not an 'instanceof' " +<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> PathConfigProcessor.class.getName() + ". This is required if the filter is to accept " +<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> "chain-specific configuration.";<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> throw new ConfigurationException(msg);<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> }<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> }<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> }<a name="line.294"></a> |
| <span class="sourceLineNo">295</span><a name="line.295"></a> |
| <span class="sourceLineNo">296</span> protected NamedFilterList ensureChain(String chainName) {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> NamedFilterList chain = getChain(chainName);<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> if (chain == null) {<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> chain = new SimpleNamedFilterList(chainName);<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> this.filterChains.put(chainName, chain);<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> }<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> return chain;<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> public NamedFilterList getChain(String chainName) {<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> return this.filterChains.get(chainName);<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> }<a name="line.307"></a> |
| <span class="sourceLineNo">308</span><a name="line.308"></a> |
| <span class="sourceLineNo">309</span> public boolean hasChains() {<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> return !CollectionUtils.isEmpty(this.filterChains);<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> }<a name="line.311"></a> |
| <span class="sourceLineNo">312</span><a name="line.312"></a> |
| <span class="sourceLineNo">313</span> public Set<String> getChainNames() {<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> //noinspection unchecked<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> return this.filterChains != null ? this.filterChains.keySet() : Collections.EMPTY_SET;<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> public FilterChain proxy(FilterChain original, String chainName) {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> NamedFilterList configured = getChain(chainName);<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> if (configured == null) {<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> String msg = "There is no configured chain under the name/key [" + chainName + "].";<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> throw new IllegalArgumentException(msg);<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> }<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> return configured.proxy(original);<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> }<a name="line.325"></a> |
| <span class="sourceLineNo">326</span><a name="line.326"></a> |
| <span class="sourceLineNo">327</span> /**<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * Initializes the filter by calling <code>filter.init( {@link #getFilterConfig() getFilterConfig()} );</code>.<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> *<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * @param filter the filter to initialize with the {@code FilterConfig}.<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> */<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> protected void initFilter(Filter filter) {<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> FilterConfig filterConfig = getFilterConfig();<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> if (filterConfig == null) {<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> throw new IllegalStateException("FilterConfig attribute has not been set. This must occur before filter " +<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> "initialization can occur.");<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> }<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> try {<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> filter.init(filterConfig);<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> } catch (ServletException e) {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> throw new ConfigurationException(e);<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> }<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> }<a name="line.343"></a> |
| <span class="sourceLineNo">344</span><a name="line.344"></a> |
| <span class="sourceLineNo">345</span> protected void addDefaultFilters(boolean init) {<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> for (DefaultFilter defaultFilter : DefaultFilter.values()) {<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> addFilter(defaultFilter.name(), defaultFilter.newInstance(), init, false);<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> }<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
