Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.1 / xref / org / apache / shiro / session / mgt / eis / MemorySessionDAO.html
blob: 4eeacfec9e0f8b3e289118c31b348282502e69fa [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>MemorySessionDAO 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/MemorySessionDAO.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.util.CollectionUtils;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="26" href="#26">26</a>
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.Collections;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentHashMap;
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentMap;
<a name="32" href="#32">32</a>
<a name="33" href="#33">33</a>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Simple memory-based implementation of the SessionDAO that stores all of its sessions in an in-memory</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * {@link ConcurrentMap}. &lt;b&gt;This implementation does not page to disk and is therefore unsuitable for applications</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * that could experience a large amount of sessions&lt;/b&gt; and would therefore cause {@code OutOfMemoryException}s. It is</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * &lt;em&gt;not&lt;/em&gt; recommended for production use in most environments.</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * &lt;h2&gt;Memory Restrictions&lt;/h2&gt;</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * If your application is expected to host many sessions beyond what can be stored in the</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * memory available to the JVM, it is highly recommended to use a different {@code SessionDAO} implementation which</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * uses a more expansive or permanent backing data store.</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * In this case, it is recommended to instead use a custom</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * {@link CachingSessionDAO} implementation that communicates with a higher-capacity data store of your choice</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * (file system, database, etc).</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * &lt;h2&gt;Changes in 1.0&lt;/h2&gt;</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * This implementation prior to 1.0 used to subclass the {@link CachingSessionDAO}, but this caused problems with many</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * cache implementations that would expunge entries due to TTL settings, resulting in Sessions that would be randomly</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * (and permanently) lost. The Shiro 1.0 release refactored this implementation to be 100% memory-based (without</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * {@code Cache} usage to avoid this problem.</em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> *</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @see CachingSessionDAO</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @since 0.1</em>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em>
<a name="56" href="#56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/shiro/session/mgt/eis/MemorySessionDAO.html">MemorySessionDAO</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html">AbstractSessionDAO</a> {
<a name="57" href="#57">57</a>
<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(MemorySessionDAO.<strong class="jxr_keyword">class</strong>);
<a name="59" href="#59">59</a>
<a name="60" href="#60">60</a> <strong class="jxr_keyword">private</strong> ConcurrentMap&lt;Serializable, Session&gt; sessions;
<a name="61" href="#61">61</a>
<a name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/shiro/session/mgt/eis/MemorySessionDAO.html">MemorySessionDAO</a>() {
<a name="63" href="#63">63</a> <strong class="jxr_keyword">this</strong>.sessions = <strong class="jxr_keyword">new</strong> ConcurrentHashMap&lt;Serializable, Session&gt;();
<a name="64" href="#64">64</a> }
<a name="65" href="#65">65</a>
<a name="66" href="#66">66</a> <strong class="jxr_keyword">protected</strong> Serializable doCreate(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session) {
<a name="67" href="#67">67</a> Serializable sessionId = generateSessionId(session);
<a name="68" href="#68">68</a> assignSessionId(session, sessionId);
<a name="69" href="#69">69</a> storeSession(sessionId, session);
<a name="70" href="#70">70</a> <strong class="jxr_keyword">return</strong> sessionId;
<a name="71" href="#71">71</a> }
<a name="72" href="#72">72</a>
<a name="73" href="#73">73</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> storeSession(Serializable id, <a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session) {
<a name="74" href="#74">74</a> <strong class="jxr_keyword">if</strong> (id == <strong class="jxr_keyword">null</strong>) {
<a name="75" href="#75">75</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"id argument cannot be null."</span>);
<a name="76" href="#76">76</a> }
<a name="77" href="#77">77</a> <strong class="jxr_keyword">return</strong> sessions.putIfAbsent(id, session);
<a name="78" href="#78">78</a> }
<a name="79" href="#79">79</a>
<a name="80" href="#80">80</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> doReadSession(Serializable sessionId) {
<a name="81" href="#81">81</a> <strong class="jxr_keyword">return</strong> sessions.get(sessionId);
<a name="82" href="#82">82</a> }
<a name="83" href="#83">83</a>
<a name="84" href="#84">84</a> <strong class="jxr_keyword">public</strong> <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="85" href="#85">85</a> storeSession(session.getId(), session);
<a name="86" href="#86">86</a> }
<a name="87" href="#87">87</a>
<a name="88" href="#88">88</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> delete(<a href="../../../../../../org/apache/shiro/session/Session.html">Session</a> session) {
<a name="89" href="#89">89</a> <strong class="jxr_keyword">if</strong> (session == <strong class="jxr_keyword">null</strong>) {
<a name="90" href="#90">90</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"session argument cannot be null."</span>);
<a name="91" href="#91">91</a> }
<a name="92" href="#92">92</a> Serializable id = session.getId();
<a name="93" href="#93">93</a> <strong class="jxr_keyword">if</strong> (id != <strong class="jxr_keyword">null</strong>) {
<a name="94" href="#94">94</a> sessions.remove(id);
<a name="95" href="#95">95</a> }
<a name="96" href="#96">96</a> }
<a name="97" href="#97">97</a>
<a name="98" href="#98">98</a> <strong class="jxr_keyword">public</strong> Collection&lt;Session&gt; getActiveSessions() {
<a name="99" href="#99">99</a> Collection&lt;Session&gt; values = sessions.values();
<a name="100" href="#100">100</a> <strong class="jxr_keyword">if</strong> (CollectionUtils.isEmpty(values)) {
<a name="101" href="#101">101</a> <strong class="jxr_keyword">return</strong> Collections.emptySet();
<a name="102" href="#102">102</a> } <strong class="jxr_keyword">else</strong> {
<a name="103" href="#103">103</a> <strong class="jxr_keyword">return</strong> Collections.unmodifiableCollection(values);
<a name="104" href="#104">104</a> }
<a name="105" href="#105">105</a> }
<a name="106" href="#106">106</a>
<a name="107" href="#107">107</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>