| <!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_25) on Wed May 25 23:25:55 EDT 2016 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>AbstractValidatingSessionManager (Apache Shiro 1.2.5 API)</title> |
| <meta name="date" content="2016-05-25"> |
| <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="AbstractValidatingSessionManager (Apache Shiro 1.2.5 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/AbstractValidatingSessionManager.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/AbstractSessionManager.html" title="class in org.apache.shiro.session.mgt"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/session/mgt/DefaultSessionContext.html" title="class in org.apache.shiro.session.mgt"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html" target="_top">Frames</a></li> |
| <li><a href="AbstractValidatingSessionManager.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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</div> |
| <h2 title="Class AbstractValidatingSessionManager" class="title">Class AbstractValidatingSessionManager</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/AbstractSessionManager.html" title="class in org.apache.shiro.session.mgt">org.apache.shiro.session.mgt.AbstractSessionManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html" title="class in org.apache.shiro.session.mgt">org.apache.shiro.session.mgt.AbstractNativeSessionManager</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.session.mgt.AbstractValidatingSessionManager</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/session/mgt/NativeSessionManager.html" title="interface in org.apache.shiro.session.mgt">NativeSessionManager</a>, <a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a>, <a href="../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</a>, <a href="../../../../../org/apache/shiro/util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/shiro/session/mgt/DefaultSessionManager.html" title="class in org.apache.shiro.session.mgt">DefaultSessionManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.39">AbstractValidatingSessionManager</a> |
| extends <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractNativeSessionManager</a> |
| implements <a href="../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</a>, <a href="../../../../../org/apache/shiro/util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></pre> |
| <div class="block">Default business-tier implementation of the <a href="../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>ValidatingSessionManager</code></a> interface.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.1</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> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#DEFAULT_SESSION_VALIDATION_INTERVAL">DEFAULT_SESSION_VALIDATION_INTERVAL</a></strong></code> |
| <div class="block">The default interval at which sessions will be validated (1 hour); |
| This can be overridden by calling <a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#setSessionValidationInterval(long)"><code>setSessionValidationInterval(long)</code></a></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#sessionValidationInterval">sessionValidationInterval</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#sessionValidationScheduler">sessionValidationScheduler</a></strong></code> |
| <div class="block">Scheduler used to validate sessions on a regular basis.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#sessionValidationSchedulerEnabled">sessionValidationSchedulerEnabled</a></strong></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.shiro.session.mgt.AbstractSessionManager"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.shiro.session.mgt.<a href="../../../../../org/apache/shiro/session/mgt/AbstractSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractSessionManager</a></h3> |
| <code><a href="../../../../../org/apache/shiro/session/mgt/AbstractSessionManager.html#DEFAULT_GLOBAL_SESSION_TIMEOUT">DEFAULT_GLOBAL_SESSION_TIMEOUT</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractSessionManager.html#MILLIS_PER_HOUR">MILLIS_PER_HOUR</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractSessionManager.html#MILLIS_PER_MINUTE">MILLIS_PER_MINUTE</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractSessionManager.html#MILLIS_PER_SECOND">MILLIS_PER_SECOND</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="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/AbstractValidatingSessionManager.html#AbstractValidatingSessionManager()">AbstractValidatingSessionManager</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>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#afterExpired(org.apache.shiro.session.Session)">afterExpired</a></strong>(<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>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#afterSessionValidationEnabled()">afterSessionValidationEnabled</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#beforeSessionValidationDisabled()">beforeSessionValidationDisabled</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/AbstractValidatingSessionManager.html#createSession(org.apache.shiro.session.mgt.SessionContext)">createSession</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionContext.html" title="interface in org.apache.shiro.session.mgt">SessionContext</a> context)</code> |
| <div class="block">Creates a new <code>Session Session</code> instance based on the specified (possibly <code>null</code>) |
| initialization data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#createSessionValidationScheduler()">createSessionValidationScheduler</a></strong>()</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/AbstractValidatingSessionManager.html#destroy()">destroy</a></strong>()</code> |
| <div class="block">Called when this object is being destroyed, allowing any necessary cleanup of internal resources.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#disableSessionValidation()">disableSessionValidation</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected abstract <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/AbstractValidatingSessionManager.html#doCreateSession(org.apache.shiro.session.mgt.SessionContext)">doCreateSession</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionContext.html" title="interface in org.apache.shiro.session.mgt">SessionContext</a> initData)</code> </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/AbstractValidatingSessionManager.html#doGetSession(org.apache.shiro.session.mgt.SessionKey)">doGetSession</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#doValidate(org.apache.shiro.session.Session)">doValidate</a></strong>(<a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#enableSessionValidation()">enableSessionValidation</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected abstract <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/AbstractValidatingSessionManager.html#getActiveSessions()">getActiveSessions</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#getSessionValidationInterval()">getSessionValidationInterval</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#getSessionValidationScheduler()">getSessionValidationScheduler</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#getTimeout(org.apache.shiro.session.Session)">getTimeout</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 template hook in case per-session timeout is not based on |
| <a href="../../../../../org/apache/shiro/session/Session.html#getTimeout()"><code>Session.getTimeout()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#isSessionValidationSchedulerEnabled()">isSessionValidationSchedulerEnabled</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#onExpiration(org.apache.shiro.session.Session)">onExpiration</a></strong>(<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>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#onExpiration(org.apache.shiro.session.Session, org.apache.shiro.session.ExpiredSessionException, org.apache.shiro.session.mgt.SessionKey)">onExpiration</a></strong>(<a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> s, |
| <a href="../../../../../org/apache/shiro/session/ExpiredSessionException.html" title="class in org.apache.shiro.session">ExpiredSessionException</a> ese, |
| <a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#onInvalidation(org.apache.shiro.session.Session, org.apache.shiro.session.InvalidSessionException, org.apache.shiro.session.mgt.SessionKey)">onInvalidation</a></strong>(<a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> s, |
| <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a> ise, |
| <a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected abstract <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/AbstractValidatingSessionManager.html#retrieveSession(org.apache.shiro.session.mgt.SessionKey)">retrieveSession</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> |
| <div class="block">Looks up a session from the underlying data store based on the specified session key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#setSessionValidationInterval(long)">setSessionValidationInterval</a></strong>(long sessionValidationInterval)</code> |
| <div class="block">If using the underlying default <tt>SessionValidationScheduler</tt> (that is, the |
| <a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#setSessionValidationScheduler(org.apache.shiro.session.mgt.SessionValidationScheduler)"><code>setSessionValidationScheduler</code></a> method is |
| never called) , this method allows one to specify how |
| frequently session should be validated (to check for orphans).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#setSessionValidationScheduler(org.apache.shiro.session.mgt.SessionValidationScheduler)">setSessionValidationScheduler</a></strong>(<a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a> sessionValidationScheduler)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#setSessionValidationSchedulerEnabled(boolean)">setSessionValidationSchedulerEnabled</a></strong>(boolean sessionValidationSchedulerEnabled)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#validate(org.apache.shiro.session.Session, org.apache.shiro.session.mgt.SessionKey)">validate</a></strong>(<a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session, |
| <a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#validateSessions()">validateSessions</a></strong>()</code> |
| <div class="block">Performs session validation for all open/active sessions in the system (those that |
| have not been stopped or expired), and validates each one.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.shiro.session.mgt.AbstractNativeSessionManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.session.mgt.<a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractNativeSessionManager</a></h3> |
| <code><a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#afterStopped(org.apache.shiro.session.Session)">afterStopped</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#applyGlobalSessionTimeout(org.apache.shiro.session.Session)">applyGlobalSessionTimeout</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#beforeInvalidNotification(org.apache.shiro.session.Session)">beforeInvalidNotification</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#checkValid(org.apache.shiro.session.mgt.SessionKey)">checkValid</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#createExposedSession(org.apache.shiro.session.Session, org.apache.shiro.session.mgt.SessionContext)">createExposedSession</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#createExposedSession(org.apache.shiro.session.Session, org.apache.shiro.session.mgt.SessionKey)">createExposedSession</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#getAttribute(org.apache.shiro.session.mgt.SessionKey, java.lang.Object)">getAttribute</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#getAttributeKeys(org.apache.shiro.session.mgt.SessionKey)">getAttributeKeys</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#getHost(org.apache.shiro.session.mgt.SessionKey)">getHost</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#getLastAccessTime(org.apache.shiro.session.mgt.SessionKey)">getLastAccessTime</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#getSession(org.apache.shiro.session.mgt.SessionKey)">getSession</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#getSessionListeners()">getSessionListeners</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#getStartTimestamp(org.apache.shiro.session.mgt.SessionKey)">getStartTimestamp</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#getTimeout(org.apache.shiro.session.mgt.SessionKey)">getTimeout</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#isValid(org.apache.shiro.session.mgt.SessionKey)">isValid</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#notifyExpiration(org.apache.shiro.session.Session)">notifyExpiration</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#notifyStart(org.apache.shiro.session.Session)">notifyStart</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#notifyStop(org.apache.shiro.session.Session)">notifyStop</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#onChange(org.apache.shiro.session.Session)">onChange</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#onStart(org.apache.shiro.session.Session, org.apache.shiro.session.mgt.SessionContext)">onStart</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#onStop(org.apache.shiro.session.Session)">onStop</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#onStop(org.apache.shiro.session.Session, org.apache.shiro.session.mgt.SessionKey)">onStop</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#removeAttribute(org.apache.shiro.session.mgt.SessionKey, java.lang.Object)">removeAttribute</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#setAttribute(org.apache.shiro.session.mgt.SessionKey, java.lang.Object, java.lang.Object)">setAttribute</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#setSessionListeners(java.util.Collection)">setSessionListeners</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#setTimeout(org.apache.shiro.session.mgt.SessionKey, long)">setTimeout</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#start(org.apache.shiro.session.mgt.SessionContext)">start</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#stop(org.apache.shiro.session.mgt.SessionKey)">stop</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#touch(org.apache.shiro.session.mgt.SessionKey)">touch</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.shiro.session.mgt.AbstractSessionManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.session.mgt.<a href="../../../../../org/apache/shiro/session/mgt/AbstractSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractSessionManager</a></h3> |
| <code><a href="../../../../../org/apache/shiro/session/mgt/AbstractSessionManager.html#getGlobalSessionTimeout()">getGlobalSessionTimeout</a>, <a href="../../../../../org/apache/shiro/session/mgt/AbstractSessionManager.html#setGlobalSessionTimeout(long)">setGlobalSessionTimeout</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.shiro.session.mgt.SessionManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.shiro.session.mgt.<a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a></h3> |
| <code><a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html#getSession(org.apache.shiro.session.mgt.SessionKey)">getSession</a>, <a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html#start(org.apache.shiro.session.mgt.SessionContext)">start</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_SESSION_VALIDATION_INTERVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_SESSION_VALIDATION_INTERVAL</h4> |
| <pre>public static final long <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.50">DEFAULT_SESSION_VALIDATION_INTERVAL</a></pre> |
| <div class="block">The default interval at which sessions will be validated (1 hour); |
| This can be overridden by calling <a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#setSessionValidationInterval(long)"><code>setSessionValidationInterval(long)</code></a></div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.shiro.session.mgt.AbstractValidatingSessionManager.DEFAULT_SESSION_VALIDATION_INTERVAL">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="sessionValidationSchedulerEnabled"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sessionValidationSchedulerEnabled</h4> |
| <pre>protected boolean <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.52">sessionValidationSchedulerEnabled</a></pre> |
| </li> |
| </ul> |
| <a name="sessionValidationScheduler"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sessionValidationScheduler</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a> <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.57">sessionValidationScheduler</a></pre> |
| <div class="block">Scheduler used to validate sessions on a regular basis.</div> |
| </li> |
| </ul> |
| <a name="sessionValidationInterval"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>sessionValidationInterval</h4> |
| <pre>protected long <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.59">sessionValidationInterval</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractValidatingSessionManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractValidatingSessionManager</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.61">AbstractValidatingSessionManager</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="isSessionValidationSchedulerEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSessionValidationSchedulerEnabled</h4> |
| <pre>public boolean <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.66">isSessionValidationSchedulerEnabled</a>()</pre> |
| </li> |
| </ul> |
| <a name="setSessionValidationSchedulerEnabled(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionValidationSchedulerEnabled</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.71">setSessionValidationSchedulerEnabled</a>(boolean sessionValidationSchedulerEnabled)</pre> |
| </li> |
| </ul> |
| <a name="setSessionValidationScheduler(org.apache.shiro.session.mgt.SessionValidationScheduler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionValidationScheduler</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.75">setSessionValidationScheduler</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a> sessionValidationScheduler)</pre> |
| </li> |
| </ul> |
| <a name="getSessionValidationScheduler()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionValidationScheduler</h4> |
| <pre>public <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a> <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.79">getSessionValidationScheduler</a>()</pre> |
| </li> |
| </ul> |
| <a name="setSessionValidationInterval(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionValidationInterval</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.104">setSessionValidationInterval</a>(long sessionValidationInterval)</pre> |
| <div class="block">If using the underlying default <tt>SessionValidationScheduler</tt> (that is, the |
| <a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#setSessionValidationScheduler(org.apache.shiro.session.mgt.SessionValidationScheduler)"><code>setSessionValidationScheduler</code></a> method is |
| never called) , this method allows one to specify how |
| frequently session should be validated (to check for orphans). The default value is |
| <a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#DEFAULT_SESSION_VALIDATION_INTERVAL"><code>DEFAULT_SESSION_VALIDATION_INTERVAL</code></a>. |
| <p/> |
| If you override the default scheduler, it is assumed that overriding instance 'knows' how often to |
| validate sessions, and this attribute will be ignored. |
| <p/> |
| Unless this method is called, the default value is <a href="../../../../../org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#DEFAULT_SESSION_VALIDATION_INTERVAL"><code>DEFAULT_SESSION_VALIDATION_INTERVAL</code></a>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sessionValidationInterval</code> - the time in milliseconds between checking for valid sessions to reap orphans.</dd></dl> |
| </li> |
| </ul> |
| <a name="getSessionValidationInterval()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionValidationInterval</h4> |
| <pre>public long <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.108">getSessionValidationInterval</a>()</pre> |
| </li> |
| </ul> |
| <a name="doGetSession(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doGetSession</h4> |
| <pre>protected final <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/AbstractValidatingSessionManager.html#line.113">doGetSession</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#doGetSession(org.apache.shiro.session.mgt.SessionKey)">doGetSession</a></code> in class <code><a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractNativeSessionManager</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="retrieveSession(org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>retrieveSession</h4> |
| <pre>protected abstract <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/AbstractValidatingSessionManager.html#line.132">retrieveSession</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key) |
| throws <a href="../../../../../org/apache/shiro/session/UnknownSessionException.html" title="class in org.apache.shiro.session">UnknownSessionException</a></pre> |
| <div class="block">Looks up a session from the underlying data store based on the specified session key.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the session key to use to look up the target session.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the session identified by <code>sessionId</code>.</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 there is no session identified by <code>sessionId</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="createSession(org.apache.shiro.session.mgt.SessionContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSession</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/AbstractValidatingSessionManager.html#line.134">createSession</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionContext.html" title="interface in org.apache.shiro.session.mgt">SessionContext</a> context) |
| throws <a href="../../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#createSession(org.apache.shiro.session.mgt.SessionContext)">AbstractNativeSessionManager</a></code></strong></div> |
| <div class="block">Creates a new <code>Session Session</code> instance based on the specified (possibly <code>null</code>) |
| initialization data. Implementing classes must manage the persistent state of the returned session such that it |
| could later be acquired via the <a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#getSession(org.apache.shiro.session.mgt.SessionKey)"><code>AbstractNativeSessionManager.getSession(SessionKey)</code></a> method.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html#createSession(org.apache.shiro.session.mgt.SessionContext)">createSession</a></code> in class <code><a href="../../../../../org/apache/shiro/session/mgt/AbstractNativeSessionManager.html" title="class in org.apache.shiro.session.mgt">AbstractNativeSessionManager</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the initialization data that can be used by the implementation or underlying |
| <a href="../../../../../org/apache/shiro/session/mgt/SessionFactory.html" title="interface in org.apache.shiro.session.mgt"><code>SessionFactory</code></a> when instantiating the internal <code>Session</code> instance.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the new <code>Session</code> instance.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/authz/HostUnauthorizedException.html" title="class in org.apache.shiro.authz">HostUnauthorizedException</a></code> - if the system access control policy restricts access based |
| on client location/IP and the specified hostAddress hasn't been enabled.</dd> |
| <dd><code><a href="../../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></code> - if the system access control policy does not allow the currently executing |
| caller to start sessions.</dd></dl> |
| </li> |
| </ul> |
| <a name="doCreateSession(org.apache.shiro.session.mgt.SessionContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doCreateSession</h4> |
| <pre>protected abstract <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/AbstractValidatingSessionManager.html#line.139">doCreateSession</a>(<a href="../../../../../org/apache/shiro/session/mgt/SessionContext.html" title="interface in org.apache.shiro.session.mgt">SessionContext</a> initData) |
| throws <a href="../../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></pre> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/authz/AuthorizationException.html" title="class in org.apache.shiro.authz">AuthorizationException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="validate(org.apache.shiro.session.Session, org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.141">validate</a>(<a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session, |
| <a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key) |
| throws <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="onExpiration(org.apache.shiro.session.Session, org.apache.shiro.session.ExpiredSessionException, org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onExpiration</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.153">onExpiration</a>(<a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> s, |
| <a href="../../../../../org/apache/shiro/session/ExpiredSessionException.html" title="class in org.apache.shiro.session">ExpiredSessionException</a> ese, |
| <a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</pre> |
| </li> |
| </ul> |
| <a name="onExpiration(org.apache.shiro.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onExpiration</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.163">onExpiration</a>(<a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</pre> |
| </li> |
| </ul> |
| <a name="afterExpired(org.apache.shiro.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>afterExpired</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.167">afterExpired</a>(<a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</pre> |
| </li> |
| </ul> |
| <a name="onInvalidation(org.apache.shiro.session.Session, org.apache.shiro.session.InvalidSessionException, org.apache.shiro.session.mgt.SessionKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onInvalidation</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.170">onInvalidation</a>(<a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> s, |
| <a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a> ise, |
| <a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html" title="interface in org.apache.shiro.session.mgt">SessionKey</a> key)</pre> |
| </li> |
| </ul> |
| <a name="doValidate(org.apache.shiro.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doValidate</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.184">doValidate</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/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></pre> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/InvalidSessionException.html" title="class in org.apache.shiro.session">InvalidSessionException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getTimeout(org.apache.shiro.session.Session)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeout</h4> |
| <pre>protected long <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.205">getTimeout</a>(<a href="../../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</a> session)</pre> |
| <div class="block">Subclass template hook in case per-session timeout is not based on |
| <a href="../../../../../org/apache/shiro/session/Session.html#getTimeout()"><code>Session.getTimeout()</code></a>. |
| <p/> |
| <p>This implementation merely returns <a href="../../../../../org/apache/shiro/session/Session.html#getTimeout()"><code>Session.getTimeout()</code></a></p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - the session for which to determine session timeout.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the time in milliseconds the specified session may remain idle before expiring.</dd></dl> |
| </li> |
| </ul> |
| <a name="createSessionValidationScheduler()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSessionValidationScheduler</h4> |
| <pre>protected <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a> <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.209">createSessionValidationScheduler</a>()</pre> |
| </li> |
| </ul> |
| <a name="enableSessionValidation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enableSessionValidation</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.223">enableSessionValidation</a>()</pre> |
| </li> |
| </ul> |
| <a name="afterSessionValidationEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>afterSessionValidationEnabled</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.236">afterSessionValidationEnabled</a>()</pre> |
| </li> |
| </ul> |
| <a name="disableSessionValidation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disableSessionValidation</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.239">disableSessionValidation</a>()</pre> |
| </li> |
| </ul> |
| <a name="beforeSessionValidationDisabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeSessionValidationDisabled</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.259">beforeSessionValidationDisabled</a>()</pre> |
| </li> |
| </ul> |
| <a name="destroy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.262">destroy</a>()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/util/Destroyable.html#destroy()">Destroyable</a></code></strong></div> |
| <div class="block">Called when this object is being destroyed, allowing any necessary cleanup of internal resources.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/util/Destroyable.html#destroy()">destroy</a></code> in interface <code><a href="../../../../../org/apache/shiro/util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateSessions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateSessions</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html#line.269">validateSessions</a>()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html#validateSessions()">ValidatingSessionManager</a></code></strong></div> |
| <div class="block">Performs session validation for all open/active sessions in the system (those that |
| have not been stopped or expired), and validates each one. If a session is |
| found to be invalid (e.g. it has expired), it is updated and saved to the EIS. |
| <p/> |
| This method is necessary in order to handle orphaned sessions and is expected to be run at |
| a regular interval, such as once an hour, once a day or once a week, etc. |
| The "best" frequency to run this method is entirely dependent upon the application |
| and would be based on factors such as performance, average number of active users, hours of |
| least activity, and other things. |
| <p/> |
| Most enterprise applications use a request/response programming model. |
| This is obvious in the case of web applications due to the HTTP protocol, but it is |
| equally true of remote client applications making remote method invocations. The server |
| essentially sits idle and only "works" when responding to client requests and/or |
| method invocations. This type of model is particularly efficent since it means the |
| security system only has to validate a session during those cases. Such |
| "lazy" behavior enables the system to lie stateless and/or idle and only incur |
| overhead for session validation when necessary. |
| <p/> |
| However, if a client forgets to log-out, or in the event of a server failure, it is |
| possible for sessions to be orphaned since no further requests would utilize that session. |
| Because of these lower-probability cases, it might be required to regularly clean-up the sessions |
| maintained by the system, especially if sessions are backed by a persistent data store. |
| <p/> |
| Even in applications that aren't primarily based on a request/response model, |
| such as those that use enterprise asynchronous messaging (where data is pushed to |
| a client without first receiving a client request), it is almost always acceptable to |
| utilize this lazy approach and run this method at defined interval. |
| <p/> |
| Systems that want to proactively validate individual sessions may simply call the |
| <a href="../../../../../org/apache/shiro/session/mgt/SessionManager.html#getSession(org.apache.shiro.session.mgt.SessionKey)"><code>getSession(SessionKey)</code></a> method on any |
| <code>ValidatingSessionManager</code> instance as that method is expected to |
| validate the session before retrieving it. Note that even with proactive calls to <code>getSession</code>, |
| this <code>validateSessions()</code> method should be invoked regularly anyway to <em>guarantee</em> no |
| orphans exist. |
| <p/> |
| <b>Note:</b> Shiro supports automatic execution of this method at a regular interval |
| by using <a href="../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt"><code>SessionValidationScheduler</code></a>s. The Shiro default SecurityManager implementations |
| needing session validation will create and use one by default if one is not provided by the |
| application configuration.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html#validateSessions()">validateSessions</a></code> in interface <code><a href="../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</a></code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html#validateSessions()"><code>ValidatingSessionManager.validateSessions()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getActiveSessions()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getActiveSessions</h4> |
| <pre>protected abstract <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/AbstractValidatingSessionManager.html#line.308">getActiveSessions</a>()</pre> |
| </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/AbstractValidatingSessionManager.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/AbstractSessionManager.html" title="class in org.apache.shiro.session.mgt"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/session/mgt/DefaultSessionContext.html" title="class in org.apache.shiro.session.mgt"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/session/mgt/AbstractValidatingSessionManager.html" target="_top">Frames</a></li> |
| <li><a href="AbstractValidatingSessionManager.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |