| <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> <a name="line.22"></a> |
| <FONT color="green">023</FONT> import javax.servlet.Filter;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import javax.servlet.FilterChain;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import java.util.Map;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import java.util.Set;<a name="line.26"></a> |
| <FONT color="green">027</FONT> <a name="line.27"></a> |
| <FONT color="green">028</FONT> /**<a name="line.28"></a> |
| <FONT color="green">029</FONT> * A {@code FilterChainManager} manages the creation and modification of {@link Filter} chains from an available pool<a name="line.29"></a> |
| <FONT color="green">030</FONT> * of {@link Filter} instances.<a name="line.30"></a> |
| <FONT color="green">031</FONT> *<a name="line.31"></a> |
| <FONT color="green">032</FONT> * @since 1.0<a name="line.32"></a> |
| <FONT color="green">033</FONT> */<a name="line.33"></a> |
| <FONT color="green">034</FONT> public interface FilterChainManager {<a name="line.34"></a> |
| <FONT color="green">035</FONT> <a name="line.35"></a> |
| <FONT color="green">036</FONT> /**<a name="line.36"></a> |
| <FONT color="green">037</FONT> * Returns the pool of available {@code Filter}s managed by this manager, keyed by {@code name}.<a name="line.37"></a> |
| <FONT color="green">038</FONT> *<a name="line.38"></a> |
| <FONT color="green">039</FONT> * @return the pool of available {@code Filter}s managed by this manager, keyed by {@code name}.<a name="line.39"></a> |
| <FONT color="green">040</FONT> */<a name="line.40"></a> |
| <FONT color="green">041</FONT> Map<String, Filter> getFilters();<a name="line.41"></a> |
| <FONT color="green">042</FONT> <a name="line.42"></a> |
| <FONT color="green">043</FONT> /**<a name="line.43"></a> |
| <FONT color="green">044</FONT> * Returns the filter chain identified by the specified {@code chainName} or {@code null} if there is no chain with<a name="line.44"></a> |
| <FONT color="green">045</FONT> * that name.<a name="line.45"></a> |
| <FONT color="green">046</FONT> *<a name="line.46"></a> |
| <FONT color="green">047</FONT> * @param chainName the name identifying the filter chain.<a name="line.47"></a> |
| <FONT color="green">048</FONT> * @return the filter chain identified by the specified {@code chainName} or {@code null} if there is no chain with<a name="line.48"></a> |
| <FONT color="green">049</FONT> * that name.<a name="line.49"></a> |
| <FONT color="green">050</FONT> */<a name="line.50"></a> |
| <FONT color="green">051</FONT> NamedFilterList getChain(String chainName);<a name="line.51"></a> |
| <FONT color="green">052</FONT> <a name="line.52"></a> |
| <FONT color="green">053</FONT> /**<a name="line.53"></a> |
| <FONT color="green">054</FONT> * Returns {@code true} if one or more configured chains are available, {@code false} if none are configured.<a name="line.54"></a> |
| <FONT color="green">055</FONT> *<a name="line.55"></a> |
| <FONT color="green">056</FONT> * @return {@code true} if one or more configured chains are available, {@code false} if none are configured.<a name="line.56"></a> |
| <FONT color="green">057</FONT> */<a name="line.57"></a> |
| <FONT color="green">058</FONT> boolean hasChains();<a name="line.58"></a> |
| <FONT color="green">059</FONT> <a name="line.59"></a> |
| <FONT color="green">060</FONT> /**<a name="line.60"></a> |
| <FONT color="green">061</FONT> * Returns the names of all configured chains or an empty {@code Set} if no chains have been configured.<a name="line.61"></a> |
| <FONT color="green">062</FONT> *<a name="line.62"></a> |
| <FONT color="green">063</FONT> * @return the names of all configured chains or an empty {@code Set} if no chains have been configured.<a name="line.63"></a> |
| <FONT color="green">064</FONT> */<a name="line.64"></a> |
| <FONT color="green">065</FONT> Set<String> getChainNames();<a name="line.65"></a> |
| <FONT color="green">066</FONT> <a name="line.66"></a> |
| <FONT color="green">067</FONT> /**<a name="line.67"></a> |
| <FONT color="green">068</FONT> * Proxies the specified {@code original} FilterChain with the named chain. The returned<a name="line.68"></a> |
| <FONT color="green">069</FONT> * {@code FilterChain} instance will first execute the configured named chain and then lastly invoke the given<a name="line.69"></a> |
| <FONT color="green">070</FONT> * {@code original} chain.<a name="line.70"></a> |
| <FONT color="green">071</FONT> *<a name="line.71"></a> |
| <FONT color="green">072</FONT> * @param original the original FilterChain to proxy<a name="line.72"></a> |
| <FONT color="green">073</FONT> * @param chainName the name of the internal configured filter chain that should 'sit in front' of the specified<a name="line.73"></a> |
| <FONT color="green">074</FONT> * original chain.<a name="line.74"></a> |
| <FONT color="green">075</FONT> * @return a {@code FilterChain} instance that will execute the named chain and then finally the<a name="line.75"></a> |
| <FONT color="green">076</FONT> * specified {@code original} FilterChain instance.<a name="line.76"></a> |
| <FONT color="green">077</FONT> * @throws IllegalArgumentException if there is no configured chain with the given {@code chainName}.<a name="line.77"></a> |
| <FONT color="green">078</FONT> */<a name="line.78"></a> |
| <FONT color="green">079</FONT> FilterChain proxy(FilterChain original, String chainName);<a name="line.79"></a> |
| <FONT color="green">080</FONT> <a name="line.80"></a> |
| <FONT color="green">081</FONT> /**<a name="line.81"></a> |
| <FONT color="green">082</FONT> * Adds a filter to the 'pool' of available filters that can be used when<a name="line.82"></a> |
| <FONT color="green">083</FONT> * {@link #addToChain(String, String, String) creating filter chains}.<a name="line.83"></a> |
| <FONT color="green">084</FONT> * <p/><a name="line.84"></a> |
| <FONT color="green">085</FONT> * Calling this method is effectively the same as calling<a name="line.85"></a> |
| <FONT color="green">086</FONT> * <code>{@link #addFilter(String, javax.servlet.Filter, boolean) addFilter}(name, filter, <b>false</b>);</code><a name="line.86"></a> |
| <FONT color="green">087</FONT> *<a name="line.87"></a> |
| <FONT color="green">088</FONT> * @param name the name to assign to the filter, used to reference the filter in chain definitions<a name="line.88"></a> |
| <FONT color="green">089</FONT> * @param filter the filter to initialize and then add to the pool of available filters that can be used<a name="line.89"></a> |
| <FONT color="green">090</FONT> */<a name="line.90"></a> |
| <FONT color="green">091</FONT> void addFilter(String name, Filter filter);<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> * Adds a filter to the 'pool' of available filters that can be used when<a name="line.94"></a> |
| <FONT color="green">095</FONT> * {@link #addToChain(String, String, String) creating filter chains}.<a name="line.95"></a> |
| <FONT color="green">096</FONT> *<a name="line.96"></a> |
| <FONT color="green">097</FONT> * @param name the name to assign to the filter, used to reference the filter in chain definitions<a name="line.97"></a> |
| <FONT color="green">098</FONT> * @param filter the filter to assign to the filter pool<a name="line.98"></a> |
| <FONT color="green">099</FONT> * @param init whether or not the {@code Filter} should be<a name="line.99"></a> |
| <FONT color="green">100</FONT> * {@link Filter#init(javax.servlet.FilterConfig) initialized} first before being added to the pool.<a name="line.100"></a> |
| <FONT color="green">101</FONT> */<a name="line.101"></a> |
| <FONT color="green">102</FONT> void addFilter(String name, Filter filter, boolean init);<a name="line.102"></a> |
| <FONT color="green">103</FONT> <a name="line.103"></a> |
| <FONT color="green">104</FONT> /**<a name="line.104"></a> |
| <FONT color="green">105</FONT> * Creates a filter chain for the given {@code chainName} with the specified {@code chainDefinition}<a name="line.105"></a> |
| <FONT color="green">106</FONT> * String.<a name="line.106"></a> |
| <FONT color="green">107</FONT> * <h3>Conventional Use</h3><a name="line.107"></a> |
| <FONT color="green">108</FONT> * Because the {@code FilterChainManager} interface does not impose any restrictions on filter chain names,<a name="line.108"></a> |
| <FONT color="green">109</FONT> * (it expects only Strings), a convenient convention is to make the chain name an actual URL path expression<a name="line.109"></a> |
| <FONT color="green">110</FONT> * (such as an {@link org.apache.shiro.util.AntPathMatcher Ant path expression}). For example:<a name="line.110"></a> |
| <FONT color="green">111</FONT> * <p/><a name="line.111"></a> |
| <FONT color="green">112</FONT> * <code>createChain(<b><em>path_expression</em></b>, <em>path_specific_filter_chain_definition</em>);</code><a name="line.112"></a> |
| <FONT color="green">113</FONT> * This convention can be used by a {@link FilterChainResolver} to inspect request URL paths<a name="line.113"></a> |
| <FONT color="green">114</FONT> * against the chain name (path) and, if a match is found, return the corresponding chain for runtime filtering.<a name="line.114"></a> |
| <FONT color="green">115</FONT> * <h3>Chain Definition Format</h3><a name="line.115"></a> |
| <FONT color="green">116</FONT> * The {@code chainDefinition} method argument is expected to conform to the following format:<a name="line.116"></a> |
| <FONT color="green">117</FONT> * <pre><a name="line.117"></a> |
| <FONT color="green">118</FONT> * filter1[optional_config1], filter2[optional_config2], ..., filterN[optional_configN]</pre><a name="line.118"></a> |
| <FONT color="green">119</FONT> * where<a name="line.119"></a> |
| <FONT color="green">120</FONT> * <ol><a name="line.120"></a> |
| <FONT color="green">121</FONT> * <li>{@code filterN} is the name of a filter previously<a name="line.121"></a> |
| <FONT color="green">122</FONT> * {@link #addFilter(String, javax.servlet.Filter) registered} with the manager, and</li><a name="line.122"></a> |
| <FONT color="green">123</FONT> * <li>{@code [optional_configN]} is an optional bracketed string that has meaning for that particular filter for<a name="line.123"></a> |
| <FONT color="green">124</FONT> * <em>this particular chain</em></li><a name="line.124"></a> |
| <FONT color="green">125</FONT> * </ol><a name="line.125"></a> |
| <FONT color="green">126</FONT> * If the filter does not need specific config for that chain name/URL path,<a name="line.126"></a> |
| <FONT color="green">127</FONT> * you may discard the brackets - that is, {@code filterN[]} just becomes {@code filterN}.<a name="line.127"></a> |
| <FONT color="green">128</FONT> * <p/><a name="line.128"></a> |
| <FONT color="green">129</FONT> * And because this method does create a chain, remember that order matters! The comma-delimited filter tokens in<a name="line.129"></a> |
| <FONT color="green">130</FONT> * the {@code chainDefinition} specify the chain's execution order.<a name="line.130"></a> |
| <FONT color="green">131</FONT> * <h3>Examples</h3><a name="line.131"></a> |
| <FONT color="green">132</FONT> * <pre>/account/** = authcBasic</pre><a name="line.132"></a> |
| <FONT color="green">133</FONT> * This example says &quot;Create a filter named '{@code /account/**}' consisting of only the '{@code authcBasic}'<a name="line.133"></a> |
| <FONT color="green">134</FONT> * filter&quot;. Also because the {@code authcBasic} filter does not need any path-specific<a name="line.134"></a> |
| <FONT color="green">135</FONT> * config, it doesn't have any config brackets {@code []}.<a name="line.135"></a> |
| <FONT color="green">136</FONT> * <p/><a name="line.136"></a> |
| <FONT color="green">137</FONT> * <pre>/remoting/** = authcBasic, roles[b2bClient], perms[&quot;remote:invoke:wan,lan&quot;]</pre><a name="line.137"></a> |
| <FONT color="green">138</FONT> * This example by contrast uses the 'roles' and 'perms' filters which <em>do</em> use bracket notation. This<a name="line.138"></a> |
| <FONT color="green">139</FONT> * definition says:<a name="line.139"></a> |
| <FONT color="green">140</FONT> * <p/><a name="line.140"></a> |
| <FONT color="green">141</FONT> * Construct a filter chain named '{@code /remoting/**}' which<a name="line.141"></a> |
| <FONT color="green">142</FONT> * <ol><a name="line.142"></a> |
| <FONT color="green">143</FONT> * <li>ensures the user is first authenticated ({@code authcBasic}) then</li><a name="line.143"></a> |
| <FONT color="green">144</FONT> * <li>ensures that user has the {@code b2bClient} role, and then finally</li><a name="line.144"></a> |
| <FONT color="green">145</FONT> * <li>ensures that they have the {@code remote:invoke:lan,wan} permission.</li><a name="line.145"></a> |
| <FONT color="green">146</FONT> * </ol><a name="line.146"></a> |
| <FONT color="green">147</FONT> * <p/><a name="line.147"></a> |
| <FONT color="green">148</FONT> * <b>Note</b>: because elements within brackets [ ] can be comma-delimited themselves, you must quote the<a name="line.148"></a> |
| <FONT color="green">149</FONT> * internal bracket definition if commas are needed (the above example has 'lan,wan'). If we didn't do that, the<a name="line.149"></a> |
| <FONT color="green">150</FONT> * parser would interpret the chain definition as four tokens:<a name="line.150"></a> |
| <FONT color="green">151</FONT> * <ol><a name="line.151"></a> |
| <FONT color="green">152</FONT> * <li>authcBasic</li><a name="line.152"></a> |
| <FONT color="green">153</FONT> * <li>roles[b2bclient]</li><a name="line.153"></a> |
| <FONT color="green">154</FONT> * <li>perms[remote:invoke:lan</li><a name="line.154"></a> |
| <FONT color="green">155</FONT> * <li>wan]</li><a name="line.155"></a> |
| <FONT color="green">156</FONT> * </ol><a name="line.156"></a> |
| <FONT color="green">157</FONT> * which is obviously incorrect. So remember to use quotes if your internal bracket definitions need to use commas.<a name="line.157"></a> |
| <FONT color="green">158</FONT> *<a name="line.158"></a> |
| <FONT color="green">159</FONT> * @param chainName the name to associate with the chain, conventionally a URL path pattern.<a name="line.159"></a> |
| <FONT color="green">160</FONT> * @param chainDefinition the string-formatted chain definition used to construct an actual<a name="line.160"></a> |
| <FONT color="green">161</FONT> * {@link NamedFilterList} chain instance.<a name="line.161"></a> |
| <FONT color="green">162</FONT> * @see FilterChainResolver<a name="line.162"></a> |
| <FONT color="green">163</FONT> * @see org.apache.shiro.util.AntPathMatcher AntPathMatcher<a name="line.163"></a> |
| <FONT color="green">164</FONT> */<a name="line.164"></a> |
| <FONT color="green">165</FONT> void createChain(String chainName, String chainDefinition);<a name="line.165"></a> |
| <FONT color="green">166</FONT> <a name="line.166"></a> |
| <FONT color="green">167</FONT> /**<a name="line.167"></a> |
| <FONT color="green">168</FONT> * Adds (appends) a filter to the filter chain identified by the given {@code chainName}. If there is no chain<a name="line.168"></a> |
| <FONT color="green">169</FONT> * with the given name, a new one is created and the filter will be the first in the chain.<a name="line.169"></a> |
| <FONT color="green">170</FONT> *<a name="line.170"></a> |
| <FONT color="green">171</FONT> * @param chainName the name of the chain where the filter will be appended.<a name="line.171"></a> |
| <FONT color="green">172</FONT> * @param filterName the name of the {@link #addFilter registered} filter to add to the chain.<a name="line.172"></a> |
| <FONT color="green">173</FONT> * @throws IllegalArgumentException if there is not a {@link #addFilter(String, javax.servlet.Filter) registered}<a name="line.173"></a> |
| <FONT color="green">174</FONT> * filter under the given {@code filterName}<a name="line.174"></a> |
| <FONT color="green">175</FONT> */<a name="line.175"></a> |
| <FONT color="green">176</FONT> void addToChain(String chainName, String filterName);<a name="line.176"></a> |
| <FONT color="green">177</FONT> <a name="line.177"></a> |
| <FONT color="green">178</FONT> /**<a name="line.178"></a> |
| <FONT color="green">179</FONT> * Adds (appends) a filter to the filter chain identified by the given {@code chainName}. If there is no chain<a name="line.179"></a> |
| <FONT color="green">180</FONT> * with the given name, a new one is created and the filter will be the first in the chain.<a name="line.180"></a> |
| <FONT color="green">181</FONT> * <p/><a name="line.181"></a> |
| <FONT color="green">182</FONT> * Note that the final argument expects the associated filter to be an instance of<a name="line.182"></a> |
| <FONT color="green">183</FONT> * a {@link org.apache.shiro.web.filter.PathConfigProcessor PathConfigProcessor} to accept per-chain configuration.<a name="line.183"></a> |
| <FONT color="green">184</FONT> * If it is not, a {@link IllegalArgumentException} will be thrown.<a name="line.184"></a> |
| <FONT color="green">185</FONT> *<a name="line.185"></a> |
| <FONT color="green">186</FONT> * @param chainName the name of the chain where the filter will be appended.<a name="line.186"></a> |
| <FONT color="green">187</FONT> * @param filterName the name of the {@link #addFilter registered} filter to add to the chain.<a name="line.187"></a> |
| <FONT color="green">188</FONT> * @param chainSpecificFilterConfig the filter-specific configuration that should be applied for only the specified<a name="line.188"></a> |
| <FONT color="green">189</FONT> * filter chain.<a name="line.189"></a> |
| <FONT color="green">190</FONT> * @throws IllegalArgumentException if there is not a {@link #addFilter(String, javax.servlet.Filter) registered}<a name="line.190"></a> |
| <FONT color="green">191</FONT> * filter under the given {@code filterName}<a name="line.191"></a> |
| <FONT color="green">192</FONT> * @throws ConfigurationException if the filter is not capable of accepting {@code chainSpecificFilterConfig}<a name="line.192"></a> |
| <FONT color="green">193</FONT> * (usually such filters implement the<a name="line.193"></a> |
| <FONT color="green">194</FONT> * {@link org.apache.shiro.web.filter.PathConfigProcessor PathConfigProcessor}<a name="line.194"></a> |
| <FONT color="green">195</FONT> * interface).<a name="line.195"></a> |
| <FONT color="green">196</FONT> */<a name="line.196"></a> |
| <FONT color="green">197</FONT> void addToChain(String chainName, String filterName, String chainSpecificFilterConfig) throws ConfigurationException;<a name="line.197"></a> |
| <FONT color="green">198</FONT> }<a name="line.198"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
