Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.5.2 / xref / org / apache / shiro / session / mgt / eis / EnterpriseCacheSessionDAO.html
blob: 13cfe97374c5aee705b3aa664eea32e4707c9a4b [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>EnterpriseCacheSessionDAO 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/EnterpriseCacheSessionDAO.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.session.mgt.eis;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.cache.AbstractCacheManager;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.cache.Cache;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.cache.CacheException;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.cache.MapCache;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session;
<a class="jxr_linenumber" name="L26" href="#L26">26</a>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentHashMap;
<a class="jxr_linenumber" name="L29" href="#L29">29</a>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * SessionDAO implementation that relies on an enterprise caching product as the EIS system of record for all sessions.</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * It is expected that an injected {@link org.apache.shiro.cache.Cache Cache} or</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.cache.CacheManager CacheManager} is backed by an enterprise caching product that can support</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * all application sessions and/or provide disk paging for resilient data storage.</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * &lt;h2&gt;Production Note&lt;/h2&gt;</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * This implementation defaults to using an in-memory map-based {@code CacheManager}, which is great for testing but</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * will typically not scale for production environments and could easily cause {@code OutOfMemoryException}s. Just</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * don't forget to configure&lt;b&gt;*&lt;/b&gt; an instance of this class with a production-grade {@code CacheManager} that can</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * handle disk paging for large numbers of sessions and you'll be fine.</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * &lt;b&gt;*&lt;/b&gt;If you configure Shiro's {@code SecurityManager} instance with such a {@code CacheManager}, it will be</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * automatically applied to an instance of this class and you won't need to explicitly set it in configuration.</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * &lt;h3&gt;Implementation Details&lt;/h3&gt;</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * This implementation relies heavily on the {@link CachingSessionDAO parent class}'s transparent caching behavior for</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * all storage operations with the enterprise caching product. Because the parent class uses a {@code Cache} or</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * {@code CacheManager} to perform caching, and the cache is considered the system of record, nothing further needs to</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * be done for the {@link #doReadSession}, {@link #doUpdate} and {@link #doDelete} method implementations. This class</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * implements those methods as required by the parent class, but they essentially do nothing.</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="EnterpriseCacheSessionDAO" href="../../../../../../org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#EnterpriseCacheSessionDAO">EnterpriseCacheSessionDAO</a> <strong class="jxr_keyword">extends</strong> <a name="CachingSessionDAO" href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#CachingSessionDAO">CachingSessionDAO</a> {
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">public</strong> <a name="EnterpriseCacheSessionDAO" href="../../../../../../org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#EnterpriseCacheSessionDAO">EnterpriseCacheSessionDAO</a>() {
<a class="jxr_linenumber" name="L55" href="#L55">55</a> setCacheManager(<strong class="jxr_keyword">new</strong> <a name="AbstractCacheManager" href="../../../../../../org/apache/shiro/cache/AbstractCacheManager.html#AbstractCacheManager">AbstractCacheManager</a>() {
<a class="jxr_linenumber" name="L56" href="#L56">56</a> @Override
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">protected</strong> Cache&lt;Serializable, Session&gt; createCache(String name) <strong class="jxr_keyword">throws</strong> <a name="CacheException" href="../../../../../../org/apache/shiro/cache/CacheException.html#CacheException">CacheException</a> {
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> MapCache&lt;Serializable, Session&gt;(name, <strong class="jxr_keyword">new</strong> ConcurrentHashMap&lt;Serializable, Session&gt;());
<a class="jxr_linenumber" name="L59" href="#L59">59</a> }
<a class="jxr_linenumber" name="L60" href="#L60">60</a> });
<a class="jxr_linenumber" name="L61" href="#L61">61</a> }
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">protected</strong> Serializable doCreate(<a name="Session" href="../../../../../../org/apache/shiro/session/Session.html#Session">Session</a> session) {
<a class="jxr_linenumber" name="L64" href="#L64">64</a> Serializable sessionId = generateSessionId(session);
<a class="jxr_linenumber" name="L65" href="#L65">65</a> assignSessionId(session, sessionId);
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">return</strong> sessionId;
<a class="jxr_linenumber" name="L67" href="#L67">67</a> }
<a class="jxr_linenumber" name="L68" href="#L68">68</a>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">protected</strong> <a name="Session" href="../../../../../../org/apache/shiro/session/Session.html#Session">Session</a> doReadSession(Serializable sessionId) {
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; <em class="jxr_comment">//should never execute because this implementation relies on parent class to access cache, which</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_comment">//is where all sessions reside - it is the cache implementation that determines if the</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_comment">//cache is memory only or disk-persistent, etc.</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> }
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> doUpdate(<a name="Session" href="../../../../../../org/apache/shiro/session/Session.html#Session">Session</a> session) {
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_comment">//does nothing - parent class persists to cache.</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> }
<a class="jxr_linenumber" name="L78" href="#L78">78</a>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> doDelete(<a name="Session" href="../../../../../../org/apache/shiro/session/Session.html#Session">Session</a> session) {
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_comment">//does nothing - parent class removes from cache.</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
<a class="jxr_linenumber" name="L82" href="#L82">82</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>