| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_21) on Thu May 30 15:02:19 PDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>MemorySessionDAO (Apache Shiro 1.2.2 API)</title> |
| <meta name="date" content="2013-05-30"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MemorySessionDAO (Apache Shiro 1.2.2 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/MemorySessionDAO.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/JavaUuidSessionIdGenerator.html" title="class in org.apache.shiro.session.mgt.eis"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/shiro/session/mgt/eis/RandomSessionIdGenerator.html" title="class in org.apache.shiro.session.mgt.eis"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/shiro/session/mgt/eis/MemorySessionDAO.html" target="_top">Frames</a></li> |
| <li><a href="MemorySessionDAO.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 MemorySessionDAO" class="title">Class MemorySessionDAO</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://java.sun.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>org.apache.shiro.session.mgt.eis.MemorySessionDAO</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/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/MemorySessionDAO.html#line.56">MemorySessionDAO</a> |
| extends <a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis">AbstractSessionDAO</a></pre> |
| <div class="block">Simple memory-based implementation of the SessionDAO that stores all of its sessions in an in-memory |
| <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent"><code>ConcurrentMap</code></a>. <b>This implementation does not page to disk and is therefore unsuitable for applications |
| that could experience a large amount of sessions</b> and would therefore cause <code>OutOfMemoryException</code>s. It is |
| <em>not</em> recommended for production use in most environments. |
| <h2>Memory Restrictions</h2> |
| If your application is expected to host many sessions beyond what can be stored in the |
| memory available to the JVM, it is highly recommended to use a different <code>SessionDAO</code> implementation which |
| uses a more expansive or permanent backing data store. |
| <p/> |
| In this case, it is recommended to instead use a custom |
| <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis"><code>CachingSessionDAO</code></a> implementation that communicates with a higher-capacity data store of your choice |
| (file system, database, etc). |
| <h2>Changes in 1.0</h2> |
| This implementation prior to 1.0 used to subclass the <a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis"><code>CachingSessionDAO</code></a>, but this caused problems with many |
| cache implementations that would expunge entries due to TTL settings, resulting in Sessions that would be randomly |
| (and permanently) lost. The Shiro 1.0 release refactored this implementation to be 100% memory-based (without |
| <code>Cache</code> usage to avoid this problem.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.1</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/shiro/session/mgt/eis/CachingSessionDAO.html" title="class in org.apache.shiro.session.mgt.eis"><code>CachingSessionDAO</code></a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#MemorySessionDAO()">MemorySessionDAO</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#delete(org.apache.shiro.session.Session)">delete</a></strong>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</code> |
| <div class="block">Deletes the associated EIS record of the specified <code>session</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://java.sun.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><strong><a href="../../../../../../org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#doCreate(org.apache.shiro.session.Session)">doCreate</a></strong>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</code> |
| <div class="block">Subclass hook to actually persist the given <tt>Session</tt> instance to the underlying EIS.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../../../org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#doReadSession(java.io.Serializable)">doReadSession</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> 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 class="rowColor"> |
| <td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#getActiveSessions()">getActiveSessions</a></strong>()</code> |
| <div class="block">Returns all sessions in the EIS that are considered active, meaning all sessions that |
| haven't been stopped/expired.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../../../org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#storeSession(java.io.Serializable, org.apache.shiro.session.Session)">storeSession</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> id, |
| <a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#update(org.apache.shiro.session.Session)">update</a></strong>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</code> |
| <div class="block">Updates (persists) data from a previously created Session instance in the EIS identified by |
| <code>{@link Session#getId() session.getId()}</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <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 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#create(org.apache.shiro.session.Session)">create</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#readSession(java.io.Serializable)">readSession</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 java.lang.<a href="http://java.sun.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="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.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="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.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="http://java.sun.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="MemorySessionDAO()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MemorySessionDAO</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#line.62">MemorySessionDAO</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 <a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> <a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#line.66">doCreate</a>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#doCreate(org.apache.shiro.session.Session)">AbstractSessionDAO</a></code></strong></div> |
| <div class="block">Subclass hook to actually persist the given <tt>Session</tt> instance to the underlying EIS.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#doCreate(org.apache.shiro.session.Session)">doCreate</a></code> in class <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="strong">Parameters:</span></dt><dd><code>session</code> - the Session instance to persist to the EIS.</dd> |
| <dt><span class="strong">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="storeSession(java.io.Serializable, org.apache.shiro.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeSession</h4> |
| <pre>protected <a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> <a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#line.73">storeSession</a>(<a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> id, |
| <a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</pre> |
| </li> |
| </ul> |
| <a name="doReadSession(java.io.Serializable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doReadSession</h4> |
| <pre>protected <a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> <a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#line.80">doReadSession</a>(<a href="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a> sessionId)</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#doReadSession(java.io.Serializable)">AbstractSessionDAO</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/session/mgt/eis/AbstractSessionDAO.html#doReadSession(java.io.Serializable)">doReadSession</a></code> in class <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="strong">Parameters:</span></dt><dd><code>sessionId</code> - the id of the <tt>Session</tt> to retrieve.</dd> |
| <dt><span class="strong">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="update(org.apache.shiro.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#line.84">update</a>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session) |
| throws <a href="../../../../../../org/apache/shiro/session/UnknownSessionException.html" title="class in org.apache.shiro.session">UnknownSessionException</a></pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/shiro/session/mgt/eis/SessionDAO.html#update(org.apache.shiro.session.Session)">SessionDAO</a></code></strong></div> |
| <div class="block">Updates (persists) data from a previously created Session instance in the EIS identified by |
| <code>{@link Session#getId() session.getId()}</code>. This effectively propagates |
| the data in the argument to the EIS record previously saved. |
| <p/> |
| In addition to UnknownSessionException, implementations are free to throw any other |
| exceptions that might occur due to integrity violation constraints or other EIS related |
| errors.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - the Session to update</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/session/UnknownSessionException.html" title="class in org.apache.shiro.session">UnknownSessionException</a></code> - if no existing EIS session record exists with the |
| identifier of <a href="../../../../../../org/apache/shiro/session/Session.html#getId()"><code>session.getSessionId()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="delete(org.apache.shiro.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#line.88">delete</a>(<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/shiro/session/mgt/eis/SessionDAO.html#delete(org.apache.shiro.session.Session)">SessionDAO</a></code></strong></div> |
| <div class="block">Deletes the associated EIS record of the specified <code>session</code>. If there never |
| existed a session EIS record with the identifier of |
| <a href="../../../../../../org/apache/shiro/session/Session.html#getId()"><code>session.getId()</code></a>, then this method does nothing.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - the session to delete.</dd></dl> |
| </li> |
| </ul> |
| <a name="getActiveSessions()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getActiveSessions</h4> |
| <pre>public <a href="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a>> <a href="../../../../../../src-html/org/apache/shiro/session/mgt/eis/MemorySessionDAO.html#line.98">getActiveSessions</a>()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/shiro/session/mgt/eis/SessionDAO.html#getActiveSessions()">SessionDAO</a></code></strong></div> |
| <div class="block">Returns all sessions in the EIS that are considered active, meaning all sessions that |
| haven't been stopped/expired. This is primarily used to validate potential orphans. |
| <p/> |
| If there are no active sessions in the EIS, this method may return an empty collection or <code>null</code>. |
| <h4>Performance</h4> |
| This method should be as efficient as possible, especially in larger systems where there might be |
| thousands of active sessions. Large scale/high performance |
| implementations will often return a subset of the total active sessions and perform validation a little more |
| frequently, rather than return a massive set and validate infrequently. If efficient and possible, it would |
| make sense to return the oldest unstopped sessions available, ordered by |
| <a href="../../../../../../org/apache/shiro/session/Session.html#getLastAccessTime()"><code>lastAccessTime</code></a>. |
| <h4>Smart Results</h4> |
| <em>Ideally</em> this method would only return active sessions that the EIS was certain should be invalided. |
| Typically that is any session that is not stopped and where its lastAccessTimestamp is older than the session |
| timeout. |
| <p/> |
| For example, if sessions were backed by a relational database or SQL-92 'query-able' enterprise cache, you might |
| return something similar to the results returned by this query (assuming |
| <a href="../../../../../../org/apache/shiro/session/mgt/SimpleSession.html" title="class in org.apache.shiro.session.mgt"><code>SimpleSession</code></a>s were being stored): |
| <pre> |
| select * from sessions s where s.lastAccessTimestamp < ? and s.stopTimestamp is null |
| </pre> |
| where the <code>?</code> parameter is a date instance equal to 'now' minus the session timeout |
| (e.g. now - 30 minutes).</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a Collection of <code>Session</code>s that are considered active, or an |
| empty collection or <code>null</code> if there are no active sessions.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/MemorySessionDAO.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/JavaUuidSessionIdGenerator.html" title="class in org.apache.shiro.session.mgt.eis"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/shiro/session/mgt/eis/RandomSessionIdGenerator.html" title="class in org.apache.shiro.session.mgt.eis"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/shiro/session/mgt/eis/MemorySessionDAO.html" target="_top">Frames</a></li> |
| <li><a href="MemorySessionDAO.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 © 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
| |