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