blob: cac9cc5362e775659b251b33705a6a77016d8273 [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.session.mgt;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.session.ExpiredSessionException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.shiro.session.InvalidSessionException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.shiro.session.StoppedSessionException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.shiro.util.CollectionUtils;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.slf4j.Logger;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.slf4j.LoggerFactory;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.io.IOException;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.io.ObjectInputStream;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.io.ObjectOutputStream;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.io.Serializable;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.text.DateFormat;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.*;<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>/**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Simple {@link org.apache.shiro.session.Session} JavaBeans-compatible POJO implementation, intended to be used on the<a name="line.37"></a>
<span class="sourceLineNo">038</span> * business/server tier.<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @since 0.1<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span>public class SimpleSession implements ValidatingSession, Serializable {<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> // Serialization reminder:<a name="line.44"></a>
<span class="sourceLineNo">045</span> // You _MUST_ change this number if you introduce a change to this class<a name="line.45"></a>
<span class="sourceLineNo">046</span> // that is NOT serialization backwards compatible. Serialization-compatible<a name="line.46"></a>
<span class="sourceLineNo">047</span> // changes do not require a change to this number. If you need to generate<a name="line.47"></a>
<span class="sourceLineNo">048</span> // a new number in this case, use the JDK's 'serialver' program to generate it.<a name="line.48"></a>
<span class="sourceLineNo">049</span> private static final long serialVersionUID = -7125642695178165650L;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> //TODO - complete JavaDoc<a name="line.51"></a>
<span class="sourceLineNo">052</span> private transient static final Logger log = LoggerFactory.getLogger(SimpleSession.class);<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> protected static final long MILLIS_PER_SECOND = 1000;<a name="line.54"></a>
<span class="sourceLineNo">055</span> protected static final long MILLIS_PER_MINUTE = 60 * MILLIS_PER_SECOND;<a name="line.55"></a>
<span class="sourceLineNo">056</span> protected static final long MILLIS_PER_HOUR = 60 * MILLIS_PER_MINUTE;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> //serialization bitmask fields. DO NOT CHANGE THE ORDER THEY ARE DECLARED!<a name="line.58"></a>
<span class="sourceLineNo">059</span> static int bitIndexCounter = 0;<a name="line.59"></a>
<span class="sourceLineNo">060</span> private static final int ID_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;<a name="line.60"></a>
<span class="sourceLineNo">061</span> private static final int START_TIMESTAMP_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;<a name="line.61"></a>
<span class="sourceLineNo">062</span> private static final int STOP_TIMESTAMP_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;<a name="line.62"></a>
<span class="sourceLineNo">063</span> private static final int LAST_ACCESS_TIME_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;<a name="line.63"></a>
<span class="sourceLineNo">064</span> private static final int TIMEOUT_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;<a name="line.64"></a>
<span class="sourceLineNo">065</span> private static final int EXPIRED_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;<a name="line.65"></a>
<span class="sourceLineNo">066</span> private static final int HOST_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;<a name="line.66"></a>
<span class="sourceLineNo">067</span> private static final int ATTRIBUTES_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> // ==============================================================<a name="line.69"></a>
<span class="sourceLineNo">070</span> // NOTICE:<a name="line.70"></a>
<span class="sourceLineNo">071</span> //<a name="line.71"></a>
<span class="sourceLineNo">072</span> // The following fields are marked as transient to avoid double-serialization.<a name="line.72"></a>
<span class="sourceLineNo">073</span> // They are in fact serialized (even though 'transient' usually indicates otherwise),<a name="line.73"></a>
<span class="sourceLineNo">074</span> // but they are serialized explicitly via the writeObject and readObject implementations<a name="line.74"></a>
<span class="sourceLineNo">075</span> // in this class.<a name="line.75"></a>
<span class="sourceLineNo">076</span> //<a name="line.76"></a>
<span class="sourceLineNo">077</span> // If we didn't declare them as transient, the out.defaultWriteObject(); call in writeObject would<a name="line.77"></a>
<span class="sourceLineNo">078</span> // serialize all non-transient fields as well, effectively doubly serializing the fields (also<a name="line.78"></a>
<span class="sourceLineNo">079</span> // doubling the serialization size).<a name="line.79"></a>
<span class="sourceLineNo">080</span> //<a name="line.80"></a>
<span class="sourceLineNo">081</span> // This finding, with discussion, was covered here:<a name="line.81"></a>
<span class="sourceLineNo">082</span> //<a name="line.82"></a>
<span class="sourceLineNo">083</span> // http://mail-archives.apache.org/mod_mbox/shiro-user/201109.mbox/%3C4E81BCBD.8060909@metaphysis.net%3E<a name="line.83"></a>
<span class="sourceLineNo">084</span> //<a name="line.84"></a>
<span class="sourceLineNo">085</span> // ==============================================================<a name="line.85"></a>
<span class="sourceLineNo">086</span> private transient Serializable id;<a name="line.86"></a>
<span class="sourceLineNo">087</span> private transient Date startTimestamp;<a name="line.87"></a>
<span class="sourceLineNo">088</span> private transient Date stopTimestamp;<a name="line.88"></a>
<span class="sourceLineNo">089</span> private transient Date lastAccessTime;<a name="line.89"></a>
<span class="sourceLineNo">090</span> private transient long timeout;<a name="line.90"></a>
<span class="sourceLineNo">091</span> private transient boolean expired;<a name="line.91"></a>
<span class="sourceLineNo">092</span> private transient String host;<a name="line.92"></a>
<span class="sourceLineNo">093</span> private transient Map&lt;Object, Object&gt; attributes;<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> public SimpleSession() {<a name="line.95"></a>
<span class="sourceLineNo">096</span> this.timeout = DefaultSessionManager.DEFAULT_GLOBAL_SESSION_TIMEOUT; //TODO - remove concrete reference to DefaultSessionManager<a name="line.96"></a>
<span class="sourceLineNo">097</span> this.startTimestamp = new Date();<a name="line.97"></a>
<span class="sourceLineNo">098</span> this.lastAccessTime = this.startTimestamp;<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 SimpleSession(String host) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> this();<a name="line.102"></a>
<span class="sourceLineNo">103</span> this.host = host;<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> public Serializable getId() {<a name="line.106"></a>
<span class="sourceLineNo">107</span> return this.id;<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> public void setId(Serializable id) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> this.id = id;<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> public Date getStartTimestamp() {<a name="line.114"></a>
<span class="sourceLineNo">115</span> return startTimestamp;<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> public void setStartTimestamp(Date startTimestamp) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> this.startTimestamp = startTimestamp;<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<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> * Returns the time the session was stopped, or &lt;tt&gt;null&lt;/tt&gt; if the session is still active.<a name="line.123"></a>
<span class="sourceLineNo">124</span> * &lt;p/&gt;<a name="line.124"></a>
<span class="sourceLineNo">125</span> * A session may become stopped under a number of conditions:<a name="line.125"></a>
<span class="sourceLineNo">126</span> * &lt;ul&gt;<a name="line.126"></a>
<span class="sourceLineNo">127</span> * &lt;li&gt;If the user logs out of the system, their current session is terminated (released).&lt;/li&gt;<a name="line.127"></a>
<span class="sourceLineNo">128</span> * &lt;li&gt;If the session expires&lt;/li&gt;<a name="line.128"></a>
<span class="sourceLineNo">129</span> * &lt;li&gt;The application explicitly calls {@link #stop()}&lt;/li&gt;<a name="line.129"></a>
<span class="sourceLineNo">130</span> * &lt;li&gt;If there is an internal system error and the session state can no longer accurately<a name="line.130"></a>
<span class="sourceLineNo">131</span> * reflect the user's behavior, such in the case of a system crash&lt;/li&gt;<a name="line.131"></a>
<span class="sourceLineNo">132</span> * &lt;/ul&gt;<a name="line.132"></a>
<span class="sourceLineNo">133</span> * &lt;p/&gt;<a name="line.133"></a>
<span class="sourceLineNo">134</span> * Once stopped, a session may no longer be used. It is locked from all further activity.<a name="line.134"></a>
<span class="sourceLineNo">135</span> *<a name="line.135"></a>
<span class="sourceLineNo">136</span> * @return The time the session was stopped, or &lt;tt&gt;null&lt;/tt&gt; if the session is still<a name="line.136"></a>
<span class="sourceLineNo">137</span> * active.<a name="line.137"></a>
<span class="sourceLineNo">138</span> */<a name="line.138"></a>
<span class="sourceLineNo">139</span> public Date getStopTimestamp() {<a name="line.139"></a>
<span class="sourceLineNo">140</span> return stopTimestamp;<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> public void setStopTimestamp(Date stopTimestamp) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> this.stopTimestamp = stopTimestamp;<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> public Date getLastAccessTime() {<a name="line.147"></a>
<span class="sourceLineNo">148</span> return lastAccessTime;<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> public void setLastAccessTime(Date lastAccessTime) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> this.lastAccessTime = lastAccessTime;<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> /**<a name="line.155"></a>
<span class="sourceLineNo">156</span> * Returns true if this session has expired, false otherwise. If the session has<a name="line.156"></a>
<span class="sourceLineNo">157</span> * expired, no further user interaction with the system may be done under this session.<a name="line.157"></a>
<span class="sourceLineNo">158</span> *<a name="line.158"></a>
<span class="sourceLineNo">159</span> * @return true if this session has expired, false otherwise.<a name="line.159"></a>
<span class="sourceLineNo">160</span> */<a name="line.160"></a>
<span class="sourceLineNo">161</span> public boolean isExpired() {<a name="line.161"></a>
<span class="sourceLineNo">162</span> return expired;<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> public void setExpired(boolean expired) {<a name="line.165"></a>
<span class="sourceLineNo">166</span> this.expired = expired;<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> public long getTimeout() {<a name="line.169"></a>
<span class="sourceLineNo">170</span> return timeout;<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> public void setTimeout(long timeout) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> this.timeout = timeout;<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 String getHost() {<a name="line.177"></a>
<span class="sourceLineNo">178</span> return host;<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> public void setHost(String host) {<a name="line.181"></a>
<span class="sourceLineNo">182</span> this.host = host;<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span> public Map&lt;Object, Object&gt; getAttributes() {<a name="line.185"></a>
<span class="sourceLineNo">186</span> return attributes;<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span> public void setAttributes(Map&lt;Object, Object&gt; attributes) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> this.attributes = attributes;<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> public void touch() {<a name="line.193"></a>
<span class="sourceLineNo">194</span> this.lastAccessTime = new Date();<a name="line.194"></a>
<span class="sourceLineNo">195</span> }<a name="line.195"></a>
<span class="sourceLineNo">196</span><a name="line.196"></a>
<span class="sourceLineNo">197</span> public void stop() {<a name="line.197"></a>
<span class="sourceLineNo">198</span> if (this.stopTimestamp == null) {<a name="line.198"></a>
<span class="sourceLineNo">199</span> this.stopTimestamp = new Date();<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> protected boolean isStopped() {<a name="line.203"></a>
<span class="sourceLineNo">204</span> return getStopTimestamp() != null;<a name="line.204"></a>
<span class="sourceLineNo">205</span> }<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span> protected void expire() {<a name="line.207"></a>
<span class="sourceLineNo">208</span> stop();<a name="line.208"></a>
<span class="sourceLineNo">209</span> this.expired = true;<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span> /**<a name="line.212"></a>
<span class="sourceLineNo">213</span> * @since 0.9<a name="line.213"></a>
<span class="sourceLineNo">214</span> */<a name="line.214"></a>
<span class="sourceLineNo">215</span> public boolean isValid() {<a name="line.215"></a>
<span class="sourceLineNo">216</span> return !isStopped() &amp;&amp; !isExpired();<a name="line.216"></a>
<span class="sourceLineNo">217</span> }<a name="line.217"></a>
<span class="sourceLineNo">218</span><a name="line.218"></a>
<span class="sourceLineNo">219</span> /**<a name="line.219"></a>
<span class="sourceLineNo">220</span> * Determines if this session is expired.<a name="line.220"></a>
<span class="sourceLineNo">221</span> *<a name="line.221"></a>
<span class="sourceLineNo">222</span> * @return true if the specified session has expired, false otherwise.<a name="line.222"></a>
<span class="sourceLineNo">223</span> */<a name="line.223"></a>
<span class="sourceLineNo">224</span> protected boolean isTimedOut() {<a name="line.224"></a>
<span class="sourceLineNo">225</span><a name="line.225"></a>
<span class="sourceLineNo">226</span> if (isExpired()) {<a name="line.226"></a>
<span class="sourceLineNo">227</span> return true;<a name="line.227"></a>
<span class="sourceLineNo">228</span> }<a name="line.228"></a>
<span class="sourceLineNo">229</span><a name="line.229"></a>
<span class="sourceLineNo">230</span> long timeout = getTimeout();<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span> if (timeout &gt;= 0l) {<a name="line.232"></a>
<span class="sourceLineNo">233</span><a name="line.233"></a>
<span class="sourceLineNo">234</span> Date lastAccessTime = getLastAccessTime();<a name="line.234"></a>
<span class="sourceLineNo">235</span><a name="line.235"></a>
<span class="sourceLineNo">236</span> if (lastAccessTime == null) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> String msg = "session.lastAccessTime for session with id [" +<a name="line.237"></a>
<span class="sourceLineNo">238</span> getId() + "] is null. This value must be set at " +<a name="line.238"></a>
<span class="sourceLineNo">239</span> "least once, preferably at least upon instantiation. Please check the " +<a name="line.239"></a>
<span class="sourceLineNo">240</span> getClass().getName() + " implementation and ensure " +<a name="line.240"></a>
<span class="sourceLineNo">241</span> "this value will be set (perhaps in the constructor?)";<a name="line.241"></a>
<span class="sourceLineNo">242</span> throw new IllegalStateException(msg);<a name="line.242"></a>
<span class="sourceLineNo">243</span> }<a name="line.243"></a>
<span class="sourceLineNo">244</span><a name="line.244"></a>
<span class="sourceLineNo">245</span> // Calculate at what time a session would have been last accessed<a name="line.245"></a>
<span class="sourceLineNo">246</span> // for it to be expired at this point. In other words, subtract<a name="line.246"></a>
<span class="sourceLineNo">247</span> // from the current time the amount of time that a session can<a name="line.247"></a>
<span class="sourceLineNo">248</span> // be inactive before expiring. If the session was last accessed<a name="line.248"></a>
<span class="sourceLineNo">249</span> // before this time, it is expired.<a name="line.249"></a>
<span class="sourceLineNo">250</span> long expireTimeMillis = System.currentTimeMillis() - timeout;<a name="line.250"></a>
<span class="sourceLineNo">251</span> Date expireTime = new Date(expireTimeMillis);<a name="line.251"></a>
<span class="sourceLineNo">252</span> return lastAccessTime.before(expireTime);<a name="line.252"></a>
<span class="sourceLineNo">253</span> } else {<a name="line.253"></a>
<span class="sourceLineNo">254</span> if (log.isTraceEnabled()) {<a name="line.254"></a>
<span class="sourceLineNo">255</span> log.trace("No timeout for session with id [" + getId() +<a name="line.255"></a>
<span class="sourceLineNo">256</span> "]. Session is not considered expired.");<a name="line.256"></a>
<span class="sourceLineNo">257</span> }<a name="line.257"></a>
<span class="sourceLineNo">258</span> }<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span> return false;<a name="line.260"></a>
<span class="sourceLineNo">261</span> }<a name="line.261"></a>
<span class="sourceLineNo">262</span><a name="line.262"></a>
<span class="sourceLineNo">263</span> public void validate() throws InvalidSessionException {<a name="line.263"></a>
<span class="sourceLineNo">264</span> //check for stopped:<a name="line.264"></a>
<span class="sourceLineNo">265</span> if (isStopped()) {<a name="line.265"></a>
<span class="sourceLineNo">266</span> //timestamp is set, so the session is considered stopped:<a name="line.266"></a>
<span class="sourceLineNo">267</span> String msg = "Session with id [" + getId() + "] has been " +<a name="line.267"></a>
<span class="sourceLineNo">268</span> "explicitly stopped. No further interaction under this session is " +<a name="line.268"></a>
<span class="sourceLineNo">269</span> "allowed.";<a name="line.269"></a>
<span class="sourceLineNo">270</span> throw new StoppedSessionException(msg);<a name="line.270"></a>
<span class="sourceLineNo">271</span> }<a name="line.271"></a>
<span class="sourceLineNo">272</span><a name="line.272"></a>
<span class="sourceLineNo">273</span> //check for expiration<a name="line.273"></a>
<span class="sourceLineNo">274</span> if (isTimedOut()) {<a name="line.274"></a>
<span class="sourceLineNo">275</span> expire();<a name="line.275"></a>
<span class="sourceLineNo">276</span><a name="line.276"></a>
<span class="sourceLineNo">277</span> //throw an exception explaining details of why it expired:<a name="line.277"></a>
<span class="sourceLineNo">278</span> Date lastAccessTime = getLastAccessTime();<a name="line.278"></a>
<span class="sourceLineNo">279</span> long timeout = getTimeout();<a name="line.279"></a>
<span class="sourceLineNo">280</span><a name="line.280"></a>
<span class="sourceLineNo">281</span> Serializable sessionId = getId();<a name="line.281"></a>
<span class="sourceLineNo">282</span><a name="line.282"></a>
<span class="sourceLineNo">283</span> DateFormat df = DateFormat.getInstance();<a name="line.283"></a>
<span class="sourceLineNo">284</span> String msg = "Session with id [" + sessionId + "] has expired. " +<a name="line.284"></a>
<span class="sourceLineNo">285</span> "Last access time: " + df.format(lastAccessTime) +<a name="line.285"></a>
<span class="sourceLineNo">286</span> ". Current time: " + df.format(new Date()) +<a name="line.286"></a>
<span class="sourceLineNo">287</span> ". Session timeout is set to " + timeout / MILLIS_PER_SECOND + " seconds (" +<a name="line.287"></a>
<span class="sourceLineNo">288</span> timeout / MILLIS_PER_MINUTE + " minutes)";<a name="line.288"></a>
<span class="sourceLineNo">289</span> if (log.isTraceEnabled()) {<a name="line.289"></a>
<span class="sourceLineNo">290</span> log.trace(msg);<a name="line.290"></a>
<span class="sourceLineNo">291</span> }<a name="line.291"></a>
<span class="sourceLineNo">292</span> throw new ExpiredSessionException(msg);<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> private Map&lt;Object, Object&gt; getAttributesLazy() {<a name="line.296"></a>
<span class="sourceLineNo">297</span> Map&lt;Object, Object&gt; attributes = getAttributes();<a name="line.297"></a>
<span class="sourceLineNo">298</span> if (attributes == null) {<a name="line.298"></a>
<span class="sourceLineNo">299</span> attributes = new HashMap&lt;Object, Object&gt;();<a name="line.299"></a>
<span class="sourceLineNo">300</span> setAttributes(attributes);<a name="line.300"></a>
<span class="sourceLineNo">301</span> }<a name="line.301"></a>
<span class="sourceLineNo">302</span> return attributes;<a name="line.302"></a>
<span class="sourceLineNo">303</span> }<a name="line.303"></a>
<span class="sourceLineNo">304</span><a name="line.304"></a>
<span class="sourceLineNo">305</span> public Collection&lt;Object&gt; getAttributeKeys() throws InvalidSessionException {<a name="line.305"></a>
<span class="sourceLineNo">306</span> Map&lt;Object, Object&gt; attributes = getAttributes();<a name="line.306"></a>
<span class="sourceLineNo">307</span> if (attributes == null) {<a name="line.307"></a>
<span class="sourceLineNo">308</span> return Collections.emptySet();<a name="line.308"></a>
<span class="sourceLineNo">309</span> }<a name="line.309"></a>
<span class="sourceLineNo">310</span> return attributes.keySet();<a name="line.310"></a>
<span class="sourceLineNo">311</span> }<a name="line.311"></a>
<span class="sourceLineNo">312</span><a name="line.312"></a>
<span class="sourceLineNo">313</span> public Object getAttribute(Object key) {<a name="line.313"></a>
<span class="sourceLineNo">314</span> Map&lt;Object, Object&gt; attributes = getAttributes();<a name="line.314"></a>
<span class="sourceLineNo">315</span> if (attributes == null) {<a name="line.315"></a>
<span class="sourceLineNo">316</span> return null;<a name="line.316"></a>
<span class="sourceLineNo">317</span> }<a name="line.317"></a>
<span class="sourceLineNo">318</span> return attributes.get(key);<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> public void setAttribute(Object key, Object value) {<a name="line.321"></a>
<span class="sourceLineNo">322</span> if (value == null) {<a name="line.322"></a>
<span class="sourceLineNo">323</span> removeAttribute(key);<a name="line.323"></a>
<span class="sourceLineNo">324</span> } else {<a name="line.324"></a>
<span class="sourceLineNo">325</span> getAttributesLazy().put(key, value);<a name="line.325"></a>
<span class="sourceLineNo">326</span> }<a name="line.326"></a>
<span class="sourceLineNo">327</span> }<a name="line.327"></a>
<span class="sourceLineNo">328</span><a name="line.328"></a>
<span class="sourceLineNo">329</span> public Object removeAttribute(Object key) {<a name="line.329"></a>
<span class="sourceLineNo">330</span> Map&lt;Object, Object&gt; attributes = getAttributes();<a name="line.330"></a>
<span class="sourceLineNo">331</span> if (attributes == null) {<a name="line.331"></a>
<span class="sourceLineNo">332</span> return null;<a name="line.332"></a>
<span class="sourceLineNo">333</span> } else {<a name="line.333"></a>
<span class="sourceLineNo">334</span> return attributes.remove(key);<a name="line.334"></a>
<span class="sourceLineNo">335</span> }<a name="line.335"></a>
<span class="sourceLineNo">336</span> }<a name="line.336"></a>
<span class="sourceLineNo">337</span><a name="line.337"></a>
<span class="sourceLineNo">338</span> /**<a name="line.338"></a>
<span class="sourceLineNo">339</span> * Returns {@code true} if the specified argument is an {@code instanceof} {@code SimpleSession} and both<a name="line.339"></a>
<span class="sourceLineNo">340</span> * {@link #getId() id}s are equal. If the argument is a {@code SimpleSession} and either 'this' or the argument<a name="line.340"></a>
<span class="sourceLineNo">341</span> * does not yet have an ID assigned, the value of {@link #onEquals(SimpleSession) onEquals} is returned, which<a name="line.341"></a>
<span class="sourceLineNo">342</span> * does a necessary attribute-based comparison when IDs are not available.<a name="line.342"></a>
<span class="sourceLineNo">343</span> * &lt;p/&gt;<a name="line.343"></a>
<span class="sourceLineNo">344</span> * Do your best to ensure {@code SimpleSession} instances receive an ID very early in their lifecycle to<a name="line.344"></a>
<span class="sourceLineNo">345</span> * avoid the more expensive attributes-based comparison.<a name="line.345"></a>
<span class="sourceLineNo">346</span> *<a name="line.346"></a>
<span class="sourceLineNo">347</span> * @param obj the object to compare with this one for equality.<a name="line.347"></a>
<span class="sourceLineNo">348</span> * @return {@code true} if this object is equivalent to the specified argument, {@code false} otherwise.<a name="line.348"></a>
<span class="sourceLineNo">349</span> */<a name="line.349"></a>
<span class="sourceLineNo">350</span> @Override<a name="line.350"></a>
<span class="sourceLineNo">351</span> public boolean equals(Object obj) {<a name="line.351"></a>
<span class="sourceLineNo">352</span> if (this == obj) {<a name="line.352"></a>
<span class="sourceLineNo">353</span> return true;<a name="line.353"></a>
<span class="sourceLineNo">354</span> }<a name="line.354"></a>
<span class="sourceLineNo">355</span> if (obj instanceof SimpleSession) {<a name="line.355"></a>
<span class="sourceLineNo">356</span> SimpleSession other = (SimpleSession) obj;<a name="line.356"></a>
<span class="sourceLineNo">357</span> Serializable thisId = getId();<a name="line.357"></a>
<span class="sourceLineNo">358</span> Serializable otherId = other.getId();<a name="line.358"></a>
<span class="sourceLineNo">359</span> if (thisId != null &amp;&amp; otherId != null) {<a name="line.359"></a>
<span class="sourceLineNo">360</span> return thisId.equals(otherId);<a name="line.360"></a>
<span class="sourceLineNo">361</span> } else {<a name="line.361"></a>
<span class="sourceLineNo">362</span> //fall back to an attribute based comparison:<a name="line.362"></a>
<span class="sourceLineNo">363</span> return onEquals(other);<a name="line.363"></a>
<span class="sourceLineNo">364</span> }<a name="line.364"></a>
<span class="sourceLineNo">365</span> }<a name="line.365"></a>
<span class="sourceLineNo">366</span> return false;<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> /**<a name="line.369"></a>
<span class="sourceLineNo">370</span> * Provides an attribute-based comparison (no ID comparison) - incurred &lt;em&gt;only&lt;/em&gt; when 'this' or the<a name="line.370"></a>
<span class="sourceLineNo">371</span> * session object being compared for equality do not have a session id.<a name="line.371"></a>
<span class="sourceLineNo">372</span> *<a name="line.372"></a>
<span class="sourceLineNo">373</span> * @param ss the SimpleSession instance to compare for equality.<a name="line.373"></a>
<span class="sourceLineNo">374</span> * @return true if all the attributes, except the id, are equal to this object's attributes.<a name="line.374"></a>
<span class="sourceLineNo">375</span> * @since 1.0<a name="line.375"></a>
<span class="sourceLineNo">376</span> */<a name="line.376"></a>
<span class="sourceLineNo">377</span> protected boolean onEquals(SimpleSession ss) {<a name="line.377"></a>
<span class="sourceLineNo">378</span> return (getStartTimestamp() != null ? getStartTimestamp().equals(ss.getStartTimestamp()) : ss.getStartTimestamp() == null) &amp;&amp;<a name="line.378"></a>
<span class="sourceLineNo">379</span> (getStopTimestamp() != null ? getStopTimestamp().equals(ss.getStopTimestamp()) : ss.getStopTimestamp() == null) &amp;&amp;<a name="line.379"></a>
<span class="sourceLineNo">380</span> (getLastAccessTime() != null ? getLastAccessTime().equals(ss.getLastAccessTime()) : ss.getLastAccessTime() == null) &amp;&amp;<a name="line.380"></a>
<span class="sourceLineNo">381</span> (getTimeout() == ss.getTimeout()) &amp;&amp;<a name="line.381"></a>
<span class="sourceLineNo">382</span> (isExpired() == ss.isExpired()) &amp;&amp;<a name="line.382"></a>
<span class="sourceLineNo">383</span> (getHost() != null ? getHost().equals(ss.getHost()) : ss.getHost() == null) &amp;&amp;<a name="line.383"></a>
<span class="sourceLineNo">384</span> (getAttributes() != null ? getAttributes().equals(ss.getAttributes()) : ss.getAttributes() == null);<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> * Returns the hashCode. If the {@link #getId() id} is not {@code null}, its hashcode is returned immediately.<a name="line.388"></a>
<span class="sourceLineNo">389</span> * If it is {@code null}, an attributes-based hashCode will be calculated and returned.<a name="line.389"></a>
<span class="sourceLineNo">390</span> * &lt;p/&gt;<a name="line.390"></a>
<span class="sourceLineNo">391</span> * Do your best to ensure {@code SimpleSession} instances receive an ID very early in their lifecycle to<a name="line.391"></a>
<span class="sourceLineNo">392</span> * avoid the more expensive attributes-based calculation.<a name="line.392"></a>
<span class="sourceLineNo">393</span> *<a name="line.393"></a>
<span class="sourceLineNo">394</span> * @return this object's hashCode<a name="line.394"></a>
<span class="sourceLineNo">395</span> * @since 1.0<a name="line.395"></a>
<span class="sourceLineNo">396</span> */<a name="line.396"></a>
<span class="sourceLineNo">397</span> @Override<a name="line.397"></a>
<span class="sourceLineNo">398</span> public int hashCode() {<a name="line.398"></a>
<span class="sourceLineNo">399</span> Serializable id = getId();<a name="line.399"></a>
<span class="sourceLineNo">400</span> if (id != null) {<a name="line.400"></a>
<span class="sourceLineNo">401</span> return id.hashCode();<a name="line.401"></a>
<span class="sourceLineNo">402</span> }<a name="line.402"></a>
<span class="sourceLineNo">403</span> int hashCode = getStartTimestamp() != null ? getStartTimestamp().hashCode() : 0;<a name="line.403"></a>
<span class="sourceLineNo">404</span> hashCode = 31 * hashCode + (getStopTimestamp() != null ? getStopTimestamp().hashCode() : 0);<a name="line.404"></a>
<span class="sourceLineNo">405</span> hashCode = 31 * hashCode + (getLastAccessTime() != null ? getLastAccessTime().hashCode() : 0);<a name="line.405"></a>
<span class="sourceLineNo">406</span> hashCode = 31 * hashCode + Long.valueOf(Math.max(getTimeout(), 0)).hashCode();<a name="line.406"></a>
<span class="sourceLineNo">407</span> hashCode = 31 * hashCode + Boolean.valueOf(isExpired()).hashCode();<a name="line.407"></a>
<span class="sourceLineNo">408</span> hashCode = 31 * hashCode + (getHost() != null ? getHost().hashCode() : 0);<a name="line.408"></a>
<span class="sourceLineNo">409</span> hashCode = 31 * hashCode + (getAttributes() != null ? getAttributes().hashCode() : 0);<a name="line.409"></a>
<span class="sourceLineNo">410</span> return hashCode;<a name="line.410"></a>
<span class="sourceLineNo">411</span> }<a name="line.411"></a>
<span class="sourceLineNo">412</span><a name="line.412"></a>
<span class="sourceLineNo">413</span> /**<a name="line.413"></a>
<span class="sourceLineNo">414</span> * Returns the string representation of this SimpleSession, equal to<a name="line.414"></a>
<span class="sourceLineNo">415</span> * &lt;code&gt;getClass().getName() + &amp;quot;,id=&amp;quot; + getId()&lt;/code&gt;.<a name="line.415"></a>
<span class="sourceLineNo">416</span> *<a name="line.416"></a>
<span class="sourceLineNo">417</span> * @return the string representation of this SimpleSession, equal to<a name="line.417"></a>
<span class="sourceLineNo">418</span> * &lt;code&gt;getClass().getName() + &amp;quot;,id=&amp;quot; + getId()&lt;/code&gt;.<a name="line.418"></a>
<span class="sourceLineNo">419</span> * @since 1.0<a name="line.419"></a>
<span class="sourceLineNo">420</span> */<a name="line.420"></a>
<span class="sourceLineNo">421</span> @Override<a name="line.421"></a>
<span class="sourceLineNo">422</span> public String toString() {<a name="line.422"></a>
<span class="sourceLineNo">423</span> StringBuilder sb = new StringBuilder();<a name="line.423"></a>
<span class="sourceLineNo">424</span> sb.append(getClass().getName()).append(",id=").append(getId());<a name="line.424"></a>
<span class="sourceLineNo">425</span> return sb.toString();<a name="line.425"></a>
<span class="sourceLineNo">426</span> }<a name="line.426"></a>
<span class="sourceLineNo">427</span><a name="line.427"></a>
<span class="sourceLineNo">428</span> /**<a name="line.428"></a>
<span class="sourceLineNo">429</span> * Serializes this object to the specified output stream for JDK Serialization.<a name="line.429"></a>
<span class="sourceLineNo">430</span> *<a name="line.430"></a>
<span class="sourceLineNo">431</span> * @param out output stream used for Object serialization.<a name="line.431"></a>
<span class="sourceLineNo">432</span> * @throws IOException if any of this object's fields cannot be written to the stream.<a name="line.432"></a>
<span class="sourceLineNo">433</span> * @since 1.0<a name="line.433"></a>
<span class="sourceLineNo">434</span> */<a name="line.434"></a>
<span class="sourceLineNo">435</span> private void writeObject(ObjectOutputStream out) throws IOException {<a name="line.435"></a>
<span class="sourceLineNo">436</span> out.defaultWriteObject();<a name="line.436"></a>
<span class="sourceLineNo">437</span> short alteredFieldsBitMask = getAlteredFieldsBitMask();<a name="line.437"></a>
<span class="sourceLineNo">438</span> out.writeShort(alteredFieldsBitMask);<a name="line.438"></a>
<span class="sourceLineNo">439</span> if (id != null) {<a name="line.439"></a>
<span class="sourceLineNo">440</span> out.writeObject(id);<a name="line.440"></a>
<span class="sourceLineNo">441</span> }<a name="line.441"></a>
<span class="sourceLineNo">442</span> if (startTimestamp != null) {<a name="line.442"></a>
<span class="sourceLineNo">443</span> out.writeObject(startTimestamp);<a name="line.443"></a>
<span class="sourceLineNo">444</span> }<a name="line.444"></a>
<span class="sourceLineNo">445</span> if (stopTimestamp != null) {<a name="line.445"></a>
<span class="sourceLineNo">446</span> out.writeObject(stopTimestamp);<a name="line.446"></a>
<span class="sourceLineNo">447</span> }<a name="line.447"></a>
<span class="sourceLineNo">448</span> if (lastAccessTime != null) {<a name="line.448"></a>
<span class="sourceLineNo">449</span> out.writeObject(lastAccessTime);<a name="line.449"></a>
<span class="sourceLineNo">450</span> }<a name="line.450"></a>
<span class="sourceLineNo">451</span> if (timeout != 0l) {<a name="line.451"></a>
<span class="sourceLineNo">452</span> out.writeLong(timeout);<a name="line.452"></a>
<span class="sourceLineNo">453</span> }<a name="line.453"></a>
<span class="sourceLineNo">454</span> if (expired) {<a name="line.454"></a>
<span class="sourceLineNo">455</span> out.writeBoolean(expired);<a name="line.455"></a>
<span class="sourceLineNo">456</span> }<a name="line.456"></a>
<span class="sourceLineNo">457</span> if (host != null) {<a name="line.457"></a>
<span class="sourceLineNo">458</span> out.writeUTF(host);<a name="line.458"></a>
<span class="sourceLineNo">459</span> }<a name="line.459"></a>
<span class="sourceLineNo">460</span> if (!CollectionUtils.isEmpty(attributes)) {<a name="line.460"></a>
<span class="sourceLineNo">461</span> out.writeObject(attributes);<a name="line.461"></a>
<span class="sourceLineNo">462</span> }<a name="line.462"></a>
<span class="sourceLineNo">463</span> }<a name="line.463"></a>
<span class="sourceLineNo">464</span><a name="line.464"></a>
<span class="sourceLineNo">465</span> /**<a name="line.465"></a>
<span class="sourceLineNo">466</span> * Reconstitutes this object based on the specified InputStream for JDK Serialization.<a name="line.466"></a>
<span class="sourceLineNo">467</span> *<a name="line.467"></a>
<span class="sourceLineNo">468</span> * @param in the input stream to use for reading data to populate this object.<a name="line.468"></a>
<span class="sourceLineNo">469</span> * @throws IOException if the input stream cannot be used.<a name="line.469"></a>
<span class="sourceLineNo">470</span> * @throws ClassNotFoundException if a required class needed for instantiation is not available in the present JVM<a name="line.470"></a>
<span class="sourceLineNo">471</span> * @since 1.0<a name="line.471"></a>
<span class="sourceLineNo">472</span> */<a name="line.472"></a>
<span class="sourceLineNo">473</span> @SuppressWarnings({"unchecked"})<a name="line.473"></a>
<span class="sourceLineNo">474</span> private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {<a name="line.474"></a>
<span class="sourceLineNo">475</span> in.defaultReadObject();<a name="line.475"></a>
<span class="sourceLineNo">476</span> short bitMask = in.readShort();<a name="line.476"></a>
<span class="sourceLineNo">477</span><a name="line.477"></a>
<span class="sourceLineNo">478</span> if (isFieldPresent(bitMask, ID_BIT_MASK)) {<a name="line.478"></a>
<span class="sourceLineNo">479</span> this.id = (Serializable) in.readObject();<a name="line.479"></a>
<span class="sourceLineNo">480</span> }<a name="line.480"></a>
<span class="sourceLineNo">481</span> if (isFieldPresent(bitMask, START_TIMESTAMP_BIT_MASK)) {<a name="line.481"></a>
<span class="sourceLineNo">482</span> this.startTimestamp = (Date) in.readObject();<a name="line.482"></a>
<span class="sourceLineNo">483</span> }<a name="line.483"></a>
<span class="sourceLineNo">484</span> if (isFieldPresent(bitMask, STOP_TIMESTAMP_BIT_MASK)) {<a name="line.484"></a>
<span class="sourceLineNo">485</span> this.stopTimestamp = (Date) in.readObject();<a name="line.485"></a>
<span class="sourceLineNo">486</span> }<a name="line.486"></a>
<span class="sourceLineNo">487</span> if (isFieldPresent(bitMask, LAST_ACCESS_TIME_BIT_MASK)) {<a name="line.487"></a>
<span class="sourceLineNo">488</span> this.lastAccessTime = (Date) in.readObject();<a name="line.488"></a>
<span class="sourceLineNo">489</span> }<a name="line.489"></a>
<span class="sourceLineNo">490</span> if (isFieldPresent(bitMask, TIMEOUT_BIT_MASK)) {<a name="line.490"></a>
<span class="sourceLineNo">491</span> this.timeout = in.readLong();<a name="line.491"></a>
<span class="sourceLineNo">492</span> }<a name="line.492"></a>
<span class="sourceLineNo">493</span> if (isFieldPresent(bitMask, EXPIRED_BIT_MASK)) {<a name="line.493"></a>
<span class="sourceLineNo">494</span> this.expired = in.readBoolean();<a name="line.494"></a>
<span class="sourceLineNo">495</span> }<a name="line.495"></a>
<span class="sourceLineNo">496</span> if (isFieldPresent(bitMask, HOST_BIT_MASK)) {<a name="line.496"></a>
<span class="sourceLineNo">497</span> this.host = in.readUTF();<a name="line.497"></a>
<span class="sourceLineNo">498</span> }<a name="line.498"></a>
<span class="sourceLineNo">499</span> if (isFieldPresent(bitMask, ATTRIBUTES_BIT_MASK)) {<a name="line.499"></a>
<span class="sourceLineNo">500</span> this.attributes = (Map&lt;Object, Object&gt;) in.readObject();<a name="line.500"></a>
<span class="sourceLineNo">501</span> }<a name="line.501"></a>
<span class="sourceLineNo">502</span> }<a name="line.502"></a>
<span class="sourceLineNo">503</span><a name="line.503"></a>
<span class="sourceLineNo">504</span> /**<a name="line.504"></a>
<span class="sourceLineNo">505</span> * Returns a bit mask used during serialization indicating which fields have been serialized. Fields that have been<a name="line.505"></a>
<span class="sourceLineNo">506</span> * altered (not null and/or not retaining the class defaults) will be serialized and have 1 in their respective<a name="line.506"></a>
<span class="sourceLineNo">507</span> * index, fields that are null and/or retain class default values have 0.<a name="line.507"></a>
<span class="sourceLineNo">508</span> *<a name="line.508"></a>
<span class="sourceLineNo">509</span> * @return a bit mask used during serialization indicating which fields have been serialized.<a name="line.509"></a>
<span class="sourceLineNo">510</span> * @since 1.0<a name="line.510"></a>
<span class="sourceLineNo">511</span> */<a name="line.511"></a>
<span class="sourceLineNo">512</span> private short getAlteredFieldsBitMask() {<a name="line.512"></a>
<span class="sourceLineNo">513</span> int bitMask = 0;<a name="line.513"></a>
<span class="sourceLineNo">514</span> bitMask = id != null ? bitMask | ID_BIT_MASK : bitMask;<a name="line.514"></a>
<span class="sourceLineNo">515</span> bitMask = startTimestamp != null ? bitMask | START_TIMESTAMP_BIT_MASK : bitMask;<a name="line.515"></a>
<span class="sourceLineNo">516</span> bitMask = stopTimestamp != null ? bitMask | STOP_TIMESTAMP_BIT_MASK : bitMask;<a name="line.516"></a>
<span class="sourceLineNo">517</span> bitMask = lastAccessTime != null ? bitMask | LAST_ACCESS_TIME_BIT_MASK : bitMask;<a name="line.517"></a>
<span class="sourceLineNo">518</span> bitMask = timeout != 0l ? bitMask | TIMEOUT_BIT_MASK : bitMask;<a name="line.518"></a>
<span class="sourceLineNo">519</span> bitMask = expired ? bitMask | EXPIRED_BIT_MASK : bitMask;<a name="line.519"></a>
<span class="sourceLineNo">520</span> bitMask = host != null ? bitMask | HOST_BIT_MASK : bitMask;<a name="line.520"></a>
<span class="sourceLineNo">521</span> bitMask = !CollectionUtils.isEmpty(attributes) ? bitMask | ATTRIBUTES_BIT_MASK : bitMask;<a name="line.521"></a>
<span class="sourceLineNo">522</span> return (short) bitMask;<a name="line.522"></a>
<span class="sourceLineNo">523</span> }<a name="line.523"></a>
<span class="sourceLineNo">524</span><a name="line.524"></a>
<span class="sourceLineNo">525</span> /**<a name="line.525"></a>
<span class="sourceLineNo">526</span> * Returns {@code true} if the given {@code bitMask} argument indicates that the specified field has been<a name="line.526"></a>
<span class="sourceLineNo">527</span> * serialized and therefore should be read during deserialization, {@code false} otherwise.<a name="line.527"></a>
<span class="sourceLineNo">528</span> *<a name="line.528"></a>
<span class="sourceLineNo">529</span> * @param bitMask the aggregate bitmask for all fields that have been serialized. Individual bits represent<a name="line.529"></a>
<span class="sourceLineNo">530</span> * the fields that have been serialized. A bit set to 1 means that corresponding field has<a name="line.530"></a>
<span class="sourceLineNo">531</span> * been serialized, 0 means it hasn't been serialized.<a name="line.531"></a>
<span class="sourceLineNo">532</span> * @param fieldBitMask the field bit mask constant identifying which bit to inspect (corresponds to a class attribute).<a name="line.532"></a>
<span class="sourceLineNo">533</span> * @return {@code true} if the given {@code bitMask} argument indicates that the specified field has been<a name="line.533"></a>
<span class="sourceLineNo">534</span> * serialized and therefore should be read during deserialization, {@code false} otherwise.<a name="line.534"></a>
<span class="sourceLineNo">535</span> * @since 1.0<a name="line.535"></a>
<span class="sourceLineNo">536</span> */<a name="line.536"></a>
<span class="sourceLineNo">537</span> private static boolean isFieldPresent(short bitMask, int fieldBitMask) {<a name="line.537"></a>
<span class="sourceLineNo">538</span> return (bitMask &amp; fieldBitMask) != 0;<a name="line.538"></a>
<span class="sourceLineNo">539</span> }<a name="line.539"></a>
<span class="sourceLineNo">540</span><a name="line.540"></a>
<span class="sourceLineNo">541</span>}<a name="line.541"></a>
</pre>
</div>
</body>
</html>