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