blob: bdb9e6586390105e69fe69ac6337dd2d2a99cf9b [file] [log] [blame]
<!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.apache.shiro.SecurityUtils;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.shiro.session.Session;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.shiro.subject.ExecutionException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.shiro.subject.Subject;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.shiro.web.filter.mgt.FilterChainResolver;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.shiro.web.mgt.DefaultWebSecurityManager;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.shiro.web.mgt.WebSecurityManager;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.shiro.web.subject.WebSubject;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.slf4j.Logger;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.slf4j.LoggerFactory;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>import javax.servlet.FilterChain;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import javax.servlet.ServletException;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import javax.servlet.ServletRequest;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import javax.servlet.ServletResponse;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import javax.servlet.http.HttpServletRequest;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import javax.servlet.http.HttpServletResponse;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import java.io.IOException;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import java.util.concurrent.Callable;<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> * Abstract base class that provides all standard Shiro request filtering behavior and expects<a name="line.42"></a>
<span class="sourceLineNo">043</span> * subclasses to implement configuration-specific logic (INI, XML, .properties, etc).<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;p/&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Subclasses should perform configuration and construction logic in an overridden<a name="line.45"></a>
<span class="sourceLineNo">046</span> * {@link #init()} method implementation. That implementation should make available any constructed<a name="line.46"></a>
<span class="sourceLineNo">047</span> * {@code SecurityManager} and {@code FilterChainResolver} by calling<a name="line.47"></a>
<span class="sourceLineNo">048</span> * {@link #setSecurityManager(org.apache.shiro.web.mgt.WebSecurityManager)} and<a name="line.48"></a>
<span class="sourceLineNo">049</span> * {@link #setFilterChainResolver(org.apache.shiro.web.filter.mgt.FilterChainResolver)} methods respectively.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;h3&gt;Static SecurityManager&lt;/h3&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * By default the {@code SecurityManager} instance enabled by this filter &lt;em&gt;will not&lt;/em&gt; be enabled in static<a name="line.51"></a>
<span class="sourceLineNo">052</span> * memory via the {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}<a name="line.52"></a>
<span class="sourceLineNo">053</span> * method. Instead, it is expected that Subject instances will always be constructed on a request-processing thread<a name="line.53"></a>
<span class="sourceLineNo">054</span> * via instances of this Filter class.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;p/&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * However, if you need to construct {@code Subject} instances on separate (non request-processing) threads, it might<a name="line.56"></a>
<span class="sourceLineNo">057</span> * be easiest to enable the SecurityManager to be available in static memory via the<a name="line.57"></a>
<span class="sourceLineNo">058</span> * {@link SecurityUtils#getSecurityManager()} method. You can do this by additionally specifying an {@code init-param}:<a name="line.58"></a>
<span class="sourceLineNo">059</span> * &lt;pre&gt;<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &amp;lt;filter&amp;gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> * ... other config here ...<a name="line.61"></a>
<span class="sourceLineNo">062</span> * &amp;lt;init-param&amp;gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * &amp;lt;param-name&amp;gt;staticSecurityManagerEnabled&amp;lt;/param-name&amp;gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> * &amp;lt;param-value&amp;gt;true&amp;lt;/param-value&amp;gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &amp;lt;/init-param&amp;gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * &amp;lt;/filter&amp;gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;/pre&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> * See the Shiro &lt;a href="http://shiro.apache.org/subject.html"&gt;Subject documentation&lt;/a&gt; for more information as to<a name="line.68"></a>
<span class="sourceLineNo">069</span> * if you would do this, particularly the sections on the {@code Subject.Builder} and Thread Association.<a name="line.69"></a>
<span class="sourceLineNo">070</span> *<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @since 1.0<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @see &lt;a href="http://shiro.apache.org/subject.html"&gt;Subject documentation&lt;/a&gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span>public abstract class AbstractShiroFilter extends OncePerRequestFilter {<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> private static final Logger log = LoggerFactory.getLogger(AbstractShiroFilter.class);<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> private static final String STATIC_INIT_PARAM_NAME = "staticSecurityManagerEnabled";<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> // Reference to the security manager used by this filter<a name="line.80"></a>
<span class="sourceLineNo">081</span> private WebSecurityManager securityManager;<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> // Used to determine which chain should handle an incoming request/response<a name="line.83"></a>
<span class="sourceLineNo">084</span> private FilterChainResolver filterChainResolver;<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> /**<a name="line.86"></a>
<span class="sourceLineNo">087</span> * Whether or not to bind the constructed SecurityManager instance to static memory (via<a name="line.87"></a>
<span class="sourceLineNo">088</span> * SecurityUtils.setSecurityManager). This was added to support https://issues.apache.org/jira/browse/SHIRO-287<a name="line.88"></a>
<span class="sourceLineNo">089</span> * @since 1.2<a name="line.89"></a>
<span class="sourceLineNo">090</span> */<a name="line.90"></a>
<span class="sourceLineNo">091</span> private boolean staticSecurityManagerEnabled;<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> protected AbstractShiroFilter() {<a name="line.93"></a>
<span class="sourceLineNo">094</span> this.staticSecurityManagerEnabled = false;<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> public WebSecurityManager getSecurityManager() {<a name="line.97"></a>
<span class="sourceLineNo">098</span> return securityManager;<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> public void setSecurityManager(WebSecurityManager sm) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> this.securityManager = sm;<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> public FilterChainResolver getFilterChainResolver() {<a name="line.105"></a>
<span class="sourceLineNo">106</span> return filterChainResolver;<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> public void setFilterChainResolver(FilterChainResolver filterChainResolver) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> this.filterChainResolver = filterChainResolver;<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
<span class="sourceLineNo">114</span> * Returns {@code true} if the constructed {@link #getSecurityManager() securityManager} reference should be bound<a name="line.114"></a>
<span class="sourceLineNo">115</span> * to static memory (via<a name="line.115"></a>
<span class="sourceLineNo">116</span> * {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}),<a name="line.116"></a>
<span class="sourceLineNo">117</span> * {@code false} otherwise.<a name="line.117"></a>
<span class="sourceLineNo">118</span> * &lt;p/&gt;<a name="line.118"></a>
<span class="sourceLineNo">119</span> * The default value is {@code false}.<a name="line.119"></a>
<span class="sourceLineNo">120</span> * &lt;p/&gt;<a name="line.120"></a>
<span class="sourceLineNo">121</span> *<a name="line.121"></a>
<span class="sourceLineNo">122</span> *<a name="line.122"></a>
<span class="sourceLineNo">123</span> * @return {@code true} if the constructed {@link #getSecurityManager() securityManager} reference should be bound<a name="line.123"></a>
<span class="sourceLineNo">124</span> * to static memory (via {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}),<a name="line.124"></a>
<span class="sourceLineNo">125</span> * {@code false} otherwise.<a name="line.125"></a>
<span class="sourceLineNo">126</span> * @since 1.2<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @see &lt;a href="https://issues.apache.org/jira/browse/SHIRO-287"&gt;SHIRO-287&lt;/a&gt;<a name="line.127"></a>
<span class="sourceLineNo">128</span> */<a name="line.128"></a>
<span class="sourceLineNo">129</span> public boolean isStaticSecurityManagerEnabled() {<a name="line.129"></a>
<span class="sourceLineNo">130</span> return staticSecurityManagerEnabled;<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> /**<a name="line.133"></a>
<span class="sourceLineNo">134</span> * Sets if the constructed {@link #getSecurityManager() securityManager} reference should be bound<a name="line.134"></a>
<span class="sourceLineNo">135</span> * to static memory (via {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}).<a name="line.135"></a>
<span class="sourceLineNo">136</span> * &lt;p/&gt;<a name="line.136"></a>
<span class="sourceLineNo">137</span> * The default value is {@code false}.<a name="line.137"></a>
<span class="sourceLineNo">138</span> *<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @param staticSecurityManagerEnabled if the constructed {@link #getSecurityManager() securityManager} reference<a name="line.139"></a>
<span class="sourceLineNo">140</span> * should be bound to static memory (via<a name="line.140"></a>
<span class="sourceLineNo">141</span> * {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}).<a name="line.141"></a>
<span class="sourceLineNo">142</span> * @since 1.2<a name="line.142"></a>
<span class="sourceLineNo">143</span> * @see &lt;a href="https://issues.apache.org/jira/browse/SHIRO-287"&gt;SHIRO-287&lt;/a&gt;<a name="line.143"></a>
<span class="sourceLineNo">144</span> */<a name="line.144"></a>
<span class="sourceLineNo">145</span> public void setStaticSecurityManagerEnabled(boolean staticSecurityManagerEnabled) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> this.staticSecurityManagerEnabled = staticSecurityManagerEnabled;<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> protected final void onFilterConfigSet() throws Exception {<a name="line.149"></a>
<span class="sourceLineNo">150</span> //added in 1.2 for SHIRO-287:<a name="line.150"></a>
<span class="sourceLineNo">151</span> applyStaticSecurityManagerEnabledConfig();<a name="line.151"></a>
<span class="sourceLineNo">152</span> init();<a name="line.152"></a>
<span class="sourceLineNo">153</span> ensureSecurityManager();<a name="line.153"></a>
<span class="sourceLineNo">154</span> //added in 1.2 for SHIRO-287:<a name="line.154"></a>
<span class="sourceLineNo">155</span> if (isStaticSecurityManagerEnabled()) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> SecurityUtils.setSecurityManager(getSecurityManager());<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> /**<a name="line.160"></a>
<span class="sourceLineNo">161</span> * Checks if the init-param that configures the filter to use static memory has been configured, and if so,<a name="line.161"></a>
<span class="sourceLineNo">162</span> * sets the {@link #setStaticSecurityManagerEnabled(boolean)} attribute with the configured value.<a name="line.162"></a>
<span class="sourceLineNo">163</span> *<a name="line.163"></a>
<span class="sourceLineNo">164</span> * @since 1.2<a name="line.164"></a>
<span class="sourceLineNo">165</span> * @see &lt;a href="https://issues.apache.org/jira/browse/SHIRO-287"&gt;SHIRO-287&lt;/a&gt;<a name="line.165"></a>
<span class="sourceLineNo">166</span> */<a name="line.166"></a>
<span class="sourceLineNo">167</span> private void applyStaticSecurityManagerEnabledConfig() {<a name="line.167"></a>
<span class="sourceLineNo">168</span> String value = getInitParam(STATIC_INIT_PARAM_NAME);<a name="line.168"></a>
<span class="sourceLineNo">169</span> if (value != null) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> Boolean b = Boolean.valueOf(value);<a name="line.170"></a>
<span class="sourceLineNo">171</span> if (b != null) {<a name="line.171"></a>
<span class="sourceLineNo">172</span> setStaticSecurityManagerEnabled(b);<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> public void init() throws Exception {<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> /**<a name="line.180"></a>
<span class="sourceLineNo">181</span> * A fallback mechanism called in {@link #onFilterConfigSet()} to ensure that the<a name="line.181"></a>
<span class="sourceLineNo">182</span> * {@link #getSecurityManager() securityManager} property has been set by configuration, and if not,<a name="line.182"></a>
<span class="sourceLineNo">183</span> * creates one automatically.<a name="line.183"></a>
<span class="sourceLineNo">184</span> */<a name="line.184"></a>
<span class="sourceLineNo">185</span> private void ensureSecurityManager() {<a name="line.185"></a>
<span class="sourceLineNo">186</span> WebSecurityManager securityManager = getSecurityManager();<a name="line.186"></a>
<span class="sourceLineNo">187</span> if (securityManager == null) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> log.info("No SecurityManager configured. Creating default.");<a name="line.188"></a>
<span class="sourceLineNo">189</span> securityManager = createDefaultSecurityManager();<a name="line.189"></a>
<span class="sourceLineNo">190</span> setSecurityManager(securityManager);<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span> protected WebSecurityManager createDefaultSecurityManager() {<a name="line.194"></a>
<span class="sourceLineNo">195</span> return new DefaultWebSecurityManager();<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span> protected boolean isHttpSessions() {<a name="line.198"></a>
<span class="sourceLineNo">199</span> return getSecurityManager().isHttpSessionMode();<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> /**<a name="line.202"></a>
<span class="sourceLineNo">203</span> * Wraps the original HttpServletRequest in a {@link ShiroHttpServletRequest}, which is required for supporting<a name="line.203"></a>
<span class="sourceLineNo">204</span> * Servlet Specification behavior backed by a {@link org.apache.shiro.subject.Subject Subject} instance.<a name="line.204"></a>
<span class="sourceLineNo">205</span> *<a name="line.205"></a>
<span class="sourceLineNo">206</span> * @param orig the original Servlet Container-provided incoming {@code HttpServletRequest} instance.<a name="line.206"></a>
<span class="sourceLineNo">207</span> * @return {@link ShiroHttpServletRequest ShiroHttpServletRequest} instance wrapping the original.<a name="line.207"></a>
<span class="sourceLineNo">208</span> * @since 1.0<a name="line.208"></a>
<span class="sourceLineNo">209</span> */<a name="line.209"></a>
<span class="sourceLineNo">210</span> protected ServletRequest wrapServletRequest(HttpServletRequest orig) {<a name="line.210"></a>
<span class="sourceLineNo">211</span> return new ShiroHttpServletRequest(orig, getServletContext(), isHttpSessions());<a name="line.211"></a>
<span class="sourceLineNo">212</span> }<a name="line.212"></a>
<span class="sourceLineNo">213</span><a name="line.213"></a>
<span class="sourceLineNo">214</span> /**<a name="line.214"></a>
<span class="sourceLineNo">215</span> * Prepares the {@code ServletRequest} instance that will be passed to the {@code FilterChain} for request<a name="line.215"></a>
<span class="sourceLineNo">216</span> * processing.<a name="line.216"></a>
<span class="sourceLineNo">217</span> * &lt;p/&gt;<a name="line.217"></a>
<span class="sourceLineNo">218</span> * If the {@code ServletRequest} is an instance of {@link HttpServletRequest}, the value returned from this method<a name="line.218"></a>
<span class="sourceLineNo">219</span> * is obtained by calling {@link #wrapServletRequest(javax.servlet.http.HttpServletRequest)} to allow Shiro-specific<a name="line.219"></a>
<span class="sourceLineNo">220</span> * HTTP behavior, otherwise the original {@code ServletRequest} argument is returned.<a name="line.220"></a>
<span class="sourceLineNo">221</span> *<a name="line.221"></a>
<span class="sourceLineNo">222</span> * @param request the incoming ServletRequest<a name="line.222"></a>
<span class="sourceLineNo">223</span> * @param response the outgoing ServletResponse<a name="line.223"></a>
<span class="sourceLineNo">224</span> * @param chain the Servlet Container provided {@code FilterChain} that will receive the returned request.<a name="line.224"></a>
<span class="sourceLineNo">225</span> * @return the {@code ServletRequest} instance that will be passed to the {@code FilterChain} for request processing.<a name="line.225"></a>
<span class="sourceLineNo">226</span> * @since 1.0<a name="line.226"></a>
<span class="sourceLineNo">227</span> */<a name="line.227"></a>
<span class="sourceLineNo">228</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.228"></a>
<span class="sourceLineNo">229</span> protected ServletRequest prepareServletRequest(ServletRequest request, ServletResponse response, FilterChain chain) {<a name="line.229"></a>
<span class="sourceLineNo">230</span> ServletRequest toUse = request;<a name="line.230"></a>
<span class="sourceLineNo">231</span> if (request instanceof HttpServletRequest) {<a name="line.231"></a>
<span class="sourceLineNo">232</span> HttpServletRequest http = (HttpServletRequest) request;<a name="line.232"></a>
<span class="sourceLineNo">233</span> toUse = wrapServletRequest(http);<a name="line.233"></a>
<span class="sourceLineNo">234</span> }<a name="line.234"></a>
<span class="sourceLineNo">235</span> return toUse;<a name="line.235"></a>
<span class="sourceLineNo">236</span> }<a name="line.236"></a>
<span class="sourceLineNo">237</span><a name="line.237"></a>
<span class="sourceLineNo">238</span> /**<a name="line.238"></a>
<span class="sourceLineNo">239</span> * Returns a new {@link ShiroHttpServletResponse} instance, wrapping the {@code orig} argument, in order to provide<a name="line.239"></a>
<span class="sourceLineNo">240</span> * correct URL rewriting behavior required by the Servlet Specification when using Shiro-based sessions (and not<a name="line.240"></a>
<span class="sourceLineNo">241</span> * Servlet Container HTTP-based sessions).<a name="line.241"></a>
<span class="sourceLineNo">242</span> *<a name="line.242"></a>
<span class="sourceLineNo">243</span> * @param orig the original {@code HttpServletResponse} instance provided by the Servlet Container.<a name="line.243"></a>
<span class="sourceLineNo">244</span> * @param request the {@code ShiroHttpServletRequest} instance wrapping the original request.<a name="line.244"></a>
<span class="sourceLineNo">245</span> * @return the wrapped ServletResponse instance to use during {@link FilterChain} execution.<a name="line.245"></a>
<span class="sourceLineNo">246</span> * @since 1.0<a name="line.246"></a>
<span class="sourceLineNo">247</span> */<a name="line.247"></a>
<span class="sourceLineNo">248</span> protected ServletResponse wrapServletResponse(HttpServletResponse orig, ShiroHttpServletRequest request) {<a name="line.248"></a>
<span class="sourceLineNo">249</span> return new ShiroHttpServletResponse(orig, getServletContext(), request);<a name="line.249"></a>
<span class="sourceLineNo">250</span> }<a name="line.250"></a>
<span class="sourceLineNo">251</span><a name="line.251"></a>
<span class="sourceLineNo">252</span> /**<a name="line.252"></a>
<span class="sourceLineNo">253</span> * Prepares the {@code ServletResponse} instance that will be passed to the {@code FilterChain} for request<a name="line.253"></a>
<span class="sourceLineNo">254</span> * processing.<a name="line.254"></a>
<span class="sourceLineNo">255</span> * &lt;p/&gt;<a name="line.255"></a>
<span class="sourceLineNo">256</span> * This implementation delegates to {@link #wrapServletRequest(javax.servlet.http.HttpServletRequest)}<a name="line.256"></a>
<span class="sourceLineNo">257</span> * only if Shiro-based sessions are enabled (that is, !{@link #isHttpSessions()}) and the request instance is a<a name="line.257"></a>
<span class="sourceLineNo">258</span> * {@link ShiroHttpServletRequest}. This ensures that any URL rewriting that occurs is handled correctly using the<a name="line.258"></a>
<span class="sourceLineNo">259</span> * Shiro-managed Session's sessionId and not a servlet container session ID.<a name="line.259"></a>
<span class="sourceLineNo">260</span> * &lt;p/&gt;<a name="line.260"></a>
<span class="sourceLineNo">261</span> * If HTTP-based sessions are enabled (the default), then this method does nothing and just returns the<a name="line.261"></a>
<span class="sourceLineNo">262</span> * {@code ServletResponse} argument as-is, relying on the default Servlet Container URL rewriting logic.<a name="line.262"></a>
<span class="sourceLineNo">263</span> *<a name="line.263"></a>
<span class="sourceLineNo">264</span> * @param request the incoming ServletRequest<a name="line.264"></a>
<span class="sourceLineNo">265</span> * @param response the outgoing ServletResponse<a name="line.265"></a>
<span class="sourceLineNo">266</span> * @param chain the Servlet Container provided {@code FilterChain} that will receive the returned request.<a name="line.266"></a>
<span class="sourceLineNo">267</span> * @return the {@code ServletResponse} instance that will be passed to the {@code FilterChain} during request processing.<a name="line.267"></a>
<span class="sourceLineNo">268</span> * @since 1.0<a name="line.268"></a>
<span class="sourceLineNo">269</span> */<a name="line.269"></a>
<span class="sourceLineNo">270</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.270"></a>
<span class="sourceLineNo">271</span> protected ServletResponse prepareServletResponse(ServletRequest request, ServletResponse response, FilterChain chain) {<a name="line.271"></a>
<span class="sourceLineNo">272</span> ServletResponse toUse = response;<a name="line.272"></a>
<span class="sourceLineNo">273</span> if (!isHttpSessions() &amp;&amp; (request instanceof ShiroHttpServletRequest) &amp;&amp;<a name="line.273"></a>
<span class="sourceLineNo">274</span> (response instanceof HttpServletResponse)) {<a name="line.274"></a>
<span class="sourceLineNo">275</span> //the ShiroHttpServletResponse exists to support URL rewriting for session ids. This is only needed if<a name="line.275"></a>
<span class="sourceLineNo">276</span> //using Shiro sessions (i.e. not simple HttpSession based sessions):<a name="line.276"></a>
<span class="sourceLineNo">277</span> toUse = wrapServletResponse((HttpServletResponse) response, (ShiroHttpServletRequest) request);<a name="line.277"></a>
<span class="sourceLineNo">278</span> }<a name="line.278"></a>
<span class="sourceLineNo">279</span> return toUse;<a name="line.279"></a>
<span class="sourceLineNo">280</span> }<a name="line.280"></a>
<span class="sourceLineNo">281</span><a name="line.281"></a>
<span class="sourceLineNo">282</span> /**<a name="line.282"></a>
<span class="sourceLineNo">283</span> * Creates a {@link WebSubject} instance to associate with the incoming request/response pair which will be used<a name="line.283"></a>
<span class="sourceLineNo">284</span> * throughout the request/response execution.<a name="line.284"></a>
<span class="sourceLineNo">285</span> *<a name="line.285"></a>
<span class="sourceLineNo">286</span> * @param request the incoming {@code ServletRequest}<a name="line.286"></a>
<span class="sourceLineNo">287</span> * @param response the outgoing {@code ServletResponse}<a name="line.287"></a>
<span class="sourceLineNo">288</span> * @return the {@code WebSubject} instance to associate with the request/response execution<a name="line.288"></a>
<span class="sourceLineNo">289</span> * @since 1.0<a name="line.289"></a>
<span class="sourceLineNo">290</span> */<a name="line.290"></a>
<span class="sourceLineNo">291</span> protected WebSubject createSubject(ServletRequest request, ServletResponse response) {<a name="line.291"></a>
<span class="sourceLineNo">292</span> return new WebSubject.Builder(getSecurityManager(), request, response).buildWebSubject();<a name="line.292"></a>
<span class="sourceLineNo">293</span> }<a name="line.293"></a>
<span class="sourceLineNo">294</span><a name="line.294"></a>
<span class="sourceLineNo">295</span> /**<a name="line.295"></a>
<span class="sourceLineNo">296</span> * Updates any 'native' Session's last access time that might exist to the timestamp when this method is called.<a name="line.296"></a>
<span class="sourceLineNo">297</span> * If native sessions are not enabled (that is, standard Servlet container sessions are being used) or there is no<a name="line.297"></a>
<span class="sourceLineNo">298</span> * session ({@code subject.getSession(false) == null}), this method does nothing.<a name="line.298"></a>
<span class="sourceLineNo">299</span> * &lt;p/&gt;This method implementation merely calls<a name="line.299"></a>
<span class="sourceLineNo">300</span> * &lt;code&gt;Session.{@link org.apache.shiro.session.Session#touch() touch}()&lt;/code&gt; on the session.<a name="line.300"></a>
<span class="sourceLineNo">301</span> *<a name="line.301"></a>
<span class="sourceLineNo">302</span> * @param request incoming request - ignored, but available to subclasses that might wish to override this method<a name="line.302"></a>
<span class="sourceLineNo">303</span> * @param response outgoing response - ignored, but available to subclasses that might wish to override this method<a name="line.303"></a>
<span class="sourceLineNo">304</span> * @since 1.0<a name="line.304"></a>
<span class="sourceLineNo">305</span> */<a name="line.305"></a>
<span class="sourceLineNo">306</span> @SuppressWarnings({"UnusedDeclaration"})<a name="line.306"></a>
<span class="sourceLineNo">307</span> protected void updateSessionLastAccessTime(ServletRequest request, ServletResponse response) {<a name="line.307"></a>
<span class="sourceLineNo">308</span> if (!isHttpSessions()) { //'native' sessions<a name="line.308"></a>
<span class="sourceLineNo">309</span> Subject subject = SecurityUtils.getSubject();<a name="line.309"></a>
<span class="sourceLineNo">310</span> //Subject should never _ever_ be null, but just in case:<a name="line.310"></a>
<span class="sourceLineNo">311</span> if (subject != null) {<a name="line.311"></a>
<span class="sourceLineNo">312</span> Session session = subject.getSession(false);<a name="line.312"></a>
<span class="sourceLineNo">313</span> if (session != null) {<a name="line.313"></a>
<span class="sourceLineNo">314</span> try {<a name="line.314"></a>
<span class="sourceLineNo">315</span> session.touch();<a name="line.315"></a>
<span class="sourceLineNo">316</span> } catch (Throwable t) {<a name="line.316"></a>
<span class="sourceLineNo">317</span> log.error("session.touch() method invocation has failed. Unable to update" +<a name="line.317"></a>
<span class="sourceLineNo">318</span> "the corresponding session's last access time based on the incoming request.", t);<a name="line.318"></a>
<span class="sourceLineNo">319</span> }<a name="line.319"></a>
<span class="sourceLineNo">320</span> }<a name="line.320"></a>
<span class="sourceLineNo">321</span> }<a name="line.321"></a>
<span class="sourceLineNo">322</span> }<a name="line.322"></a>
<span class="sourceLineNo">323</span> }<a name="line.323"></a>
<span class="sourceLineNo">324</span><a name="line.324"></a>
<span class="sourceLineNo">325</span> /**<a name="line.325"></a>
<span class="sourceLineNo">326</span> * {@code doFilterInternal} implementation that sets-up, executes, and cleans-up a Shiro-filtered request. It<a name="line.326"></a>
<span class="sourceLineNo">327</span> * performs the following ordered operations:<a name="line.327"></a>
<span class="sourceLineNo">328</span> * &lt;ol&gt;<a name="line.328"></a>
<span class="sourceLineNo">329</span> * &lt;li&gt;{@link #prepareServletRequest(ServletRequest, ServletResponse, FilterChain) Prepares}<a name="line.329"></a>
<span class="sourceLineNo">330</span> * the incoming {@code ServletRequest} for use during Shiro's processing&lt;/li&gt;<a name="line.330"></a>
<span class="sourceLineNo">331</span> * &lt;li&gt;{@link #prepareServletResponse(ServletRequest, ServletResponse, FilterChain) Prepares}<a name="line.331"></a>
<span class="sourceLineNo">332</span> * the outgoing {@code ServletResponse} for use during Shiro's processing&lt;/li&gt;<a name="line.332"></a>
<span class="sourceLineNo">333</span> * &lt;li&gt; {@link #createSubject(javax.servlet.ServletRequest, javax.servlet.ServletResponse) Creates} a<a name="line.333"></a>
<span class="sourceLineNo">334</span> * {@link Subject} instance based on the specified request/response pair.&lt;/li&gt;<a name="line.334"></a>
<span class="sourceLineNo">335</span> * &lt;li&gt;Finally {@link Subject#execute(Runnable) executes} the<a name="line.335"></a>
<span class="sourceLineNo">336</span> * {@link #updateSessionLastAccessTime(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} and<a name="line.336"></a>
<span class="sourceLineNo">337</span> * {@link #executeChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)}<a name="line.337"></a>
<span class="sourceLineNo">338</span> * methods&lt;/li&gt;<a name="line.338"></a>
<span class="sourceLineNo">339</span> * &lt;/ol&gt;<a name="line.339"></a>
<span class="sourceLineNo">340</span> * &lt;p/&gt;<a name="line.340"></a>
<span class="sourceLineNo">341</span> * The {@code Subject.}{@link Subject#execute(Runnable) execute(Runnable)} call in step #4 is used as an<a name="line.341"></a>
<span class="sourceLineNo">342</span> * implementation technique to guarantee proper thread binding and restoration is completed successfully.<a name="line.342"></a>
<span class="sourceLineNo">343</span> *<a name="line.343"></a>
<span class="sourceLineNo">344</span> * @param servletRequest the incoming {@code ServletRequest}<a name="line.344"></a>
<span class="sourceLineNo">345</span> * @param servletResponse the outgoing {@code ServletResponse}<a name="line.345"></a>
<span class="sourceLineNo">346</span> * @param chain the container-provided {@code FilterChain} to execute<a name="line.346"></a>
<span class="sourceLineNo">347</span> * @throws IOException if an IO error occurs<a name="line.347"></a>
<span class="sourceLineNo">348</span> * @throws javax.servlet.ServletException if an Throwable other than an IOException<a name="line.348"></a>
<span class="sourceLineNo">349</span> */<a name="line.349"></a>
<span class="sourceLineNo">350</span> protected void doFilterInternal(ServletRequest servletRequest, ServletResponse servletResponse, final FilterChain chain)<a name="line.350"></a>
<span class="sourceLineNo">351</span> throws ServletException, IOException {<a name="line.351"></a>
<span class="sourceLineNo">352</span><a name="line.352"></a>
<span class="sourceLineNo">353</span> Throwable t = null;<a name="line.353"></a>
<span class="sourceLineNo">354</span><a name="line.354"></a>
<span class="sourceLineNo">355</span> try {<a name="line.355"></a>
<span class="sourceLineNo">356</span> final ServletRequest request = prepareServletRequest(servletRequest, servletResponse, chain);<a name="line.356"></a>
<span class="sourceLineNo">357</span> final ServletResponse response = prepareServletResponse(request, servletResponse, chain);<a name="line.357"></a>
<span class="sourceLineNo">358</span><a name="line.358"></a>
<span class="sourceLineNo">359</span> final Subject subject = createSubject(request, response);<a name="line.359"></a>
<span class="sourceLineNo">360</span><a name="line.360"></a>
<span class="sourceLineNo">361</span> //noinspection unchecked<a name="line.361"></a>
<span class="sourceLineNo">362</span> subject.execute(new Callable() {<a name="line.362"></a>
<span class="sourceLineNo">363</span> public Object call() throws Exception {<a name="line.363"></a>
<span class="sourceLineNo">364</span> updateSessionLastAccessTime(request, response);<a name="line.364"></a>
<span class="sourceLineNo">365</span> executeChain(request, response, chain);<a name="line.365"></a>
<span class="sourceLineNo">366</span> return null;<a name="line.366"></a>
<span class="sourceLineNo">367</span> }<a name="line.367"></a>
<span class="sourceLineNo">368</span> });<a name="line.368"></a>
<span class="sourceLineNo">369</span> } catch (ExecutionException ex) {<a name="line.369"></a>
<span class="sourceLineNo">370</span> t = ex.getCause();<a name="line.370"></a>
<span class="sourceLineNo">371</span> } catch (Throwable throwable) {<a name="line.371"></a>
<span class="sourceLineNo">372</span> t = throwable;<a name="line.372"></a>
<span class="sourceLineNo">373</span> }<a name="line.373"></a>
<span class="sourceLineNo">374</span><a name="line.374"></a>
<span class="sourceLineNo">375</span> if (t != null) {<a name="line.375"></a>
<span class="sourceLineNo">376</span> if (t instanceof ServletException) {<a name="line.376"></a>
<span class="sourceLineNo">377</span> throw (ServletException) t;<a name="line.377"></a>
<span class="sourceLineNo">378</span> }<a name="line.378"></a>
<span class="sourceLineNo">379</span> if (t instanceof IOException) {<a name="line.379"></a>
<span class="sourceLineNo">380</span> throw (IOException) t;<a name="line.380"></a>
<span class="sourceLineNo">381</span> }<a name="line.381"></a>
<span class="sourceLineNo">382</span> //otherwise it's not one of the two exceptions expected by the filter method signature - wrap it in one:<a name="line.382"></a>
<span class="sourceLineNo">383</span> String msg = "Filtered request failed.";<a name="line.383"></a>
<span class="sourceLineNo">384</span> throw new ServletException(msg, t);<a name="line.384"></a>
<span class="sourceLineNo">385</span> }<a name="line.385"></a>
<span class="sourceLineNo">386</span> }<a name="line.386"></a>
<span class="sourceLineNo">387</span><a name="line.387"></a>
<span class="sourceLineNo">388</span> /**<a name="line.388"></a>
<span class="sourceLineNo">389</span> * Returns the {@code FilterChain} to execute for the given request.<a name="line.389"></a>
<span class="sourceLineNo">390</span> * &lt;p/&gt;<a name="line.390"></a>
<span class="sourceLineNo">391</span> * The {@code origChain} argument is the<a name="line.391"></a>
<span class="sourceLineNo">392</span> * original {@code FilterChain} supplied by the Servlet Container, but it may be modified to provide<a name="line.392"></a>
<span class="sourceLineNo">393</span> * more behavior by pre-pending further chains according to the Shiro configuration.<a name="line.393"></a>
<span class="sourceLineNo">394</span> * &lt;p/&gt;<a name="line.394"></a>
<span class="sourceLineNo">395</span> * This implementation returns the chain that will actually be executed by acquiring the chain from a<a name="line.395"></a>
<span class="sourceLineNo">396</span> * {@link #getFilterChainResolver() filterChainResolver}. The resolver determines exactly which chain to<a name="line.396"></a>
<span class="sourceLineNo">397</span> * execute, typically based on URL configuration. If no chain is returned from the resolver call<a name="line.397"></a>
<span class="sourceLineNo">398</span> * (returns {@code null}), then the {@code origChain} will be returned by default.<a name="line.398"></a>
<span class="sourceLineNo">399</span> *<a name="line.399"></a>
<span class="sourceLineNo">400</span> * @param request the incoming ServletRequest<a name="line.400"></a>
<span class="sourceLineNo">401</span> * @param response the outgoing ServletResponse<a name="line.401"></a>
<span class="sourceLineNo">402</span> * @param origChain the original {@code FilterChain} provided by the Servlet Container<a name="line.402"></a>
<span class="sourceLineNo">403</span> * @return the {@link FilterChain} to execute for the given request<a name="line.403"></a>
<span class="sourceLineNo">404</span> * @since 1.0<a name="line.404"></a>
<span class="sourceLineNo">405</span> */<a name="line.405"></a>
<span class="sourceLineNo">406</span> protected FilterChain getExecutionChain(ServletRequest request, ServletResponse response, FilterChain origChain) {<a name="line.406"></a>
<span class="sourceLineNo">407</span> FilterChain chain = origChain;<a name="line.407"></a>
<span class="sourceLineNo">408</span><a name="line.408"></a>
<span class="sourceLineNo">409</span> FilterChainResolver resolver = getFilterChainResolver();<a name="line.409"></a>
<span class="sourceLineNo">410</span> if (resolver == null) {<a name="line.410"></a>
<span class="sourceLineNo">411</span> log.debug("No FilterChainResolver configured. Returning original FilterChain.");<a name="line.411"></a>
<span class="sourceLineNo">412</span> return origChain;<a name="line.412"></a>
<span class="sourceLineNo">413</span> }<a name="line.413"></a>
<span class="sourceLineNo">414</span><a name="line.414"></a>
<span class="sourceLineNo">415</span> FilterChain resolved = resolver.getChain(request, response, origChain);<a name="line.415"></a>
<span class="sourceLineNo">416</span> if (resolved != null) {<a name="line.416"></a>
<span class="sourceLineNo">417</span> log.trace("Resolved a configured FilterChain for the current request.");<a name="line.417"></a>
<span class="sourceLineNo">418</span> chain = resolved;<a name="line.418"></a>
<span class="sourceLineNo">419</span> } else {<a name="line.419"></a>
<span class="sourceLineNo">420</span> log.trace("No FilterChain configured for the current request. Using the default.");<a name="line.420"></a>
<span class="sourceLineNo">421</span> }<a name="line.421"></a>
<span class="sourceLineNo">422</span><a name="line.422"></a>
<span class="sourceLineNo">423</span> return chain;<a name="line.423"></a>
<span class="sourceLineNo">424</span> }<a name="line.424"></a>
<span class="sourceLineNo">425</span><a name="line.425"></a>
<span class="sourceLineNo">426</span> /**<a name="line.426"></a>
<span class="sourceLineNo">427</span> * Executes a {@link FilterChain} for the given request.<a name="line.427"></a>
<span class="sourceLineNo">428</span> * &lt;p/&gt;<a name="line.428"></a>
<span class="sourceLineNo">429</span> * This implementation first delegates to<a name="line.429"></a>
<span class="sourceLineNo">430</span> * &lt;code&gt;{@link #getExecutionChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain) getExecutionChain}&lt;/code&gt;<a name="line.430"></a>
<span class="sourceLineNo">431</span> * to allow the application's Shiro configuration to determine exactly how the chain should execute. The resulting<a name="line.431"></a>
<span class="sourceLineNo">432</span> * value from that call is then executed directly by calling the returned {@code FilterChain}'s<a name="line.432"></a>
<span class="sourceLineNo">433</span> * {@link FilterChain#doFilter doFilter} method. That is:<a name="line.433"></a>
<span class="sourceLineNo">434</span> * &lt;pre&gt;<a name="line.434"></a>
<span class="sourceLineNo">435</span> * FilterChain chain = {@link #getExecutionChain}(request, response, origChain);<a name="line.435"></a>
<span class="sourceLineNo">436</span> * chain.{@link FilterChain#doFilter doFilter}(request,response);&lt;/pre&gt;<a name="line.436"></a>
<span class="sourceLineNo">437</span> *<a name="line.437"></a>
<span class="sourceLineNo">438</span> * @param request the incoming ServletRequest<a name="line.438"></a>
<span class="sourceLineNo">439</span> * @param response the outgoing ServletResponse<a name="line.439"></a>
<span class="sourceLineNo">440</span> * @param origChain the Servlet Container-provided chain that may be wrapped further by an application-configured<a name="line.440"></a>
<span class="sourceLineNo">441</span> * chain of Filters.<a name="line.441"></a>
<span class="sourceLineNo">442</span> * @throws IOException if the underlying {@code chain.doFilter} call results in an IOException<a name="line.442"></a>
<span class="sourceLineNo">443</span> * @throws ServletException if the underlying {@code chain.doFilter} call results in a ServletException<a name="line.443"></a>
<span class="sourceLineNo">444</span> * @since 1.0<a name="line.444"></a>
<span class="sourceLineNo">445</span> */<a name="line.445"></a>
<span class="sourceLineNo">446</span> protected void executeChain(ServletRequest request, ServletResponse response, FilterChain origChain)<a name="line.446"></a>
<span class="sourceLineNo">447</span> throws IOException, ServletException {<a name="line.447"></a>
<span class="sourceLineNo">448</span> FilterChain chain = getExecutionChain(request, response, origChain);<a name="line.448"></a>
<span class="sourceLineNo">449</span> chain.doFilter(request, response);<a name="line.449"></a>
<span class="sourceLineNo">450</span> }<a name="line.450"></a>
<span class="sourceLineNo">451</span>}<a name="line.451"></a>
</pre>
</div>
</body>
</html>