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