| <!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.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.FilterChain;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import javax.servlet.ServletException;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import javax.servlet.ServletRequest;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import javax.servlet.ServletResponse;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import java.io.IOException;</a> |
| <span class="sourceLineNo">029</span><a id="line.29"></a> |
| <span class="sourceLineNo">030</span><a id="line.30">/**</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * A Servlet Filter that enables AOP-style &quot;around&quot; advice for a ServletRequest via</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * {@link #preHandle(javax.servlet.ServletRequest, javax.servlet.ServletResponse) preHandle},</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * {@link #postHandle(javax.servlet.ServletRequest, javax.servlet.ServletResponse) postHandle},</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * and {@link #afterCompletion(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Exception) afterCompletion}</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * hooks.</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> *</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * @since 0.9</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> */</a> |
| <span class="sourceLineNo">039</span><a id="line.39">public abstract class AdviceFilter extends OncePerRequestFilter {</a> |
| <span class="sourceLineNo">040</span><a id="line.40"></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> /**</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * The static logger available to this class only</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> */</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> private static final Logger log = LoggerFactory.getLogger(AdviceFilter.class);</a> |
| <span class="sourceLineNo">045</span><a id="line.45"></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> /**</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * Returns {@code true} if the filter chain should be allowed to continue, {@code false} otherwise.</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * It is called before the chain is actually consulted/executed.</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * <p/></a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * The default implementation returns {@code true} always and exists as a template method for subclasses.</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> *</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * @param request the incoming ServletRequest</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * @param response the outgoing ServletResponse</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * @return {@code true} if the filter chain should be allowed to continue, {@code false} otherwise.</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @throws Exception if there is any error.</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> */</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> protected boolean preHandle(ServletRequest request, ServletResponse response) throws Exception {</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> return true;</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"> /**</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * Allows 'post' advice logic to be called, but only if no exception occurs during filter chain execution. That</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * is, if {@link #executeChain executeChain} throws an exception, this method will never be called. Be aware of</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * this when implementing logic. Most resource 'cleanup' behavior is often done in the</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * {@link #afterCompletion(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Exception) afterCompletion(request,response,exception)}</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * implementation, which is guaranteed to be called for every request, even when the chain processing throws</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * an Exception.</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * <p/></a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * The default implementation does nothing (no-op) and exists as a template method for subclasses.</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> *</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * @param request the incoming ServletRequest</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * @param response the outgoing ServletResponse</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * @throws Exception if an error occurs.</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> */</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> @SuppressWarnings({"UnusedDeclaration"})</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> protected void postHandle(ServletRequest request, ServletResponse response) throws Exception {</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> }</a> |
| <span class="sourceLineNo">078</span><a id="line.78"></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> /**</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * Called in all cases in a {@code finally} block even if {@link #preHandle preHandle} returns</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * {@code false} or if an exception is thrown during filter chain processing. Can be used for resource</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * cleanup if so desired.</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * <p/></a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * The default implementation does nothing (no-op) and exists as a template method for subclasses.</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> *</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * @param request the incoming ServletRequest</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * @param response the outgoing ServletResponse</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * @param exception any exception thrown during {@link #preHandle preHandle}, {@link #executeChain executeChain},</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * or {@link #postHandle postHandle} execution, or {@code null} if no exception was thrown</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * (i.e. the chain processed successfully).</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> * @throws Exception if an error occurs.</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> */</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> @SuppressWarnings({"UnusedDeclaration"})</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> public void afterCompletion(ServletRequest request, ServletResponse response, Exception exception) throws Exception {</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> }</a> |
| <span class="sourceLineNo">096</span><a id="line.96"></a> |
| <span class="sourceLineNo">097</span><a id="line.97"> /**</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * Actually executes the specified filter chain by calling <code>chain.doFilter(request,response);</code>.</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * <p/></a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * Can be overridden by subclasses for custom logic.</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> *</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> * @param request the incoming ServletRequest</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * @param response the outgoing ServletResponse</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * @param chain the filter chain to execute</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * @throws Exception if there is any error executing the chain.</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> */</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> protected void executeChain(ServletRequest request, ServletResponse response, FilterChain chain) throws Exception {</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> chain.doFilter(request, response);</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> }</a> |
| <span class="sourceLineNo">110</span><a id="line.110"></a> |
| <span class="sourceLineNo">111</span><a id="line.111"> /**</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> * Actually implements the chain execution logic, utilizing</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * {@link #preHandle(javax.servlet.ServletRequest, javax.servlet.ServletResponse) pre},</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> * {@link #postHandle(javax.servlet.ServletRequest, javax.servlet.ServletResponse) post}, and</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * {@link #afterCompletion(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Exception) after}</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> * advice hooks.</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> *</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * @param request the incoming ServletRequest</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> * @param response the outgoing ServletResponse</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * @param chain the filter chain to execute</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> * @throws ServletException if a servlet-related error occurs</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * @throws IOException if an IO error occurs</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> */</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> public void doFilterInternal(ServletRequest request, ServletResponse response, FilterChain chain)</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> throws ServletException, IOException {</a> |
| <span class="sourceLineNo">126</span><a id="line.126"></a> |
| <span class="sourceLineNo">127</span><a id="line.127"> Exception exception = null;</a> |
| <span class="sourceLineNo">128</span><a id="line.128"></a> |
| <span class="sourceLineNo">129</span><a id="line.129"> try {</a> |
| <span class="sourceLineNo">130</span><a id="line.130"></a> |
| <span class="sourceLineNo">131</span><a id="line.131"> boolean continueChain = preHandle(request, response);</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> if (log.isTraceEnabled()) {</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> log.trace("Invoked preHandle method. Continuing chain?: [" + continueChain + "]");</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> }</a> |
| <span class="sourceLineNo">135</span><a id="line.135"></a> |
| <span class="sourceLineNo">136</span><a id="line.136"> if (continueChain) {</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> executeChain(request, response, chain);</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> }</a> |
| <span class="sourceLineNo">139</span><a id="line.139"></a> |
| <span class="sourceLineNo">140</span><a id="line.140"> postHandle(request, response);</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> if (log.isTraceEnabled()) {</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> log.trace("Successfully invoked postHandle method");</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> }</a> |
| <span class="sourceLineNo">144</span><a id="line.144"></a> |
| <span class="sourceLineNo">145</span><a id="line.145"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> exception = e;</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> } finally {</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> cleanup(request, response, exception);</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> }</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> }</a> |
| <span class="sourceLineNo">151</span><a id="line.151"></a> |
| <span class="sourceLineNo">152</span><a id="line.152"> /**</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> * Executes cleanup logic in the {@code finally} code block in the</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> * {@link #doFilterInternal(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain) doFilterInternal}</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> * implementation.</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> * <p/></a> |
| <span class="sourceLineNo">157</span><a id="line.157"> * This implementation specifically calls</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> * {@link #afterCompletion(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Exception) afterCompletion}</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> * as well as handles any exceptions properly.</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> *</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> * @param request the incoming {@code ServletRequest}</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> * @param response the outgoing {@code ServletResponse}</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> * @param existing any exception that might have occurred while executing the {@code FilterChain} or</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> * pre or post advice, or {@code null} if the pre/chain/post execution did not throw an {@code Exception}.</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> * @throws ServletException if any exception other than an {@code IOException} is thrown.</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> * @throws IOException if the pre/chain/post execution throw an {@code IOException}</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> */</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> protected void cleanup(ServletRequest request, ServletResponse response, Exception existing)</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> throws ServletException, IOException {</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> Exception exception = existing;</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> try {</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> afterCompletion(request, response, exception);</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> if (log.isTraceEnabled()) {</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> log.trace("Successfully invoked afterCompletion method.");</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> }</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> if (exception == null) {</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> exception = e;</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> } else {</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> log.debug("afterCompletion implementation threw an exception. This will be ignored to " +</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> "allow the original source exception to be propagated.", e);</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> }</a> |
| <span class="sourceLineNo">183</span><a id="line.183"> }</a> |
| <span class="sourceLineNo">184</span><a id="line.184"> if (exception != null) {</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> if (exception instanceof ServletException) {</a> |
| <span class="sourceLineNo">186</span><a id="line.186"> throw (ServletException) exception;</a> |
| <span class="sourceLineNo">187</span><a id="line.187"> } else if (exception instanceof IOException) {</a> |
| <span class="sourceLineNo">188</span><a id="line.188"> throw (IOException) exception;</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> } else {</a> |
| <span class="sourceLineNo">190</span><a id="line.190"> if (log.isDebugEnabled()) {</a> |
| <span class="sourceLineNo">191</span><a id="line.191"> String msg = "Filter execution resulted in an unexpected Exception " +</a> |
| <span class="sourceLineNo">192</span><a id="line.192"> "(not IOException or ServletException as the Filter API recommends). " +</a> |
| <span class="sourceLineNo">193</span><a id="line.193"> "Wrapping in ServletException and propagating.";</a> |
| <span class="sourceLineNo">194</span><a id="line.194"> log.debug(msg);</a> |
| <span class="sourceLineNo">195</span><a id="line.195"> }</a> |
| <span class="sourceLineNo">196</span><a id="line.196"> throw new ServletException(exception);</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> }</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> }</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> }</a> |
| <span class="sourceLineNo">200</span><a id="line.200">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
