Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.11.0 / shiro-web / apidocs / src-html / org / apache / shiro / web / filter / mgt / FilterChainResolver.html
blob: 4bf1d48097e18eea6a714f70d102458bbe1ebd26 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<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 javax.servlet.FilterChain;</a>
<span class="sourceLineNo">022</span><a id="line.22">import javax.servlet.ServletRequest;</a>
<span class="sourceLineNo">023</span><a id="line.23">import javax.servlet.ServletResponse;</a>
<span class="sourceLineNo">024</span><a id="line.24"></a>
<span class="sourceLineNo">025</span><a id="line.25">/**</a>
<span class="sourceLineNo">026</span><a id="line.26"> * A {@code FilterChainResolver} can resolve an appropriate {@link FilterChain} to execute during a</a>
<span class="sourceLineNo">027</span><a id="line.27"> * {@code ServletRequest}. It allows resolution of arbitrary filter chains which can be executed for any given</a>
<span class="sourceLineNo">028</span><a id="line.28"> * request or URI/URL.</a>
<span class="sourceLineNo">029</span><a id="line.29"> * &lt;p/&gt;</a>
<span class="sourceLineNo">030</span><a id="line.30"> * This mechanism allows for a much more flexible FilterChain resolution than normal {@code web.xml} servlet filter</a>
<span class="sourceLineNo">031</span><a id="line.31"> * definitions: it allows arbitrary filter chains to be defined per URL in a much more concise and easy to read manner,</a>
<span class="sourceLineNo">032</span><a id="line.32"> * and even allows filter chains to be dynamically resolved or constructed at runtime if the underlying implementation</a>
<span class="sourceLineNo">033</span><a id="line.33"> * supports it.</a>
<span class="sourceLineNo">034</span><a id="line.34"> *</a>
<span class="sourceLineNo">035</span><a id="line.35"> * @since 1.0</a>
<span class="sourceLineNo">036</span><a id="line.36"> */</a>
<span class="sourceLineNo">037</span><a id="line.37">public interface FilterChainResolver {</a>
<span class="sourceLineNo">038</span><a id="line.38"></a>
<span class="sourceLineNo">039</span><a id="line.39"> /**</a>
<span class="sourceLineNo">040</span><a id="line.40"> * Returns the filter chain that should be executed for the given request, or {@code null} if the</a>
<span class="sourceLineNo">041</span><a id="line.41"> * original chain should be used.</a>
<span class="sourceLineNo">042</span><a id="line.42"> * &lt;p/&gt;</a>
<span class="sourceLineNo">043</span><a id="line.43"> * This method allows a implementation to define arbitrary security {@link javax.servlet.Filter Filter}</a>
<span class="sourceLineNo">044</span><a id="line.44"> * chains for any given request or URL pattern.</a>
<span class="sourceLineNo">045</span><a id="line.45"> *</a>
<span class="sourceLineNo">046</span><a id="line.46"> * @param request the incoming ServletRequest</a>
<span class="sourceLineNo">047</span><a id="line.47"> * @param response the outgoing ServletResponse</a>
<span class="sourceLineNo">048</span><a id="line.48"> * @param originalChain the original {@code FilterChain} intercepted by the ShiroFilter implementation.</a>
<span class="sourceLineNo">049</span><a id="line.49"> * @return the filter chain that should be executed for the given request, or {@code null} if the</a>
<span class="sourceLineNo">050</span><a id="line.50"> * original chain should be used.</a>
<span class="sourceLineNo">051</span><a id="line.51"> */</a>
<span class="sourceLineNo">052</span><a id="line.52"> FilterChain getChain(ServletRequest request, ServletResponse response, FilterChain originalChain);</a>
<span class="sourceLineNo">053</span><a id="line.53"></a>
<span class="sourceLineNo">054</span><a id="line.54">}</a>
</pre>
</div>
</main>
</body>
</html>