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