blob: 48283c7c7093a8f6be5fb6f3d86935d7131270f3 [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.servlet;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.slf4j.Logger;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">import javax.servlet.*;</a>
<span class="sourceLineNo">025</span><a id="line.25">import java.io.IOException;</a>
<span class="sourceLineNo">026</span><a id="line.26">import java.util.List;</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 proxied filter chain is a {@link FilterChain} instance that proxies an original {@link FilterChain} as well</a>
<span class="sourceLineNo">030</span><a id="line.30"> * as a {@link List List} of other {@link Filter Filter}s that might need to execute prior to the final wrapped</a>
<span class="sourceLineNo">031</span><a id="line.31"> * original chain. It allows a list of filters to execute before continuing the original (proxied)</a>
<span class="sourceLineNo">032</span><a id="line.32"> * {@code FilterChain} instance.</a>
<span class="sourceLineNo">033</span><a id="line.33"> *</a>
<span class="sourceLineNo">034</span><a id="line.34"> * @since 0.9</a>
<span class="sourceLineNo">035</span><a id="line.35"> */</a>
<span class="sourceLineNo">036</span><a id="line.36">public class ProxiedFilterChain implements FilterChain {</a>
<span class="sourceLineNo">037</span><a id="line.37"></a>
<span class="sourceLineNo">038</span><a id="line.38"> //TODO - complete JavaDoc</a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40"> private static final Logger log = LoggerFactory.getLogger(ProxiedFilterChain.class);</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42"> private FilterChain orig;</a>
<span class="sourceLineNo">043</span><a id="line.43"> private List&lt;Filter&gt; filters;</a>
<span class="sourceLineNo">044</span><a id="line.44"> private int index = 0;</a>
<span class="sourceLineNo">045</span><a id="line.45"></a>
<span class="sourceLineNo">046</span><a id="line.46"> public ProxiedFilterChain(FilterChain orig, List&lt;Filter&gt; filters) {</a>
<span class="sourceLineNo">047</span><a id="line.47"> if (orig == null) {</a>
<span class="sourceLineNo">048</span><a id="line.48"> throw new NullPointerException("original FilterChain cannot be null.");</a>
<span class="sourceLineNo">049</span><a id="line.49"> }</a>
<span class="sourceLineNo">050</span><a id="line.50"> this.orig = orig;</a>
<span class="sourceLineNo">051</span><a id="line.51"> this.filters = filters;</a>
<span class="sourceLineNo">052</span><a id="line.52"> this.index = 0;</a>
<span class="sourceLineNo">053</span><a id="line.53"> }</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> public void doFilter(ServletRequest request, ServletResponse response) throws IOException, ServletException {</a>
<span class="sourceLineNo">056</span><a id="line.56"> if (this.filters == null || this.filters.size() == this.index) {</a>
<span class="sourceLineNo">057</span><a id="line.57"> //we've reached the end of the wrapped chain, so invoke the original one:</a>
<span class="sourceLineNo">058</span><a id="line.58"> if (log.isTraceEnabled()) {</a>
<span class="sourceLineNo">059</span><a id="line.59"> log.trace("Invoking original filter chain.");</a>
<span class="sourceLineNo">060</span><a id="line.60"> }</a>
<span class="sourceLineNo">061</span><a id="line.61"> this.orig.doFilter(request, response);</a>
<span class="sourceLineNo">062</span><a id="line.62"> } else {</a>
<span class="sourceLineNo">063</span><a id="line.63"> if (log.isTraceEnabled()) {</a>
<span class="sourceLineNo">064</span><a id="line.64"> log.trace("Invoking wrapped filter at index [" + this.index + "]");</a>
<span class="sourceLineNo">065</span><a id="line.65"> }</a>
<span class="sourceLineNo">066</span><a id="line.66"> this.filters.get(this.index++).doFilter(request, response, this);</a>
<span class="sourceLineNo">067</span><a id="line.67"> }</a>
<span class="sourceLineNo">068</span><a id="line.68"> }</a>
<span class="sourceLineNo">069</span><a id="line.69">}</a>
</pre>
</div>
</main>
</body>
</html>