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