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