| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>QuartzSessionValidationScheduler (Apache Shiro 1.13.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="QuartzSessionValidationScheduler (Apache Shiro 1.13.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code --> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/QuartzSessionValidationScheduler.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/quartz/QuartzSessionValidationJob.html" title="class in org.apache.shiro.session.mgt.quartz"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" target="_top">Frames</a></li> |
| <li><a href="QuartzSessionValidationScheduler.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.quartz</div> |
| <h2 title="Class QuartzSessionValidationScheduler" class="title">Class QuartzSessionValidationScheduler</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler</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/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.47">QuartzSessionValidationScheduler</a> |
| extends <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a></pre> |
| <div class="block">An implementation of the <a href="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt"><code>SessionValidationScheduler</code></a> that uses Quartz to schedule a |
| job to call <a href="../../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html#validateSessions--"><code>ValidatingSessionManager.validateSessions()</code></a> on |
| a regular basis.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#DEFAULT_SESSION_VALIDATION_INTERVAL">DEFAULT_SESSION_VALIDATION_INTERVAL</a></span></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/quartz/QuartzSessionValidationScheduler.html#setSessionValidationInterval-long-"><code>setSessionValidationInterval(long)</code></a></div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#QuartzSessionValidationScheduler--">QuartzSessionValidationScheduler</a></span>()</code> |
| <div class="block">Default constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#QuartzSessionValidationScheduler-org.apache.shiro.session.mgt.ValidatingSessionManager-">QuartzSessionValidationScheduler</a></span>(<a href="../../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</a> sessionManager)</code> |
| <div class="block">Constructor that specifies the session manager that should be used for validating sessions.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#disableSessionValidation--">disableSessionValidation</a></span>()</code> |
| <div class="block">Disables the session validation job.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#enableSessionValidation--">enableSessionValidation</a></span>()</code> |
| <div class="block">Starts session validation by creating a Quartz simple trigger, linking it to |
| the <a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationJob.html" title="class in org.apache.shiro.session.mgt.quartz"><code>QuartzSessionValidationJob</code></a>, and scheduling it with the Quartz scheduler.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://www.quartz-scheduler.org/api/1.8.6/org/quartz/Scheduler.html?is-external=true" title="class or interface in org.quartz">Scheduler</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#getScheduler--">getScheduler</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#isEnabled--">isEnabled</a></span>()</code> |
| <div class="block">Returns <code>true</code> if this Scheduler is enabled and ready to begin validation at the appropriate time, |
| <code>false</code> otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#setScheduler-org.quartz.Scheduler-">setScheduler</a></span>(<a href="https://www.quartz-scheduler.org/api/1.8.6/org/quartz/Scheduler.html?is-external=true" title="class or interface in org.quartz">Scheduler</a> scheduler)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#setSessionManager-org.apache.shiro.session.mgt.ValidatingSessionManager-">setSessionManager</a></span>(<a href="../../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</a> sessionManager)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#setSessionValidationInterval-long-">setSessionValidationInterval</a></span>(long sessionValidationInterval)</code> |
| <div class="block">Specifies how frequently (in milliseconds) this Scheduler will call the |
| <a href="../../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html#validateSessions--"><code>ValidatingSessionManager#validateSessions()</code></a> method.</div> |
| </td> |
| </tr> |
| </table> |
| <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="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ 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="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_SESSION_VALIDATION_INTERVAL</h4> |
| <pre>public static final long <a href="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.58">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/quartz/QuartzSessionValidationScheduler.html#setSessionValidationInterval-long-"><code>setSessionValidationInterval(long)</code></a></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../constant-values.html#org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler.DEFAULT_SESSION_VALIDATION_INTERVAL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="QuartzSessionValidationScheduler--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QuartzSessionValidationScheduler</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.97">QuartzSessionValidationScheduler</a>()</pre> |
| <div class="block">Default constructor.</div> |
| </li> |
| </ul> |
| <a name="QuartzSessionValidationScheduler-org.apache.shiro.session.mgt.ValidatingSessionManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>QuartzSessionValidationScheduler</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.105">QuartzSessionValidationScheduler</a>(<a href="../../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</a> sessionManager)</pre> |
| <div class="block">Constructor that specifies the session manager that should be used for validating sessions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionManager</code> - the <tt>SessionManager</tt> that should be used to validate sessions.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getScheduler--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheduler</h4> |
| <pre>protected <a href="https://www.quartz-scheduler.org/api/1.8.6/org/quartz/Scheduler.html?is-external=true" title="class or interface in org.quartz">Scheduler</a> <a href="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.113">getScheduler</a>() |
| throws <a href="https://www.quartz-scheduler.org/api/1.8.6/org/quartz/SchedulerException.html?is-external=true" title="class or interface in org.quartz">SchedulerException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://www.quartz-scheduler.org/api/1.8.6/org/quartz/SchedulerException.html?is-external=true" title="class or interface in org.quartz">SchedulerException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setScheduler-org.quartz.Scheduler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setScheduler</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.121">setScheduler</a>(<a href="https://www.quartz-scheduler.org/api/1.8.6/org/quartz/Scheduler.html?is-external=true" title="class or interface in org.quartz">Scheduler</a> scheduler)</pre> |
| </li> |
| </ul> |
| <a name="setSessionManager-org.apache.shiro.session.mgt.ValidatingSessionManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionManager</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.125">setSessionManager</a>(<a href="../../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</a> sessionManager)</pre> |
| </li> |
| </ul> |
| <a name="isEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEnabled</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.129">isEnabled</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html#isEnabled--">SessionValidationScheduler</a></code></span></div> |
| <div class="block">Returns <code>true</code> if this Scheduler is enabled and ready to begin validation at the appropriate time, |
| <code>false</code> otherwise. |
| <p/> |
| It does <em>not</em> indicate if the validation is actually executing at that instant - only that it is prepared |
| to do so at the appropriate time.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html#isEnabled--">isEnabled</a></code> in interface <code><a href="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if this Scheduler is enabled and ready to begin validation at the appropriate time, |
| <code>false</code> otherwise.</dd> |
| </dl> |
| </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/quartz/QuartzSessionValidationScheduler.html#line.141">setSessionValidationInterval</a>(long sessionValidationInterval)</pre> |
| <div class="block">Specifies how frequently (in milliseconds) this Scheduler will call the |
| <a href="../../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html#validateSessions--"><code>ValidatingSessionManager#validateSessions()</code></a> method. |
| |
| <p>Unless this method is called, the default value is <a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#DEFAULT_SESSION_VALIDATION_INTERVAL"><code>DEFAULT_SESSION_VALIDATION_INTERVAL</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sessionValidationInterval</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="enableSessionValidation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enableSessionValidation</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.153">enableSessionValidation</a>()</pre> |
| <div class="block">Starts session validation by creating a Quartz simple trigger, linking it to |
| the <a href="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationJob.html" title="class in org.apache.shiro.session.mgt.quartz"><code>QuartzSessionValidationJob</code></a>, and scheduling it with the Quartz scheduler.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html#enableSessionValidation--">enableSessionValidation</a></code> in interface <code><a href="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="disableSessionValidation--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>disableSessionValidation</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.195">disableSessionValidation</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html#disableSessionValidation--">SessionValidationScheduler</a></code></span></div> |
| <div class="block">Disables the session validation job.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html#disableSessionValidation--">disableSessionValidation</a></code> in interface <code><a href="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/QuartzSessionValidationScheduler.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/quartz/QuartzSessionValidationJob.html" title="class in org.apache.shiro.session.mgt.quartz"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" target="_top">Frames</a></li> |
| <li><a href="QuartzSessionValidationScheduler.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–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |