| <!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>AbstractSessionDAO xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../apidocs/org/apache/shiro/session/mgt/eis/AbstractSessionDAO.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.eis; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.UnknownSessionException; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.SimpleSession; |
| <a name="24" href="#24">24</a> |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <a name="26" href="#26">26</a> |
| <a name="27" href="#27">27</a> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * An abstract {@code SessionDAO} implementation that performs some sanity checks on session creation and reading and</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * allows for pluggable Session ID generation strategies if desired. The {@code SessionDAO}</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * {@link SessionDAO#update update} and {@link SessionDAO#delete delete} methods are left to</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * subclasses.</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <h3>Session ID Generation</h3></em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * This class also allows for plugging in a {@link SessionIdGenerator} for custom ID generation strategies. This is</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * optional, as the default generator is probably sufficient for most cases. Subclass implementations that do use a</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * generator (default or custom) will want to call the</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * {@link #generateSessionId(org.apache.shiro.session.Session)} method from within their {@link #doCreate}</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * implementations.</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Subclass implementations that rely on the EIS data store to generate the ID automatically (e.g. when the session</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * ID is also an auto-generated primary key), they can simply ignore the {@code SessionIdGenerator} concept</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * entirely and just return the data store's ID from the {@link #doCreate} implementation.</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @since 1.0</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="46" href="#46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html">AbstractSessionDAO</a> implements <a href="../../../../../../org/apache/shiro/session/mgt/eis/SessionDAO.html">SessionDAO</a> { |
| <a name="47" href="#47">47</a> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Optional SessionIdGenerator instance available to subclasses via the</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * {@link #generateSessionId(org.apache.shiro.session.Session)} method.</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/shiro/session/mgt/eis/SessionIdGenerator.html">SessionIdGenerator</a> sessionIdGenerator; |
| <a name="53" href="#53">53</a> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * Default no-arg constructor that defaults the {@link #setSessionIdGenerator sessionIdGenerator} to be a</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.session.mgt.eis.JavaUuidSessionIdGenerator}.</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="58" href="#58">58</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html">AbstractSessionDAO</a>() { |
| <a name="59" href="#59">59</a> <strong class="jxr_keyword">this</strong>.sessionIdGenerator = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/shiro/session/mgt/eis/JavaUuidSessionIdGenerator.html">JavaUuidSessionIdGenerator</a>(); |
| <a name="60" href="#60">60</a> } |
| <a name="61" href="#61">61</a> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * Returns the {@code SessionIdGenerator} used by the {@link #generateSessionId(org.apache.shiro.session.Session)}</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * method. Unless overridden by the {@link #setSessionIdGenerator(SessionIdGenerator)} method, the default instance</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * is a {@link JavaUuidSessionIdGenerator}.</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @return the {@code SessionIdGenerator} used by the {@link #generateSessionId(org.apache.shiro.session.Session)}</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * method.</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/shiro/session/mgt/eis/SessionIdGenerator.html">SessionIdGenerator</a> getSessionIdGenerator() { |
| <a name="71" href="#71">71</a> <strong class="jxr_keyword">return</strong> sessionIdGenerator; |
| <a name="72" href="#72">72</a> } |
| <a name="73" href="#73">73</a> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * Sets the {@code SessionIdGenerator} used by the {@link #generateSessionId(org.apache.shiro.session.Session)}</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * method. Unless overridden by this method, the default instance ss a {@link JavaUuidSessionIdGenerator}.</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @param sessionIdGenerator the {@code SessionIdGenerator} to use in the</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * {@link #generateSessionId(org.apache.shiro.session.Session)} method.</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="81" href="#81">81</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSessionIdGenerator(<a href="../../../../../../org/apache/shiro/session/mgt/eis/SessionIdGenerator.html">SessionIdGenerator</a> sessionIdGenerator) { |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">this</strong>.sessionIdGenerator = sessionIdGenerator; |
| <a name="83" href="#83">83</a> } |
| <a name="84" href="#84">84</a> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Generates a new ID to be applied to the specified {@code session} instance. This method is usually called</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * from within a subclass's {@link #doCreate} implementation where they assign the returned id to the session</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * instance and then create a record with this ID in the EIS data store.</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * Subclass implementations backed by EIS data stores that auto-generate IDs during record creation, such as</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * relational databases, don't need to use this method or the {@link #getSessionIdGenerator() sessionIdGenerator}</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * attribute - they can simply return the data store's generated ID from the {@link #doCreate} implementation</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * if desired.</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * This implementation uses the {@link #setSessionIdGenerator configured} {@link SessionIdGenerator} to create</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * the ID.</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @param session the new session instance for which an ID will be generated and then assigned</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @return the generated ID to assign</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="101" href="#101">101</a> <strong class="jxr_keyword">protected</strong> Serializable generateSessionId(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session) { |
| <a name="102" href="#102">102</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.sessionIdGenerator == <strong class="jxr_keyword">null</strong>) { |
| <a name="103" href="#103">103</a> String msg = <span class="jxr_string">"sessionIdGenerator attribute has not been configured."</span>; |
| <a name="104" href="#104">104</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg); |
| <a name="105" href="#105">105</a> } |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.sessionIdGenerator.generateId(session); |
| <a name="107" href="#107">107</a> } |
| <a name="108" href="#108">108</a> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * Creates the session by delegating EIS creation to subclasses via the {@link #doCreate} method, and then</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * asserting that the returned sessionId is not null.</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @param session Session object to create in the EIS and associate with an ID.</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="115" href="#115">115</a> <strong class="jxr_keyword">public</strong> Serializable create(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session) { |
| <a name="116" href="#116">116</a> Serializable sessionId = doCreate(session); |
| <a name="117" href="#117">117</a> verifySessionId(sessionId); |
| <a name="118" href="#118">118</a> <strong class="jxr_keyword">return</strong> sessionId; |
| <a name="119" href="#119">119</a> } |
| <a name="120" href="#120">120</a> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * Ensures the sessionId returned from the subclass implementation of {@link #doCreate} is not null and not</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * already in use.</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @param sessionId session id returned from the subclass implementation of {@link #doCreate}</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="127" href="#127">127</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> verifySessionId(Serializable sessionId) { |
| <a name="128" href="#128">128</a> <strong class="jxr_keyword">if</strong> (sessionId == <strong class="jxr_keyword">null</strong>) { |
| <a name="129" href="#129">129</a> String msg = <span class="jxr_string">"sessionId returned from doCreate implementation is null. Please verify the implementation."</span>; |
| <a name="130" href="#130">130</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(msg); |
| <a name="131" href="#131">131</a> } |
| <a name="132" href="#132">132</a> } |
| <a name="133" href="#133">133</a> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * Utility method available to subclasses that wish to</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * assign a generated session ID to the session instance directly. This method is not used by the</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * {@code AbstractSessionDAO} implementation directly, but it is provided so subclasses don't</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * need to know the {@code Session} implementation if they don't need to.</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * This default implementation casts the argument to a {@link SimpleSession}, Shiro's default EIS implementation.</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * @param session the session instance to which the sessionId will be applied</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @param sessionId the id to assign to the specified session instance.</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="145" href="#145">145</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> assignSessionId(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session, Serializable sessionId) { |
| <a name="146" href="#146">146</a> ((<a href="../../../../../../org/apache/shiro/session/mgt/SimpleSession.html">SimpleSession</a>) session).setId(sessionId); |
| <a name="147" href="#147">147</a> } |
| <a name="148" href="#148">148</a> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * Subclass hook to actually persist the given <tt>Session</tt> instance to the underlying EIS.</em> |
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * @param session the Session instance to persist to the EIS.</em> |
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * @return the id of the session created in the EIS (i.e. this is almost always a primary key and should be the</em> |
| <a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * value returned from {@link org.apache.shiro.session.Session#getId() Session.getId()}.</em> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="156" href="#156">156</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> Serializable doCreate(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session); |
| <a name="157" href="#157">157</a> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * Retrieves the Session object from the underlying EIS identified by <tt>sessionId</tt> by delegating to</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * the {@link #doReadSession(java.io.Serializable)} method. If {@code null} is returned from that method, an</em> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * {@link UnknownSessionException} will be thrown.</em> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * @param sessionId the id of the session to retrieve from the EIS.</em> |
| <a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * @return the session identified by <tt>sessionId</tt> in the EIS.</em> |
| <a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * @throws UnknownSessionException if the id specified does not correspond to any session in the EIS.</em> |
| <a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="167" href="#167">167</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> readSession(Serializable sessionId) <strong class="jxr_keyword">throws</strong> UnknownSessionException { |
| <a name="168" href="#168">168</a> <a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> s = doReadSession(sessionId); |
| <a name="169" href="#169">169</a> <strong class="jxr_keyword">if</strong> (s == <strong class="jxr_keyword">null</strong>) { |
| <a name="170" href="#170">170</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/shiro/session/UnknownSessionException.html">UnknownSessionException</a>(<span class="jxr_string">"There is no session with id ["</span> + sessionId + <span class="jxr_string">"]"</span>); |
| <a name="171" href="#171">171</a> } |
| <a name="172" href="#172">172</a> <strong class="jxr_keyword">return</strong> s; |
| <a name="173" href="#173">173</a> } |
| <a name="174" href="#174">174</a> |
| <a name="175" href="#175">175</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * Subclass implementation hook that retrieves the Session object from the underlying EIS or {@code null} if a</em> |
| <a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> * session with that ID could not be found.</em> |
| <a name="178" href="#178">178</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * @param sessionId the id of the <tt>Session</tt> to retrieve.</em> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * @return the Session in the EIS identified by <tt>sessionId</tt> or {@code null} if a</em> |
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * session with that ID could not be found.</em> |
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="183" href="#183">183</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> doReadSession(Serializable sessionId); |
| <a name="184" href="#184">184</a> |
| <a name="185" href="#185">185</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
