Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.5.1 / apidocs / org / apache / shiro / session / mgt / eis / EnterpriseCacheSessionDAO.html
blob: 6bf52f8b490faef002287eb19fd6b17e372c65a5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (1.8.0_201) on Sat Feb 22 18:48:00 CET 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EnterpriseCacheSessionDAO (Apache Shiro 1.5.1 API)</title>
<meta name="date" content="2020-02-22">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="EnterpriseCacheSessionDAO (Apache Shiro 1.5.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EnterpriseCacheSessionDAO.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/shiro/session/mgt/eis/JavaUuidSessionIdGenerator.html" title="class in org.apache.shiro.session.mgt.eis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html" target="_top">Frames</a></li>
<li><a href="EnterpriseCacheSessionDAO.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.shiro.session.mgt.eis.CachingSessionDAO">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.shiro.session.mgt.eis</div>
<h2 title="Class EnterpriseCacheSessionDAO" class="title">Class EnterpriseCacheSessionDAO</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis">org.apache.shiro.session.mgt.eis.AbstractSessionDAO</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis">org.apache.shiro.session.mgt.eis.CachingSessionDAO</a></li>
<li>
<ul class="inheritance">
<li>org.apache.shiro.session.mgt.eis.EnterpriseCacheSessionDAO</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/shiro/cache/CacheManagerAware.html" title="interface in org.apache.shiro.cache">CacheManagerAware</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/SessionDAO.html" title="interface in org.apache.shiro.session.mgt.eis">SessionDAO</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#line.52">EnterpriseCacheSessionDAO</a>
extends <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis">CachingSessionDAO</a></pre>
<div class="block">SessionDAO implementation that relies on an enterprise caching product as the EIS system of record for all sessions.
It is expected that an injected <a href="../../../../../../org/apache/shiro/cache/Cache.html" title="interface in org.apache.shiro.cache"><code>Cache</code></a> or
<a href="../../../../../../org/apache/shiro/cache/CacheManager.html" title="interface in org.apache.shiro.cache"><code>CacheManager</code></a> is backed by an enterprise caching product that can support
all application sessions and/or provide disk paging for resilient data storage.
<h2>Production Note</h2>
This implementation defaults to using an in-memory map-based <code>CacheManager</code>, which is great for testing but
will typically not scale for production environments and could easily cause <code>OutOfMemoryException</code>s. Just
don't forget to configure<b>*</b> an instance of this class with a production-grade <code>CacheManager</code> that can
handle disk paging for large numbers of sessions and you'll be fine.
<p/>
<b>*</b>If you configure Shiro's <code>SecurityManager</code> instance with such a <code>CacheManager</code>, it will be
automatically applied to an instance of this class and you won't need to explicitly set it in configuration.
<h3>Implementation Details</h3>
This implementation relies heavily on the <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis"><code>parent class</code></a>'s transparent caching behavior for
all storage operations with the enterprise caching product. Because the parent class uses a <code>Cache</code> or
<code>CacheManager</code> to perform caching, and the cache is considered the system of record, nothing further needs to
be done for the <a href="../../../../../../org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#doReadSession-java.io.Serializable-"><code>doReadSession(java.io.Serializable)</code></a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#doUpdate-org.apache.shiro.session.Session-"><code>doUpdate(org.apache.shiro.session.Session)</code></a> and <a href="../../../../../../org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#doDelete-org.apache.shiro.session.Session-"><code>doDelete(org.apache.shiro.session.Session)</code></a> method implementations. This class
implements those methods as required by the parent class, but they essentially do nothing.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.session.mgt.eis.CachingSessionDAO">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.shiro.session.mgt.eis.<a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis">CachingSessionDAO</a></h3>
<code><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#ACTIVE_SESSION_CACHE_NAME">ACTIVE_SESSION_CACHE_NAME</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#EnterpriseCacheSessionDAO--">EnterpriseCacheSessionDAO</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#doCreate-org.apache.shiro.session.Session-">doCreate</a></span>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a>&nbsp;session)</code>
<div class="block">Subclass hook to actually persist the given <tt>Session</tt> instance to the underlying EIS.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#doDelete-org.apache.shiro.session.Session-">doDelete</a></span>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a>&nbsp;session)</code>
<div class="block">Subclass implementation hook to permanently delete the given Session from the underlying EIS.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#doReadSession-java.io.Serializable-">doReadSession</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;sessionId)</code>
<div class="block">Subclass implementation hook that retrieves the Session object from the underlying EIS or <code>null</code> if a
session with that ID could not be found.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#doUpdate-org.apache.shiro.session.Session-">doUpdate</a></span>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a>&nbsp;session)</code>
<div class="block">Subclass implementation hook to actually persist the <code>Session</code>'s state to the underlying EIS.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.session.mgt.eis.CachingSessionDAO">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.session.mgt.eis.<a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis">CachingSessionDAO</a></h3>
<code><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#cache-org.apache.shiro.session.Session-java.io.Serializable-">cache</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#cache-org.apache.shiro.session.Session-java.io.Serializable-org.apache.shiro.cache.Cache-">cache</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#create-org.apache.shiro.session.Session-">create</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#createActiveSessionsCache--">createActiveSessionsCache</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#delete-org.apache.shiro.session.Session-">delete</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#getActiveSessions--">getActiveSessions</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#getActiveSessionsCache--">getActiveSessionsCache</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#getActiveSessionsCacheName--">getActiveSessionsCacheName</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#getCachedSession-java.io.Serializable-">getCachedSession</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#getCachedSession-java.io.Serializable-org.apache.shiro.cache.Cache-">getCachedSession</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#getCacheManager--">getCacheManager</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#readSession-java.io.Serializable-">readSession</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#setActiveSessionsCache-org.apache.shiro.cache.Cache-">setActiveSessionsCache</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#setActiveSessionsCacheName-java.lang.String-">setActiveSessionsCacheName</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#setCacheManager-org.apache.shiro.cache.CacheManager-">setCacheManager</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#uncache-org.apache.shiro.session.Session-">uncache</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#update-org.apache.shiro.session.Session-">update</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.session.mgt.eis.AbstractSessionDAO">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.session.mgt.eis.<a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis">AbstractSessionDAO</a></h3>
<code><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#assignSessionId-org.apache.shiro.session.Session-java.io.Serializable-">assignSessionId</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#generateSessionId-org.apache.shiro.session.Session-">generateSessionId</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#getSessionIdGenerator--">getSessionIdGenerator</a>, <a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#setSessionIdGenerator-org.apache.shiro.session.mgt.eis.SessionIdGenerator-">setSessionIdGenerator</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="EnterpriseCacheSessionDAO--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EnterpriseCacheSessionDAO</h4>
<pre>public&nbsp;<a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#line.54">EnterpriseCacheSessionDAO</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="doCreate-org.apache.shiro.session.Session-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doCreate</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;<a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#line.63">doCreate</a>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a>&nbsp;session)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#doCreate-org.apache.shiro.session.Session-">AbstractSessionDAO</a></code></span></div>
<div class="block">Subclass hook to actually persist the given <tt>Session</tt> instance to the underlying EIS.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#doCreate-org.apache.shiro.session.Session-">doCreate</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis">AbstractSessionDAO</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the Session instance to persist to the EIS.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the id of the session created in the EIS (i.e. this is almost always a primary key and should be the
value returned from <a href="../../../../../../org/apache/shiro/session/Session.html#getId--"><code>Session.getId()</code></a>.</dd>
</dl>
</li>
</ul>
<a name="doReadSession-java.io.Serializable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doReadSession</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a>&nbsp;<a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#line.69">doReadSession</a>(<a href="https://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;sessionId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#doReadSession-java.io.Serializable-">AbstractSessionDAO</a></code></span></div>
<div class="block">Subclass implementation hook that retrieves the Session object from the underlying EIS or <code>null</code> if a
session with that ID could not be found.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#doReadSession-java.io.Serializable-">doReadSession</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis">AbstractSessionDAO</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sessionId</code> - the id of the <tt>Session</tt> to retrieve.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Session in the EIS identified by <tt>sessionId</tt> or <code>null</code> if a
session with that ID could not be found.</dd>
</dl>
</li>
</ul>
<a name="doUpdate-org.apache.shiro.session.Session-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doUpdate</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#line.75">doUpdate</a>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a>&nbsp;session)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#doUpdate-org.apache.shiro.session.Session-">CachingSessionDAO</a></code></span></div>
<div class="block">Subclass implementation hook to actually persist the <code>Session</code>'s state to the underlying EIS.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#doUpdate-org.apache.shiro.session.Session-">doUpdate</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis">CachingSessionDAO</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session object whose state will be propagated to the EIS.</dd>
</dl>
</li>
</ul>
<a name="doDelete-org.apache.shiro.session.Session-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doDelete</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html#line.79">doDelete</a>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a>&nbsp;session)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#doDelete-org.apache.shiro.session.Session-">CachingSessionDAO</a></code></span></div>
<div class="block">Subclass implementation hook to permanently delete the given Session from the underlying EIS.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html#doDelete-org.apache.shiro.session.Session-">doDelete</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis">CachingSessionDAO</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session instance to permanently delete from the EIS.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EnterpriseCacheSessionDAO.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/shiro/session/mgt/eis/JavaUuidSessionIdGenerator.html" title="class in org.apache.shiro.session.mgt.eis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/shiro/session/mgt/eis/EnterpriseCacheSessionDAO.html" target="_top">Frames</a></li>
<li><a href="EnterpriseCacheSessionDAO.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.shiro.session.mgt.eis.CachingSessionDAO">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>