Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.4.0 / shiro-core / xref / org / apache / shiro / session / mgt / SimpleSession.html
blob: 8d668f0bc574ac5f332698b348b4616b633f0c03 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>SimpleSession xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/session/mgt/SimpleSession.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.session.mgt;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.ExpiredSessionException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.InvalidSessionException;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.StoppedSessionException;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.CollectionUtils;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L27" href="#L27">27</a>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.io.ObjectInputStream;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.io.ObjectOutputStream;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.text.DateFormat;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.*;
<a class="jxr_linenumber" name="L34" href="#L34">34</a>
<a class="jxr_linenumber" name="L35" href="#L35">35</a>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * Simple {@link org.apache.shiro.session.Session} JavaBeans-compatible POJO implementation, intended to be used on the</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * business/server tier.</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * @since 0.1</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html">SimpleSession</a> <strong class="jxr_keyword">implements</strong> ValidatingSession, Serializable {
<a class="jxr_linenumber" name="L43" href="#L43">43</a>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_comment">// Serialization reminder:</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_comment">// You _MUST_ change this number if you introduce a change to this class</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_comment">// that is NOT serialization backwards compatible. Serialization-compatible</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_comment">// changes do not require a change to this number. If you need to generate</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_comment">// a new number in this case, use the JDK's 'serialver' program to generate it.</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = -7125642695178165650L;
<a class="jxr_linenumber" name="L50" href="#L50">50</a>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_comment">//TODO - complete JavaDoc</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(SimpleSession.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> MILLIS_PER_SECOND = 1000;
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> MILLIS_PER_MINUTE = 60 * MILLIS_PER_SECOND;
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> MILLIS_PER_HOUR = 60 * MILLIS_PER_MINUTE;
<a class="jxr_linenumber" name="L57" href="#L57">57</a>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_comment">//serialization bitmask fields. DO NOT CHANGE THE ORDER THEY ARE DECLARED!</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> bitIndexCounter = 0;
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> ID_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> START_TIMESTAMP_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> STOP_TIMESTAMP_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> LAST_ACCESS_TIME_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> TIMEOUT_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> EXPIRED_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> HOST_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> ATTRIBUTES_BIT_MASK = 1 &lt;&lt; bitIndexCounter++;
<a class="jxr_linenumber" name="L68" href="#L68">68</a>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_comment">// ==============================================================</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_comment">// NOTICE:</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_comment">// The following fields are marked as transient to avoid double-serialization.</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_comment">// They are in fact serialized (even though 'transient' usually indicates otherwise),</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_comment">// but they are serialized explicitly via the writeObject and readObject implementations</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_comment">// in this class.</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_comment">// If we didn't declare them as transient, the out.defaultWriteObject(); call in writeObject would</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_comment">// serialize all non-transient fields as well, effectively doubly serializing the fields (also</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_comment">// doubling the serialization size).</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_comment">// This finding, with discussion, was covered here:</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_comment">// http://mail-archives.apache.org/mod_mbox/shiro-user/201109.mbox/%3C4E81BCBD.8060909@metaphysis.net%3E</em>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_comment">// ==============================================================</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> Serializable id;
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> Date startTimestamp;
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> Date stopTimestamp;
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> Date lastAccessTime;
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> <strong class="jxr_keyword">long</strong> timeout;
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> <strong class="jxr_keyword">boolean</strong> expired;
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> String host;
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> Map&lt;Object, Object&gt; attributes;
<a class="jxr_linenumber" name="L94" href="#L94">94</a>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html">SimpleSession</a>() {
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">this</strong>.timeout = DefaultSessionManager.DEFAULT_GLOBAL_SESSION_TIMEOUT; <em class="jxr_comment">//TODO - remove concrete reference to DefaultSessionManager</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">this</strong>.startTimestamp = <strong class="jxr_keyword">new</strong> Date();
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">this</strong>.lastAccessTime = <strong class="jxr_keyword">this</strong>.startTimestamp;
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html">SimpleSession</a>(String host) {
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">this</strong>();
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">this</strong>.host = host;
<a class="jxr_linenumber" name="L104" href="#L104">104</a> }
<a class="jxr_linenumber" name="L105" href="#L105">105</a>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">public</strong> Serializable getId() {
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.id;
<a class="jxr_linenumber" name="L108" href="#L108">108</a> }
<a class="jxr_linenumber" name="L109" href="#L109">109</a>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setId(Serializable id) {
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">this</strong>.id = id;
<a class="jxr_linenumber" name="L112" href="#L112">112</a> }
<a class="jxr_linenumber" name="L113" href="#L113">113</a>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">public</strong> Date getStartTimestamp() {
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">return</strong> startTimestamp;
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<a class="jxr_linenumber" name="L117" href="#L117">117</a>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStartTimestamp(Date startTimestamp) {
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">this</strong>.startTimestamp = startTimestamp;
<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
<a class="jxr_linenumber" name="L121" href="#L121">121</a>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * Returns the time the session was stopped, or &lt;tt&gt;null&lt;/tt&gt; if the session is still active.</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * A session may become stopped under a number of conditions:</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * &lt;ul&gt;</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * &lt;li&gt;If the user logs out of the system, their current session is terminated (released).&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * &lt;li&gt;If the session expires&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * &lt;li&gt;The application explicitly calls {@link #stop()}&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * &lt;li&gt;If there is an internal system error and the session state can no longer accurately</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * reflect the user's behavior, such in the case of a system crash&lt;/li&gt;</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * &lt;/ul&gt;</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * Once stopped, a session may no longer be used. It is locked from all further activity.</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * @return The time the session was stopped, or &lt;tt&gt;null&lt;/tt&gt; if the session is still</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * active.</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">public</strong> Date getStopTimestamp() {
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">return</strong> stopTimestamp;
<a class="jxr_linenumber" name="L141" href="#L141">141</a> }
<a class="jxr_linenumber" name="L142" href="#L142">142</a>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStopTimestamp(Date stopTimestamp) {
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">this</strong>.stopTimestamp = stopTimestamp;
<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
<a class="jxr_linenumber" name="L146" href="#L146">146</a>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">public</strong> Date getLastAccessTime() {
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">return</strong> lastAccessTime;
<a class="jxr_linenumber" name="L149" href="#L149">149</a> }
<a class="jxr_linenumber" name="L150" href="#L150">150</a>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLastAccessTime(Date lastAccessTime) {
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">this</strong>.lastAccessTime = lastAccessTime;
<a class="jxr_linenumber" name="L153" href="#L153">153</a> }
<a class="jxr_linenumber" name="L154" href="#L154">154</a>
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * Returns true if this session has expired, false otherwise. If the session has</em>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * expired, no further user interaction with the system may be done under this session.</em>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @return true if this session has expired, false otherwise.</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isExpired() {
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">return</strong> expired;
<a class="jxr_linenumber" name="L163" href="#L163">163</a> }
<a class="jxr_linenumber" name="L164" href="#L164">164</a>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setExpired(<strong class="jxr_keyword">boolean</strong> expired) {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">this</strong>.expired = expired;
<a class="jxr_linenumber" name="L167" href="#L167">167</a> }
<a class="jxr_linenumber" name="L168" href="#L168">168</a>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getTimeout() {
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">return</strong> timeout;
<a class="jxr_linenumber" name="L171" href="#L171">171</a> }
<a class="jxr_linenumber" name="L172" href="#L172">172</a>
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTimeout(<strong class="jxr_keyword">long</strong> timeout) {
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">this</strong>.timeout = timeout;
<a class="jxr_linenumber" name="L175" href="#L175">175</a> }
<a class="jxr_linenumber" name="L176" href="#L176">176</a>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">public</strong> String getHost() {
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">return</strong> host;
<a class="jxr_linenumber" name="L179" href="#L179">179</a> }
<a class="jxr_linenumber" name="L180" href="#L180">180</a>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHost(String host) {
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">this</strong>.host = host;
<a class="jxr_linenumber" name="L183" href="#L183">183</a> }
<a class="jxr_linenumber" name="L184" href="#L184">184</a>
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">public</strong> Map&lt;Object, Object&gt; getAttributes() {
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">return</strong> attributes;
<a class="jxr_linenumber" name="L187" href="#L187">187</a> }
<a class="jxr_linenumber" name="L188" href="#L188">188</a>
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAttributes(Map&lt;Object, Object&gt; attributes) {
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">this</strong>.attributes = attributes;
<a class="jxr_linenumber" name="L191" href="#L191">191</a> }
<a class="jxr_linenumber" name="L192" href="#L192">192</a>
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> touch() {
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">this</strong>.lastAccessTime = <strong class="jxr_keyword">new</strong> Date();
<a class="jxr_linenumber" name="L195" href="#L195">195</a> }
<a class="jxr_linenumber" name="L196" href="#L196">196</a>
<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> stop() {
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.stopTimestamp == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">this</strong>.stopTimestamp = <strong class="jxr_keyword">new</strong> Date();
<a class="jxr_linenumber" name="L200" href="#L200">200</a> }
<a class="jxr_linenumber" name="L201" href="#L201">201</a> }
<a class="jxr_linenumber" name="L202" href="#L202">202</a>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isStopped() {
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">return</strong> getStopTimestamp() != <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L205" href="#L205">205</a> }
<a class="jxr_linenumber" name="L206" href="#L206">206</a>
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> expire() {
<a class="jxr_linenumber" name="L208" href="#L208">208</a> stop();
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">this</strong>.expired = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L210" href="#L210">210</a> }
<a class="jxr_linenumber" name="L211" href="#L211">211</a>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @since 0.9</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isValid() {
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">return</strong> !isStopped() &amp;&amp; !isExpired();
<a class="jxr_linenumber" name="L217" href="#L217">217</a> }
<a class="jxr_linenumber" name="L218" href="#L218">218</a>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * Determines if this session is expired.</em>
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * @return true if the specified session has expired, false otherwise.</em>
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isTimedOut() {
<a class="jxr_linenumber" name="L225" href="#L225">225</a>
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">if</strong> (isExpired()) {
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L228" href="#L228">228</a> }
<a class="jxr_linenumber" name="L229" href="#L229">229</a>
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">long</strong> timeout = getTimeout();
<a class="jxr_linenumber" name="L231" href="#L231">231</a>
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">if</strong> (timeout &gt;= 0l) {
<a class="jxr_linenumber" name="L233" href="#L233">233</a>
<a class="jxr_linenumber" name="L234" href="#L234">234</a> Date lastAccessTime = getLastAccessTime();
<a class="jxr_linenumber" name="L235" href="#L235">235</a>
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">if</strong> (lastAccessTime == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L237" href="#L237">237</a> String msg = <span class="jxr_string">"session.lastAccessTime for session with id ["</span> +
<a class="jxr_linenumber" name="L238" href="#L238">238</a> getId() + <span class="jxr_string">"] is null. This value must be set at "</span> +
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <span class="jxr_string">"least once, preferably at least upon instantiation. Please check the "</span> +
<a class="jxr_linenumber" name="L240" href="#L240">240</a> getClass().getName() + <span class="jxr_string">" implementation and ensure "</span> +
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <span class="jxr_string">"this value will be set (perhaps in the constructor?)"</span>;
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg);
<a class="jxr_linenumber" name="L243" href="#L243">243</a> }
<a class="jxr_linenumber" name="L244" href="#L244">244</a>
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_comment">// Calculate at what time a session would have been last accessed</em>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_comment">// for it to be expired at this point. In other words, subtract</em>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_comment">// from the current time the amount of time that a session can</em>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_comment">// be inactive before expiring. If the session was last accessed</em>
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_comment">// before this time, it is expired.</em>
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">long</strong> expireTimeMillis = System.currentTimeMillis() - timeout;
<a class="jxr_linenumber" name="L251" href="#L251">251</a> Date expireTime = <strong class="jxr_keyword">new</strong> Date(expireTimeMillis);
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">return</strong> lastAccessTime.before(expireTime);
<a class="jxr_linenumber" name="L253" href="#L253">253</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a class="jxr_linenumber" name="L255" href="#L255">255</a> log.trace(<span class="jxr_string">"No timeout for session with id ["</span> + getId() +
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <span class="jxr_string">"]. Session is not considered expired."</span>);
<a class="jxr_linenumber" name="L257" href="#L257">257</a> }
<a class="jxr_linenumber" name="L258" href="#L258">258</a> }
<a class="jxr_linenumber" name="L259" href="#L259">259</a>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L261" href="#L261">261</a> }
<a class="jxr_linenumber" name="L262" href="#L262">262</a>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> validate() <strong class="jxr_keyword">throws</strong> InvalidSessionException {
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_comment">//check for stopped:</em>
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">if</strong> (isStopped()) {
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_comment">//timestamp is set, so the session is considered stopped:</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> String msg = <span class="jxr_string">"Session with id ["</span> + getId() + <span class="jxr_string">"] has been "</span> +
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <span class="jxr_string">"explicitly stopped. No further interaction under this session is "</span> +
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <span class="jxr_string">"allowed."</span>;
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/session/StoppedSessionException.html">StoppedSessionException</a>(msg);
<a class="jxr_linenumber" name="L271" href="#L271">271</a> }
<a class="jxr_linenumber" name="L272" href="#L272">272</a>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_comment">//check for expiration</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">if</strong> (isTimedOut()) {
<a class="jxr_linenumber" name="L275" href="#L275">275</a> expire();
<a class="jxr_linenumber" name="L276" href="#L276">276</a>
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_comment">//throw an exception explaining details of why it expired:</em>
<a class="jxr_linenumber" name="L278" href="#L278">278</a> Date lastAccessTime = getLastAccessTime();
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">long</strong> timeout = getTimeout();
<a class="jxr_linenumber" name="L280" href="#L280">280</a>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> Serializable sessionId = getId();
<a class="jxr_linenumber" name="L282" href="#L282">282</a>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> DateFormat df = DateFormat.getInstance();
<a class="jxr_linenumber" name="L284" href="#L284">284</a> String msg = <span class="jxr_string">"Session with id ["</span> + sessionId + <span class="jxr_string">"] has expired. "</span> +
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <span class="jxr_string">"Last access time: "</span> + df.format(lastAccessTime) +
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <span class="jxr_string">". Current time: "</span> + df.format(<strong class="jxr_keyword">new</strong> Date()) +
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <span class="jxr_string">". Session timeout is set to "</span> + timeout / MILLIS_PER_SECOND + <span class="jxr_string">" seconds ("</span> +
<a class="jxr_linenumber" name="L288" href="#L288">288</a> timeout / MILLIS_PER_MINUTE + <span class="jxr_string">" minutes)"</span>;
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) {
<a class="jxr_linenumber" name="L290" href="#L290">290</a> log.trace(msg);
<a class="jxr_linenumber" name="L291" href="#L291">291</a> }
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/session/ExpiredSessionException.html">ExpiredSessionException</a>(msg);
<a class="jxr_linenumber" name="L293" href="#L293">293</a> }
<a class="jxr_linenumber" name="L294" href="#L294">294</a> }
<a class="jxr_linenumber" name="L295" href="#L295">295</a>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">private</strong> Map&lt;Object, Object&gt; getAttributesLazy() {
<a class="jxr_linenumber" name="L297" href="#L297">297</a> Map&lt;Object, Object&gt; attributes = getAttributes();
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">if</strong> (attributes == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L299" href="#L299">299</a> attributes = <strong class="jxr_keyword">new</strong> HashMap&lt;Object, Object&gt;();
<a class="jxr_linenumber" name="L300" href="#L300">300</a> setAttributes(attributes);
<a class="jxr_linenumber" name="L301" href="#L301">301</a> }
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">return</strong> attributes;
<a class="jxr_linenumber" name="L303" href="#L303">303</a> }
<a class="jxr_linenumber" name="L304" href="#L304">304</a>
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">public</strong> Collection&lt;Object&gt; getAttributeKeys() <strong class="jxr_keyword">throws</strong> InvalidSessionException {
<a class="jxr_linenumber" name="L306" href="#L306">306</a> Map&lt;Object, Object&gt; attributes = getAttributes();
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">if</strong> (attributes == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">return</strong> Collections.emptySet();
<a class="jxr_linenumber" name="L309" href="#L309">309</a> }
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">return</strong> attributes.keySet();
<a class="jxr_linenumber" name="L311" href="#L311">311</a> }
<a class="jxr_linenumber" name="L312" href="#L312">312</a>
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">public</strong> Object getAttribute(Object key) {
<a class="jxr_linenumber" name="L314" href="#L314">314</a> Map&lt;Object, Object&gt; attributes = getAttributes();
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">if</strong> (attributes == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L317" href="#L317">317</a> }
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">return</strong> attributes.get(key);
<a class="jxr_linenumber" name="L319" href="#L319">319</a> }
<a class="jxr_linenumber" name="L320" href="#L320">320</a>
<a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAttribute(Object key, Object value) {
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">if</strong> (value == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L323" href="#L323">323</a> removeAttribute(key);
<a class="jxr_linenumber" name="L324" href="#L324">324</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L325" href="#L325">325</a> getAttributesLazy().put(key, value);
<a class="jxr_linenumber" name="L326" href="#L326">326</a> }
<a class="jxr_linenumber" name="L327" href="#L327">327</a> }
<a class="jxr_linenumber" name="L328" href="#L328">328</a>
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">public</strong> Object removeAttribute(Object key) {
<a class="jxr_linenumber" name="L330" href="#L330">330</a> Map&lt;Object, Object&gt; attributes = getAttributes();
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">if</strong> (attributes == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L332" href="#L332">332</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L333" href="#L333">333</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">return</strong> attributes.remove(key);
<a class="jxr_linenumber" name="L335" href="#L335">335</a> }
<a class="jxr_linenumber" name="L336" href="#L336">336</a> }
<a class="jxr_linenumber" name="L337" href="#L337">337</a>
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the specified argument is an {@code instanceof} {@code SimpleSession} and both</em>
<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> * {@link #getId() id}s are equal. If the argument is a {@code SimpleSession} and either 'this' or the argument</em>
<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> * does not yet have an ID assigned, the value of {@link #onEquals(SimpleSession) onEquals} is returned, which</em>
<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * does a necessary attribute-based comparison when IDs are not available.</em>
<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * Do your best to ensure {@code SimpleSession} instances receive an ID very early in their lifecycle to</em>
<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * avoid the more expensive attributes-based comparison.</em>
<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> * @param obj the object to compare with this one for equality.</em>
<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> * @return {@code true} if this object is equivalent to the specified argument, {@code false} otherwise.</em>
<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L350" href="#L350">350</a> @Override
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object obj) {
<a class="jxr_linenumber" name="L352" href="#L352">352</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong> == obj) {
<a class="jxr_linenumber" name="L353" href="#L353">353</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L354" href="#L354">354</a> }
<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">if</strong> (obj instanceof SimpleSession) {
<a class="jxr_linenumber" name="L356" href="#L356">356</a> <a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html">SimpleSession</a> other = (SimpleSession) obj;
<a class="jxr_linenumber" name="L357" href="#L357">357</a> Serializable thisId = getId();
<a class="jxr_linenumber" name="L358" href="#L358">358</a> Serializable otherId = other.getId();
<a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong class="jxr_keyword">if</strong> (thisId != <strong class="jxr_keyword">null</strong> &amp;&amp; otherId != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">return</strong> thisId.equals(otherId);
<a class="jxr_linenumber" name="L361" href="#L361">361</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_comment">//fall back to an attribute based comparison:</em>
<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">return</strong> onEquals(other);
<a class="jxr_linenumber" name="L364" href="#L364">364</a> }
<a class="jxr_linenumber" name="L365" href="#L365">365</a> }
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L367" href="#L367">367</a> }
<a class="jxr_linenumber" name="L368" href="#L368">368</a>
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * Provides an attribute-based comparison (no ID comparison) - incurred &lt;em&gt;only&lt;/em&gt; when 'this' or the</em>
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> * session object being compared for equality do not have a session id.</em>
<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_javadoccomment"> * @param ss the SimpleSession instance to compare for equality.</em>
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment"> * @return true if all the attributes, except the id, are equal to this object's attributes.</em>
<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> onEquals(<a href="../../../../../org/apache/shiro/session/mgt/SimpleSession.html">SimpleSession</a> ss) {
<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">return</strong> (getStartTimestamp() != <strong class="jxr_keyword">null</strong> ? getStartTimestamp().equals(ss.getStartTimestamp()) : ss.getStartTimestamp() == <strong class="jxr_keyword">null</strong>) &amp;&amp;
<a class="jxr_linenumber" name="L379" href="#L379">379</a> (getStopTimestamp() != <strong class="jxr_keyword">null</strong> ? getStopTimestamp().equals(ss.getStopTimestamp()) : ss.getStopTimestamp() == <strong class="jxr_keyword">null</strong>) &amp;&amp;
<a class="jxr_linenumber" name="L380" href="#L380">380</a> (getLastAccessTime() != <strong class="jxr_keyword">null</strong> ? getLastAccessTime().equals(ss.getLastAccessTime()) : ss.getLastAccessTime() == <strong class="jxr_keyword">null</strong>) &amp;&amp;
<a class="jxr_linenumber" name="L381" href="#L381">381</a> (getTimeout() == ss.getTimeout()) &amp;&amp;
<a class="jxr_linenumber" name="L382" href="#L382">382</a> (isExpired() == ss.isExpired()) &amp;&amp;
<a class="jxr_linenumber" name="L383" href="#L383">383</a> (getHost() != <strong class="jxr_keyword">null</strong> ? getHost().equals(ss.getHost()) : ss.getHost() == <strong class="jxr_keyword">null</strong>) &amp;&amp;
<a class="jxr_linenumber" name="L384" href="#L384">384</a> (getAttributes() != <strong class="jxr_keyword">null</strong> ? getAttributes().equals(ss.getAttributes()) : ss.getAttributes() == <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L385" href="#L385">385</a> }
<a class="jxr_linenumber" name="L386" href="#L386">386</a>
<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> * Returns the hashCode. If the {@link #getId() id} is not {@code null}, its hashcode is returned immediately.</em>
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * If it is {@code null}, an attributes-based hashCode will be calculated and returned.</em>
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * Do your best to ensure {@code SimpleSession} instances receive an ID very early in their lifecycle to</em>
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> * avoid the more expensive attributes-based calculation.</em>
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * @return this object's hashCode</em>
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L397" href="#L397">397</a> @Override
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() {
<a class="jxr_linenumber" name="L399" href="#L399">399</a> Serializable id = getId();
<a class="jxr_linenumber" name="L400" href="#L400">400</a> <strong class="jxr_keyword">if</strong> (id != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">return</strong> id.hashCode();
<a class="jxr_linenumber" name="L402" href="#L402">402</a> }
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">int</strong> hashCode = getStartTimestamp() != <strong class="jxr_keyword">null</strong> ? getStartTimestamp().hashCode() : 0;
<a class="jxr_linenumber" name="L404" href="#L404">404</a> hashCode = 31 * hashCode + (getStopTimestamp() != <strong class="jxr_keyword">null</strong> ? getStopTimestamp().hashCode() : 0);
<a class="jxr_linenumber" name="L405" href="#L405">405</a> hashCode = 31 * hashCode + (getLastAccessTime() != <strong class="jxr_keyword">null</strong> ? getLastAccessTime().hashCode() : 0);
<a class="jxr_linenumber" name="L406" href="#L406">406</a> hashCode = 31 * hashCode + Long.valueOf(Math.max(getTimeout(), 0)).hashCode();
<a class="jxr_linenumber" name="L407" href="#L407">407</a> hashCode = 31 * hashCode + Boolean.valueOf(isExpired()).hashCode();
<a class="jxr_linenumber" name="L408" href="#L408">408</a> hashCode = 31 * hashCode + (getHost() != <strong class="jxr_keyword">null</strong> ? getHost().hashCode() : 0);
<a class="jxr_linenumber" name="L409" href="#L409">409</a> hashCode = 31 * hashCode + (getAttributes() != <strong class="jxr_keyword">null</strong> ? getAttributes().hashCode() : 0);
<a class="jxr_linenumber" name="L410" href="#L410">410</a> <strong class="jxr_keyword">return</strong> hashCode;
<a class="jxr_linenumber" name="L411" href="#L411">411</a> }
<a class="jxr_linenumber" name="L412" href="#L412">412</a>
<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> * Returns the string representation of this SimpleSession, equal to</em>
<a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_javadoccomment"> * &lt;code&gt;getClass().getName() + &amp;quot;,id=&amp;quot; + getId()&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment"> * @return the string representation of this SimpleSession, equal to</em>
<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment"> * &lt;code&gt;getClass().getName() + &amp;quot;,id=&amp;quot; + getId()&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L421" href="#L421">421</a> @Override
<a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="L423" href="#L423">423</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="L424" href="#L424">424</a> sb.append(getClass().getName()).append(<span class="jxr_string">",id="</span>).append(getId());
<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">return</strong> sb.toString();
<a class="jxr_linenumber" name="L426" href="#L426">426</a> }
<a class="jxr_linenumber" name="L427" href="#L427">427</a>
<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_javadoccomment"> * Serializes this object to the specified output stream for JDK Serialization.</em>
<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment"> * @param out output stream used for Object serialization.</em>
<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment"> * @throws IOException if any of this object's fields cannot be written to the stream.</em>
<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeObject(ObjectOutputStream out) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="L436" href="#L436">436</a> out.defaultWriteObject();
<a class="jxr_linenumber" name="L437" href="#L437">437</a> <strong class="jxr_keyword">short</strong> alteredFieldsBitMask = getAlteredFieldsBitMask();
<a class="jxr_linenumber" name="L438" href="#L438">438</a> out.writeShort(alteredFieldsBitMask);
<a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong class="jxr_keyword">if</strong> (id != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L440" href="#L440">440</a> out.writeObject(id);
<a class="jxr_linenumber" name="L441" href="#L441">441</a> }
<a class="jxr_linenumber" name="L442" href="#L442">442</a> <strong class="jxr_keyword">if</strong> (startTimestamp != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L443" href="#L443">443</a> out.writeObject(startTimestamp);
<a class="jxr_linenumber" name="L444" href="#L444">444</a> }
<a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong class="jxr_keyword">if</strong> (stopTimestamp != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L446" href="#L446">446</a> out.writeObject(stopTimestamp);
<a class="jxr_linenumber" name="L447" href="#L447">447</a> }
<a class="jxr_linenumber" name="L448" href="#L448">448</a> <strong class="jxr_keyword">if</strong> (lastAccessTime != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L449" href="#L449">449</a> out.writeObject(lastAccessTime);
<a class="jxr_linenumber" name="L450" href="#L450">450</a> }
<a class="jxr_linenumber" name="L451" href="#L451">451</a> <strong class="jxr_keyword">if</strong> (timeout != 0l) {
<a class="jxr_linenumber" name="L452" href="#L452">452</a> out.writeLong(timeout);
<a class="jxr_linenumber" name="L453" href="#L453">453</a> }
<a class="jxr_linenumber" name="L454" href="#L454">454</a> <strong class="jxr_keyword">if</strong> (expired) {
<a class="jxr_linenumber" name="L455" href="#L455">455</a> out.writeBoolean(expired);
<a class="jxr_linenumber" name="L456" href="#L456">456</a> }
<a class="jxr_linenumber" name="L457" href="#L457">457</a> <strong class="jxr_keyword">if</strong> (host != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L458" href="#L458">458</a> out.writeUTF(host);
<a class="jxr_linenumber" name="L459" href="#L459">459</a> }
<a class="jxr_linenumber" name="L460" href="#L460">460</a> <strong class="jxr_keyword">if</strong> (!CollectionUtils.isEmpty(attributes)) {
<a class="jxr_linenumber" name="L461" href="#L461">461</a> out.writeObject(attributes);
<a class="jxr_linenumber" name="L462" href="#L462">462</a> }
<a class="jxr_linenumber" name="L463" href="#L463">463</a> }
<a class="jxr_linenumber" name="L464" href="#L464">464</a>
<a class="jxr_linenumber" name="L465" href="#L465">465</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L466" href="#L466">466</a> <em class="jxr_javadoccomment"> * Reconstitutes this object based on the specified InputStream for JDK Serialization.</em>
<a class="jxr_linenumber" name="L467" href="#L467">467</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L468" href="#L468">468</a> <em class="jxr_javadoccomment"> * @param in the input stream to use for reading data to populate this object.</em>
<a class="jxr_linenumber" name="L469" href="#L469">469</a> <em class="jxr_javadoccomment"> * @throws IOException if the input stream cannot be used.</em>
<a class="jxr_linenumber" name="L470" href="#L470">470</a> <em class="jxr_javadoccomment"> * @throws ClassNotFoundException if a required class needed for instantiation is not available in the present JVM</em>
<a class="jxr_linenumber" name="L471" href="#L471">471</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L472" href="#L472">472</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L473" href="#L473">473</a> @SuppressWarnings({<span class="jxr_string">"unchecked"</span>})
<a class="jxr_linenumber" name="L474" href="#L474">474</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> readObject(ObjectInputStream in) <strong class="jxr_keyword">throws</strong> IOException, ClassNotFoundException {
<a class="jxr_linenumber" name="L475" href="#L475">475</a> in.defaultReadObject();
<a class="jxr_linenumber" name="L476" href="#L476">476</a> <strong class="jxr_keyword">short</strong> bitMask = in.readShort();
<a class="jxr_linenumber" name="L477" href="#L477">477</a>
<a class="jxr_linenumber" name="L478" href="#L478">478</a> <strong class="jxr_keyword">if</strong> (isFieldPresent(bitMask, ID_BIT_MASK)) {
<a class="jxr_linenumber" name="L479" href="#L479">479</a> <strong class="jxr_keyword">this</strong>.id = (Serializable) in.readObject();
<a class="jxr_linenumber" name="L480" href="#L480">480</a> }
<a class="jxr_linenumber" name="L481" href="#L481">481</a> <strong class="jxr_keyword">if</strong> (isFieldPresent(bitMask, START_TIMESTAMP_BIT_MASK)) {
<a class="jxr_linenumber" name="L482" href="#L482">482</a> <strong class="jxr_keyword">this</strong>.startTimestamp = (Date) in.readObject();
<a class="jxr_linenumber" name="L483" href="#L483">483</a> }
<a class="jxr_linenumber" name="L484" href="#L484">484</a> <strong class="jxr_keyword">if</strong> (isFieldPresent(bitMask, STOP_TIMESTAMP_BIT_MASK)) {
<a class="jxr_linenumber" name="L485" href="#L485">485</a> <strong class="jxr_keyword">this</strong>.stopTimestamp = (Date) in.readObject();
<a class="jxr_linenumber" name="L486" href="#L486">486</a> }
<a class="jxr_linenumber" name="L487" href="#L487">487</a> <strong class="jxr_keyword">if</strong> (isFieldPresent(bitMask, LAST_ACCESS_TIME_BIT_MASK)) {
<a class="jxr_linenumber" name="L488" href="#L488">488</a> <strong class="jxr_keyword">this</strong>.lastAccessTime = (Date) in.readObject();
<a class="jxr_linenumber" name="L489" href="#L489">489</a> }
<a class="jxr_linenumber" name="L490" href="#L490">490</a> <strong class="jxr_keyword">if</strong> (isFieldPresent(bitMask, TIMEOUT_BIT_MASK)) {
<a class="jxr_linenumber" name="L491" href="#L491">491</a> <strong class="jxr_keyword">this</strong>.timeout = in.readLong();
<a class="jxr_linenumber" name="L492" href="#L492">492</a> }
<a class="jxr_linenumber" name="L493" href="#L493">493</a> <strong class="jxr_keyword">if</strong> (isFieldPresent(bitMask, EXPIRED_BIT_MASK)) {
<a class="jxr_linenumber" name="L494" href="#L494">494</a> <strong class="jxr_keyword">this</strong>.expired = in.readBoolean();
<a class="jxr_linenumber" name="L495" href="#L495">495</a> }
<a class="jxr_linenumber" name="L496" href="#L496">496</a> <strong class="jxr_keyword">if</strong> (isFieldPresent(bitMask, HOST_BIT_MASK)) {
<a class="jxr_linenumber" name="L497" href="#L497">497</a> <strong class="jxr_keyword">this</strong>.host = in.readUTF();
<a class="jxr_linenumber" name="L498" href="#L498">498</a> }
<a class="jxr_linenumber" name="L499" href="#L499">499</a> <strong class="jxr_keyword">if</strong> (isFieldPresent(bitMask, ATTRIBUTES_BIT_MASK)) {
<a class="jxr_linenumber" name="L500" href="#L500">500</a> <strong class="jxr_keyword">this</strong>.attributes = (Map&lt;Object, Object&gt;) in.readObject();
<a class="jxr_linenumber" name="L501" href="#L501">501</a> }
<a class="jxr_linenumber" name="L502" href="#L502">502</a> }
<a class="jxr_linenumber" name="L503" href="#L503">503</a>
<a class="jxr_linenumber" name="L504" href="#L504">504</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L505" href="#L505">505</a> <em class="jxr_javadoccomment"> * Returns a bit mask used during serialization indicating which fields have been serialized. Fields that have been</em>
<a class="jxr_linenumber" name="L506" href="#L506">506</a> <em class="jxr_javadoccomment"> * altered (not null and/or not retaining the class defaults) will be serialized and have 1 in their respective</em>
<a class="jxr_linenumber" name="L507" href="#L507">507</a> <em class="jxr_javadoccomment"> * index, fields that are null and/or retain class default values have 0.</em>
<a class="jxr_linenumber" name="L508" href="#L508">508</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L509" href="#L509">509</a> <em class="jxr_javadoccomment"> * @return a bit mask used during serialization indicating which fields have been serialized.</em>
<a class="jxr_linenumber" name="L510" href="#L510">510</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L511" href="#L511">511</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L512" href="#L512">512</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">short</strong> getAlteredFieldsBitMask() {
<a class="jxr_linenumber" name="L513" href="#L513">513</a> <strong class="jxr_keyword">int</strong> bitMask = 0;
<a class="jxr_linenumber" name="L514" href="#L514">514</a> bitMask = id != <strong class="jxr_keyword">null</strong> ? bitMask | ID_BIT_MASK : bitMask;
<a class="jxr_linenumber" name="L515" href="#L515">515</a> bitMask = startTimestamp != <strong class="jxr_keyword">null</strong> ? bitMask | START_TIMESTAMP_BIT_MASK : bitMask;
<a class="jxr_linenumber" name="L516" href="#L516">516</a> bitMask = stopTimestamp != <strong class="jxr_keyword">null</strong> ? bitMask | STOP_TIMESTAMP_BIT_MASK : bitMask;
<a class="jxr_linenumber" name="L517" href="#L517">517</a> bitMask = lastAccessTime != <strong class="jxr_keyword">null</strong> ? bitMask | LAST_ACCESS_TIME_BIT_MASK : bitMask;
<a class="jxr_linenumber" name="L518" href="#L518">518</a> bitMask = timeout != 0l ? bitMask | TIMEOUT_BIT_MASK : bitMask;
<a class="jxr_linenumber" name="L519" href="#L519">519</a> bitMask = expired ? bitMask | EXPIRED_BIT_MASK : bitMask;
<a class="jxr_linenumber" name="L520" href="#L520">520</a> bitMask = host != <strong class="jxr_keyword">null</strong> ? bitMask | HOST_BIT_MASK : bitMask;
<a class="jxr_linenumber" name="L521" href="#L521">521</a> bitMask = !CollectionUtils.isEmpty(attributes) ? bitMask | ATTRIBUTES_BIT_MASK : bitMask;
<a class="jxr_linenumber" name="L522" href="#L522">522</a> <strong class="jxr_keyword">return</strong> (<strong class="jxr_keyword">short</strong>) bitMask;
<a class="jxr_linenumber" name="L523" href="#L523">523</a> }
<a class="jxr_linenumber" name="L524" href="#L524">524</a>
<a class="jxr_linenumber" name="L525" href="#L525">525</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L526" href="#L526">526</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the given {@code bitMask} argument indicates that the specified field has been</em>
<a class="jxr_linenumber" name="L527" href="#L527">527</a> <em class="jxr_javadoccomment"> * serialized and therefore should be read during deserialization, {@code false} otherwise.</em>
<a class="jxr_linenumber" name="L528" href="#L528">528</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L529" href="#L529">529</a> <em class="jxr_javadoccomment"> * @param bitMask the aggregate bitmask for all fields that have been serialized. Individual bits represent</em>
<a class="jxr_linenumber" name="L530" href="#L530">530</a> <em class="jxr_javadoccomment"> * the fields that have been serialized. A bit set to 1 means that corresponding field has</em>
<a class="jxr_linenumber" name="L531" href="#L531">531</a> <em class="jxr_javadoccomment"> * been serialized, 0 means it hasn't been serialized.</em>
<a class="jxr_linenumber" name="L532" href="#L532">532</a> <em class="jxr_javadoccomment"> * @param fieldBitMask the field bit mask constant identifying which bit to inspect (corresponds to a class attribute).</em>
<a class="jxr_linenumber" name="L533" href="#L533">533</a> <em class="jxr_javadoccomment"> * @return {@code true} if the given {@code bitMask} argument indicates that the specified field has been</em>
<a class="jxr_linenumber" name="L534" href="#L534">534</a> <em class="jxr_javadoccomment"> * serialized and therefore should be read during deserialization, {@code false} otherwise.</em>
<a class="jxr_linenumber" name="L535" href="#L535">535</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L536" href="#L536">536</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L537" href="#L537">537</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isFieldPresent(<strong class="jxr_keyword">short</strong> bitMask, <strong class="jxr_keyword">int</strong> fieldBitMask) {
<a class="jxr_linenumber" name="L538" href="#L538">538</a> <strong class="jxr_keyword">return</strong> (bitMask &amp; fieldBitMask) != 0;
<a class="jxr_linenumber" name="L539" href="#L539">539</a> }
<a class="jxr_linenumber" name="L540" href="#L540">540</a>
<a class="jxr_linenumber" name="L541" href="#L541">541</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>