blob: fa2ecc0e2a1debe2ab0248efc875f41d2f485dcd [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.web.mgt;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.codec.Base64;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.mgt.AbstractRememberMeManager;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.subject.Subject;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.subject.SubjectContext;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.web.servlet.Cookie;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.web.servlet.ShiroHttpServletRequest;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.shiro.web.servlet.SimpleCookie;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.shiro.web.subject.WebSubject;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.shiro.web.subject.WebSubjectContext;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.shiro.web.util.WebUtils;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.slf4j.Logger;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.slf4j.LoggerFactory;<a name="line.32"></a>
<FONT color="green">033</FONT> <a name="line.33"></a>
<FONT color="green">034</FONT> import javax.servlet.ServletRequest;<a name="line.34"></a>
<FONT color="green">035</FONT> import javax.servlet.http.HttpServletRequest;<a name="line.35"></a>
<FONT color="green">036</FONT> import javax.servlet.http.HttpServletResponse;<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> /**<a name="line.39"></a>
<FONT color="green">040</FONT> * Remembers a Subject's identity by saving the Subject's {@link Subject#getPrincipals() principals} to a {@link Cookie}<a name="line.40"></a>
<FONT color="green">041</FONT> * for later retrieval.<a name="line.41"></a>
<FONT color="green">042</FONT> * &lt;p/&gt;<a name="line.42"></a>
<FONT color="green">043</FONT> * Cookie attributes (path, domain, maxAge, etc) may be set on this class's default<a name="line.43"></a>
<FONT color="green">044</FONT> * {@link #getCookie() cookie} attribute, which acts as a template to use to set all properties of outgoing cookies<a name="line.44"></a>
<FONT color="green">045</FONT> * created by this implementation.<a name="line.45"></a>
<FONT color="green">046</FONT> * &lt;p/&gt;<a name="line.46"></a>
<FONT color="green">047</FONT> * The default cookie has the following attribute values set:<a name="line.47"></a>
<FONT color="green">048</FONT> * &lt;table&gt;<a name="line.48"></a>
<FONT color="green">049</FONT> * &lt;tr&gt;<a name="line.49"></a>
<FONT color="green">050</FONT> * &lt;th&gt;Attribute Name&lt;/th&gt;<a name="line.50"></a>
<FONT color="green">051</FONT> * &lt;th&gt;Value&lt;/th&gt;<a name="line.51"></a>
<FONT color="green">052</FONT> * &lt;/tr&gt;<a name="line.52"></a>
<FONT color="green">053</FONT> * &lt;tr&gt;&lt;td&gt;{@link Cookie#getName() name}&lt;/td&gt;<a name="line.53"></a>
<FONT color="green">054</FONT> * &lt;td&gt;{@code rememberMe}&lt;/td&gt;<a name="line.54"></a>
<FONT color="green">055</FONT> * &lt;/tr&gt;<a name="line.55"></a>
<FONT color="green">056</FONT> * &lt;tr&gt;<a name="line.56"></a>
<FONT color="green">057</FONT> * &lt;td&gt;{@link Cookie#getPath() path}&lt;/td&gt;<a name="line.57"></a>
<FONT color="green">058</FONT> * &lt;td&gt;{@code /}&lt;/td&gt;<a name="line.58"></a>
<FONT color="green">059</FONT> * &lt;/tr&gt;<a name="line.59"></a>
<FONT color="green">060</FONT> * &lt;tr&gt;<a name="line.60"></a>
<FONT color="green">061</FONT> * &lt;td&gt;{@link Cookie#getMaxAge() maxAge}&lt;/td&gt;<a name="line.61"></a>
<FONT color="green">062</FONT> * &lt;td&gt;{@link Cookie#ONE_YEAR Cookie.ONE_YEAR}&lt;/td&gt;<a name="line.62"></a>
<FONT color="green">063</FONT> * &lt;/tr&gt;<a name="line.63"></a>
<FONT color="green">064</FONT> * &lt;/table&gt;<a name="line.64"></a>
<FONT color="green">065</FONT> * &lt;p/&gt;<a name="line.65"></a>
<FONT color="green">066</FONT> * Note that because this class subclasses the {@link AbstractRememberMeManager} which already provides serialization<a name="line.66"></a>
<FONT color="green">067</FONT> * and encryption logic, this class utilizes both for added security before setting the cookie value.<a name="line.67"></a>
<FONT color="green">068</FONT> *<a name="line.68"></a>
<FONT color="green">069</FONT> * @since 1.0<a name="line.69"></a>
<FONT color="green">070</FONT> */<a name="line.70"></a>
<FONT color="green">071</FONT> public class CookieRememberMeManager extends AbstractRememberMeManager {<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> //TODO - complete JavaDoc<a name="line.73"></a>
<FONT color="green">074</FONT> <a name="line.74"></a>
<FONT color="green">075</FONT> private static transient final Logger log = LoggerFactory.getLogger(CookieRememberMeManager.class);<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> /**<a name="line.77"></a>
<FONT color="green">078</FONT> * The default name of the underlying rememberMe cookie which is {@code rememberMe}.<a name="line.78"></a>
<FONT color="green">079</FONT> */<a name="line.79"></a>
<FONT color="green">080</FONT> public static final String DEFAULT_REMEMBER_ME_COOKIE_NAME = "rememberMe";<a name="line.80"></a>
<FONT color="green">081</FONT> <a name="line.81"></a>
<FONT color="green">082</FONT> private Cookie cookie;<a name="line.82"></a>
<FONT color="green">083</FONT> <a name="line.83"></a>
<FONT color="green">084</FONT> /**<a name="line.84"></a>
<FONT color="green">085</FONT> * Constructs a new {@code CookieRememberMeManager} with a default {@code rememberMe} cookie template.<a name="line.85"></a>
<FONT color="green">086</FONT> */<a name="line.86"></a>
<FONT color="green">087</FONT> public CookieRememberMeManager() {<a name="line.87"></a>
<FONT color="green">088</FONT> Cookie cookie = new SimpleCookie(DEFAULT_REMEMBER_ME_COOKIE_NAME);<a name="line.88"></a>
<FONT color="green">089</FONT> cookie.setHttpOnly(true);<a name="line.89"></a>
<FONT color="green">090</FONT> //One year should be long enough - most sites won't object to requiring a user to log in if they haven't visited<a name="line.90"></a>
<FONT color="green">091</FONT> //in a year:<a name="line.91"></a>
<FONT color="green">092</FONT> cookie.setMaxAge(Cookie.ONE_YEAR);<a name="line.92"></a>
<FONT color="green">093</FONT> this.cookie = cookie;<a name="line.93"></a>
<FONT color="green">094</FONT> }<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> /**<a name="line.96"></a>
<FONT color="green">097</FONT> * Returns the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by<a name="line.97"></a>
<FONT color="green">098</FONT> * this {@code RememberMeManager}. Outgoing cookies will match this one except for the<a name="line.98"></a>
<FONT color="green">099</FONT> * {@link Cookie#getValue() value} attribute, which is necessarily set dynamically at runtime.<a name="line.99"></a>
<FONT color="green">100</FONT> * &lt;p/&gt;<a name="line.100"></a>
<FONT color="green">101</FONT> * Please see the class-level JavaDoc for the default cookie's attribute values.<a name="line.101"></a>
<FONT color="green">102</FONT> *<a name="line.102"></a>
<FONT color="green">103</FONT> * @return the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by<a name="line.103"></a>
<FONT color="green">104</FONT> * this {@code RememberMeManager}.<a name="line.104"></a>
<FONT color="green">105</FONT> */<a name="line.105"></a>
<FONT color="green">106</FONT> public Cookie getCookie() {<a name="line.106"></a>
<FONT color="green">107</FONT> return cookie;<a name="line.107"></a>
<FONT color="green">108</FONT> }<a name="line.108"></a>
<FONT color="green">109</FONT> <a name="line.109"></a>
<FONT color="green">110</FONT> /**<a name="line.110"></a>
<FONT color="green">111</FONT> * Sets the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created by<a name="line.111"></a>
<FONT color="green">112</FONT> * this {@code RememberMeManager}. Outgoing cookies will match this one except for the<a name="line.112"></a>
<FONT color="green">113</FONT> * {@link Cookie#getValue() value} attribute, which is necessarily set dynamically at runtime.<a name="line.113"></a>
<FONT color="green">114</FONT> * &lt;p/&gt;<a name="line.114"></a>
<FONT color="green">115</FONT> * Please see the class-level JavaDoc for the default cookie's attribute values.<a name="line.115"></a>
<FONT color="green">116</FONT> *<a name="line.116"></a>
<FONT color="green">117</FONT> * @param cookie the cookie 'template' that will be used to set all attributes of outgoing rememberMe cookies created<a name="line.117"></a>
<FONT color="green">118</FONT> * by this {@code RememberMeManager}.<a name="line.118"></a>
<FONT color="green">119</FONT> */<a name="line.119"></a>
<FONT color="green">120</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.120"></a>
<FONT color="green">121</FONT> public void setCookie(Cookie cookie) {<a name="line.121"></a>
<FONT color="green">122</FONT> this.cookie = cookie;<a name="line.122"></a>
<FONT color="green">123</FONT> }<a name="line.123"></a>
<FONT color="green">124</FONT> <a name="line.124"></a>
<FONT color="green">125</FONT> /**<a name="line.125"></a>
<FONT color="green">126</FONT> * Base64-encodes the specified serialized byte array and sets that base64-encoded String as the cookie value.<a name="line.126"></a>
<FONT color="green">127</FONT> * &lt;p/&gt;<a name="line.127"></a>
<FONT color="green">128</FONT> * The {@code subject} instance is expected to be a {@link WebSubject} instance with an HTTP Request/Response pair<a name="line.128"></a>
<FONT color="green">129</FONT> * so an HTTP cookie can be set on the outgoing response. If it is not a {@code WebSubject} or that<a name="line.129"></a>
<FONT color="green">130</FONT> * {@code WebSubject} does not have an HTTP Request/Response pair, this implementation does nothing.<a name="line.130"></a>
<FONT color="green">131</FONT> *<a name="line.131"></a>
<FONT color="green">132</FONT> * @param subject the Subject for which the identity is being serialized.<a name="line.132"></a>
<FONT color="green">133</FONT> * @param serialized the serialized bytes to be persisted.<a name="line.133"></a>
<FONT color="green">134</FONT> */<a name="line.134"></a>
<FONT color="green">135</FONT> protected void rememberSerializedIdentity(Subject subject, byte[] serialized) {<a name="line.135"></a>
<FONT color="green">136</FONT> <a name="line.136"></a>
<FONT color="green">137</FONT> if (!WebUtils.isHttp(subject)) {<a name="line.137"></a>
<FONT color="green">138</FONT> if (log.isDebugEnabled()) {<a name="line.138"></a>
<FONT color="green">139</FONT> String msg = "Subject argument is not an HTTP-aware instance. This is required to obtain a servlet " +<a name="line.139"></a>
<FONT color="green">140</FONT> "request and response in order to set the rememberMe cookie. Returning immediately and " +<a name="line.140"></a>
<FONT color="green">141</FONT> "ignoring rememberMe operation.";<a name="line.141"></a>
<FONT color="green">142</FONT> log.debug(msg);<a name="line.142"></a>
<FONT color="green">143</FONT> }<a name="line.143"></a>
<FONT color="green">144</FONT> return;<a name="line.144"></a>
<FONT color="green">145</FONT> }<a name="line.145"></a>
<FONT color="green">146</FONT> <a name="line.146"></a>
<FONT color="green">147</FONT> <a name="line.147"></a>
<FONT color="green">148</FONT> HttpServletRequest request = WebUtils.getHttpRequest(subject);<a name="line.148"></a>
<FONT color="green">149</FONT> HttpServletResponse response = WebUtils.getHttpResponse(subject);<a name="line.149"></a>
<FONT color="green">150</FONT> <a name="line.150"></a>
<FONT color="green">151</FONT> //base 64 encode it and store as a cookie:<a name="line.151"></a>
<FONT color="green">152</FONT> String base64 = Base64.encodeToString(serialized);<a name="line.152"></a>
<FONT color="green">153</FONT> <a name="line.153"></a>
<FONT color="green">154</FONT> Cookie template = getCookie(); //the class attribute is really a template for the outgoing cookies<a name="line.154"></a>
<FONT color="green">155</FONT> Cookie cookie = new SimpleCookie(template);<a name="line.155"></a>
<FONT color="green">156</FONT> cookie.setValue(base64);<a name="line.156"></a>
<FONT color="green">157</FONT> cookie.saveTo(request, response);<a name="line.157"></a>
<FONT color="green">158</FONT> }<a name="line.158"></a>
<FONT color="green">159</FONT> <a name="line.159"></a>
<FONT color="green">160</FONT> private boolean isIdentityRemoved(WebSubjectContext subjectContext) {<a name="line.160"></a>
<FONT color="green">161</FONT> ServletRequest request = subjectContext.resolveServletRequest();<a name="line.161"></a>
<FONT color="green">162</FONT> if (request != null) {<a name="line.162"></a>
<FONT color="green">163</FONT> Boolean removed = (Boolean) request.getAttribute(ShiroHttpServletRequest.IDENTITY_REMOVED_KEY);<a name="line.163"></a>
<FONT color="green">164</FONT> return removed != null &amp;&amp; removed;<a name="line.164"></a>
<FONT color="green">165</FONT> }<a name="line.165"></a>
<FONT color="green">166</FONT> return false;<a name="line.166"></a>
<FONT color="green">167</FONT> }<a name="line.167"></a>
<FONT color="green">168</FONT> <a name="line.168"></a>
<FONT color="green">169</FONT> <a name="line.169"></a>
<FONT color="green">170</FONT> /**<a name="line.170"></a>
<FONT color="green">171</FONT> * Returns a previously serialized identity byte array or {@code null} if the byte array could not be acquired.<a name="line.171"></a>
<FONT color="green">172</FONT> * This implementation retrieves an HTTP cookie, Base64-decodes the cookie value, and returns the resulting byte<a name="line.172"></a>
<FONT color="green">173</FONT> * array.<a name="line.173"></a>
<FONT color="green">174</FONT> * &lt;p/&gt;<a name="line.174"></a>
<FONT color="green">175</FONT> * The {@code SubjectContext} instance is expected to be a {@link WebSubjectContext} instance with an HTTP<a name="line.175"></a>
<FONT color="green">176</FONT> * Request/Response pair so an HTTP cookie can be retrieved from the incoming request. If it is not a<a name="line.176"></a>
<FONT color="green">177</FONT> * {@code WebSubjectContext} or that {@code WebSubjectContext} does not have an HTTP Request/Response pair, this<a name="line.177"></a>
<FONT color="green">178</FONT> * implementation returns {@code null}.<a name="line.178"></a>
<FONT color="green">179</FONT> *<a name="line.179"></a>
<FONT color="green">180</FONT> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation, that<a name="line.180"></a>
<FONT color="green">181</FONT> * is being used to construct a {@link Subject} instance. To be used to assist with data<a name="line.181"></a>
<FONT color="green">182</FONT> * lookup.<a name="line.182"></a>
<FONT color="green">183</FONT> * @return a previously serialized identity byte array or {@code null} if the byte array could not be acquired.<a name="line.183"></a>
<FONT color="green">184</FONT> */<a name="line.184"></a>
<FONT color="green">185</FONT> protected byte[] getRememberedSerializedIdentity(SubjectContext subjectContext) {<a name="line.185"></a>
<FONT color="green">186</FONT> <a name="line.186"></a>
<FONT color="green">187</FONT> if (!WebUtils.isHttp(subjectContext)) {<a name="line.187"></a>
<FONT color="green">188</FONT> if (log.isDebugEnabled()) {<a name="line.188"></a>
<FONT color="green">189</FONT> String msg = "SubjectContext argument is not an HTTP-aware instance. This is required to obtain a " +<a name="line.189"></a>
<FONT color="green">190</FONT> "servlet request and response in order to retrieve the rememberMe cookie. Returning " +<a name="line.190"></a>
<FONT color="green">191</FONT> "immediately and ignoring rememberMe operation.";<a name="line.191"></a>
<FONT color="green">192</FONT> log.debug(msg);<a name="line.192"></a>
<FONT color="green">193</FONT> }<a name="line.193"></a>
<FONT color="green">194</FONT> return null;<a name="line.194"></a>
<FONT color="green">195</FONT> }<a name="line.195"></a>
<FONT color="green">196</FONT> <a name="line.196"></a>
<FONT color="green">197</FONT> WebSubjectContext wsc = (WebSubjectContext) subjectContext;<a name="line.197"></a>
<FONT color="green">198</FONT> if (isIdentityRemoved(wsc)) {<a name="line.198"></a>
<FONT color="green">199</FONT> return null;<a name="line.199"></a>
<FONT color="green">200</FONT> }<a name="line.200"></a>
<FONT color="green">201</FONT> <a name="line.201"></a>
<FONT color="green">202</FONT> HttpServletRequest request = WebUtils.getHttpRequest(wsc);<a name="line.202"></a>
<FONT color="green">203</FONT> HttpServletResponse response = WebUtils.getHttpResponse(wsc);<a name="line.203"></a>
<FONT color="green">204</FONT> <a name="line.204"></a>
<FONT color="green">205</FONT> String base64 = getCookie().readValue(request, response);<a name="line.205"></a>
<FONT color="green">206</FONT> // Browsers do not always remove cookies immediately (SHIRO-183)<a name="line.206"></a>
<FONT color="green">207</FONT> // ignore cookies that are scheduled for removal<a name="line.207"></a>
<FONT color="green">208</FONT> if (Cookie.DELETED_COOKIE_VALUE.equals(base64)) return null;<a name="line.208"></a>
<FONT color="green">209</FONT> <a name="line.209"></a>
<FONT color="green">210</FONT> if (base64 != null) {<a name="line.210"></a>
<FONT color="green">211</FONT> base64 = ensurePadding(base64);<a name="line.211"></a>
<FONT color="green">212</FONT> if (log.isTraceEnabled()) {<a name="line.212"></a>
<FONT color="green">213</FONT> log.trace("Acquired Base64 encoded identity [" + base64 + "]");<a name="line.213"></a>
<FONT color="green">214</FONT> }<a name="line.214"></a>
<FONT color="green">215</FONT> byte[] decoded = Base64.decode(base64);<a name="line.215"></a>
<FONT color="green">216</FONT> if (log.isTraceEnabled()) {<a name="line.216"></a>
<FONT color="green">217</FONT> log.trace("Base64 decoded byte array length: " + (decoded != null ? decoded.length : 0) + " bytes.");<a name="line.217"></a>
<FONT color="green">218</FONT> }<a name="line.218"></a>
<FONT color="green">219</FONT> return decoded;<a name="line.219"></a>
<FONT color="green">220</FONT> } else {<a name="line.220"></a>
<FONT color="green">221</FONT> //no cookie set - new site visitor?<a name="line.221"></a>
<FONT color="green">222</FONT> return null;<a name="line.222"></a>
<FONT color="green">223</FONT> }<a name="line.223"></a>
<FONT color="green">224</FONT> }<a name="line.224"></a>
<FONT color="green">225</FONT> <a name="line.225"></a>
<FONT color="green">226</FONT> /**<a name="line.226"></a>
<FONT color="green">227</FONT> * Sometimes a user agent will send the rememberMe cookie value without padding,<a name="line.227"></a>
<FONT color="green">228</FONT> * most likely because {@code =} is a separator in the cookie header.<a name="line.228"></a>
<FONT color="green">229</FONT> * &lt;p/&gt;<a name="line.229"></a>
<FONT color="green">230</FONT> * Contributed by Luis Arias. Thanks Luis!<a name="line.230"></a>
<FONT color="green">231</FONT> *<a name="line.231"></a>
<FONT color="green">232</FONT> * @param base64 the base64 encoded String that may need to be padded<a name="line.232"></a>
<FONT color="green">233</FONT> * @return the base64 String padded if necessary.<a name="line.233"></a>
<FONT color="green">234</FONT> */<a name="line.234"></a>
<FONT color="green">235</FONT> private String ensurePadding(String base64) {<a name="line.235"></a>
<FONT color="green">236</FONT> int length = base64.length();<a name="line.236"></a>
<FONT color="green">237</FONT> if (length % 4 != 0) {<a name="line.237"></a>
<FONT color="green">238</FONT> StringBuilder sb = new StringBuilder(base64);<a name="line.238"></a>
<FONT color="green">239</FONT> for (int i = 0; i &lt; length % 4; ++i) {<a name="line.239"></a>
<FONT color="green">240</FONT> sb.append('=');<a name="line.240"></a>
<FONT color="green">241</FONT> }<a name="line.241"></a>
<FONT color="green">242</FONT> base64 = sb.toString();<a name="line.242"></a>
<FONT color="green">243</FONT> }<a name="line.243"></a>
<FONT color="green">244</FONT> return base64;<a name="line.244"></a>
<FONT color="green">245</FONT> }<a name="line.245"></a>
<FONT color="green">246</FONT> <a name="line.246"></a>
<FONT color="green">247</FONT> /**<a name="line.247"></a>
<FONT color="green">248</FONT> * Removes the 'rememberMe' cookie from the associated {@link WebSubject}'s request/response pair.<a name="line.248"></a>
<FONT color="green">249</FONT> * &lt;p/&gt;<a name="line.249"></a>
<FONT color="green">250</FONT> * The {@code subject} instance is expected to be a {@link WebSubject} instance with an HTTP Request/Response pair.<a name="line.250"></a>
<FONT color="green">251</FONT> * If it is not a {@code WebSubject} or that {@code WebSubject} does not have an HTTP Request/Response pair, this<a name="line.251"></a>
<FONT color="green">252</FONT> * implementation does nothing.<a name="line.252"></a>
<FONT color="green">253</FONT> *<a name="line.253"></a>
<FONT color="green">254</FONT> * @param subject the subject instance for which identity data should be forgotten from the underlying persistence<a name="line.254"></a>
<FONT color="green">255</FONT> */<a name="line.255"></a>
<FONT color="green">256</FONT> protected void forgetIdentity(Subject subject) {<a name="line.256"></a>
<FONT color="green">257</FONT> if (WebUtils.isHttp(subject)) {<a name="line.257"></a>
<FONT color="green">258</FONT> HttpServletRequest request = WebUtils.getHttpRequest(subject);<a name="line.258"></a>
<FONT color="green">259</FONT> HttpServletResponse response = WebUtils.getHttpResponse(subject);<a name="line.259"></a>
<FONT color="green">260</FONT> forgetIdentity(request, response);<a name="line.260"></a>
<FONT color="green">261</FONT> }<a name="line.261"></a>
<FONT color="green">262</FONT> }<a name="line.262"></a>
<FONT color="green">263</FONT> <a name="line.263"></a>
<FONT color="green">264</FONT> /**<a name="line.264"></a>
<FONT color="green">265</FONT> * Removes the 'rememberMe' cookie from the associated {@link WebSubjectContext}'s request/response pair.<a name="line.265"></a>
<FONT color="green">266</FONT> * &lt;p/&gt;<a name="line.266"></a>
<FONT color="green">267</FONT> * The {@code SubjectContext} instance is expected to be a {@link WebSubjectContext} instance with an HTTP<a name="line.267"></a>
<FONT color="green">268</FONT> * Request/Response pair. If it is not a {@code WebSubjectContext} or that {@code WebSubjectContext} does not<a name="line.268"></a>
<FONT color="green">269</FONT> * have an HTTP Request/Response pair, this implementation does nothing.<a name="line.269"></a>
<FONT color="green">270</FONT> *<a name="line.270"></a>
<FONT color="green">271</FONT> * @param subjectContext the contextual data, usually provided by a {@link Subject.Builder} implementation<a name="line.271"></a>
<FONT color="green">272</FONT> */<a name="line.272"></a>
<FONT color="green">273</FONT> public void forgetIdentity(SubjectContext subjectContext) {<a name="line.273"></a>
<FONT color="green">274</FONT> if (WebUtils.isHttp(subjectContext)) {<a name="line.274"></a>
<FONT color="green">275</FONT> HttpServletRequest request = WebUtils.getHttpRequest(subjectContext);<a name="line.275"></a>
<FONT color="green">276</FONT> HttpServletResponse response = WebUtils.getHttpResponse(subjectContext);<a name="line.276"></a>
<FONT color="green">277</FONT> forgetIdentity(request, response);<a name="line.277"></a>
<FONT color="green">278</FONT> }<a name="line.278"></a>
<FONT color="green">279</FONT> }<a name="line.279"></a>
<FONT color="green">280</FONT> <a name="line.280"></a>
<FONT color="green">281</FONT> /**<a name="line.281"></a>
<FONT color="green">282</FONT> * Removes the rememberMe cookie from the given request/response pair.<a name="line.282"></a>
<FONT color="green">283</FONT> *<a name="line.283"></a>
<FONT color="green">284</FONT> * @param request the incoming HTTP servlet request<a name="line.284"></a>
<FONT color="green">285</FONT> * @param response the outgoing HTTP servlet response<a name="line.285"></a>
<FONT color="green">286</FONT> */<a name="line.286"></a>
<FONT color="green">287</FONT> private void forgetIdentity(HttpServletRequest request, HttpServletResponse response) {<a name="line.287"></a>
<FONT color="green">288</FONT> getCookie().removeFrom(request, response);<a name="line.288"></a>
<FONT color="green">289</FONT> }<a name="line.289"></a>
<FONT color="green">290</FONT> }<a name="line.290"></a>
<FONT color="green">291</FONT> <a name="line.291"></a>
</PRE>
</BODY>
</HTML>