| <!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>SessionDAO 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/SessionDAO.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> |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Collection; |
| <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"> * Data Access Object design pattern specification to enable {@link Session} access to an</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * EIS (Enterprise Information System). It provides your four typical CRUD methods:</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * {@link #create}, {@link #readSession(java.io.Serializable)}, {@link #update(org.apache.shiro.session.Session)},</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * and {@link #delete(org.apache.shiro.session.Session)}.</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * The remaining {@link #getActiveSessions()} method exists as a support mechanism to pre-emptively orphaned sessions,</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * typically by {@link org.apache.shiro.session.mgt.ValidatingSessionManager ValidatingSessionManager}s), and should</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * be as efficient as possible, especially if there are thousands of active sessions. Large scale/high performance</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * implementations will often return a subset of the total active sessions and perform validation a little more</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * frequently, rather than return a massive set and infrequently validate.</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">interface</strong> <a href="../../../../../../org/apache/shiro/session/mgt/eis/SessionDAO.html">SessionDAO</a> { |
| <a name="43" href="#43">43</a> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Inserts a new Session record into the underling EIS (e.g. Relational database, file system, persistent cache,</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * etc, depending on the DAO implementation).</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * After this method is invoked, the {@link org.apache.shiro.session.Session#getId()}</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * method executed on the argument must return a valid session identifier. That is, the following should</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * always be true:</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Serializable id = create( session );</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * id.equals( session.getId() ) == true</pre></em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * Implementations are free to throw any exceptions that might occur due to</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * integrity violation constraints or other EIS related errors.</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @param session the {@link org.apache.shiro.session.Session} object to create in the EIS.</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @return the EIS id (e.g. primary key) of the created {@code Session} object.</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="61" href="#61">61</a> Serializable create(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session); |
| <a name="62" href="#62">62</a> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * Retrieves the session from the EIS uniquely identified by the specified</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * {@code sessionId}.</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @param sessionId the system-wide unique identifier of the Session object to retrieve from</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * the EIS.</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @return the persisted session in the EIS identified by {@code sessionId}.</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @throws UnknownSessionException if there is no EIS record for any session with the</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * specified {@code sessionId}</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="73" href="#73">73</a> <a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> readSession(Serializable sessionId) <strong class="jxr_keyword">throws</strong> UnknownSessionException; |
| <a name="74" href="#74">74</a> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * Updates (persists) data from a previously created Session instance in the EIS identified by</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * {@code {@link Session#getId() session.getId()}}. This effectively propagates</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * the data in the argument to the EIS record previously saved.</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * In addition to UnknownSessionException, implementations are free to throw any other</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * exceptions that might occur due to integrity violation constraints or other EIS related</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * errors.</em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @param session the Session to update</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.session.UnknownSessionException</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * if no existing EIS session record exists with the</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * identifier of {@link Session#getId() session.getSessionId()}</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="89" href="#89">89</a> <strong class="jxr_keyword">void</strong> update(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session) <strong class="jxr_keyword">throws</strong> UnknownSessionException; |
| <a name="90" href="#90">90</a> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * Deletes the associated EIS record of the specified {@code session}. If there never</em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * existed a session EIS record with the identifier of</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * {@link Session#getId() session.getId()}, then this method does nothing.</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * @param session the session to delete.</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="98" href="#98">98</a> <strong class="jxr_keyword">void</strong> delete(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session); |
| <a name="99" href="#99">99</a> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * Returns all sessions in the EIS that are considered active, meaning all sessions that</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * haven't been stopped/expired. This is primarily used to validate potential orphans.</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * If there are no active sessions in the EIS, this method may return an empty collection or {@code null}.</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * <h4>Performance</h4></em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * This method should be as efficient as possible, especially in larger systems where there might be</em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * thousands of active sessions. Large scale/high performance</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * implementations will often return a subset of the total active sessions and perform validation a little more</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * frequently, rather than return a massive set and validate infrequently. If efficient and possible, it would</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * make sense to return the oldest unstopped sessions available, ordered by</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.session.Session#getLastAccessTime() lastAccessTime}.</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * <h4>Smart Results</h4></em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * <em>Ideally</em> this method would only return active sessions that the EIS was certain should be invalided.</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * Typically that is any session that is not stopped and where its lastAccessTimestamp is older than the session</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * timeout.</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * For example, if sessions were backed by a relational database or SQL-92 'query-able' enterprise cache, you might</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * return something similar to the results returned by this query (assuming</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.session.mgt.SimpleSession SimpleSession}s were being stored):</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * select * from sessions s where s.lastAccessTimestamp < ? and s.stopTimestamp is null</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * where the {@code ?} parameter is a date instance equal to 'now' minus the session timeout</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * (e.g. now - 30 minutes).</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @return a Collection of {@code Session}s that are considered active, or an</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * empty collection or {@code null} if there are no active sessions.</em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="129" href="#129">129</a> Collection<Session> getActiveSessions(); |
| <a name="130" href="#130">130</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
