| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_65) on Fri Mar 04 17:58:57 EST 2016 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| QuartzSessionValidationScheduler (Apache Shiro 1.2.4 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2016-03-04"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="QuartzSessionValidationScheduler (Apache Shiro 1.2.4 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/QuartzSessionValidationScheduler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationJob.html" title="class in org.apache.shiro.session.mgt.quartz"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="QuartzSessionValidationScheduler.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.shiro.session.mgt.quartz</FONT> |
| <BR> |
| Class QuartzSessionValidationScheduler</H2> |
| <PRE> |
| <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> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <A HREF="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.42"><B>QuartzSessionValidationScheduler</B></A><DT>extends <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><DT>implements <A HREF="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html" title="interface in org.apache.shiro.session.mgt">SessionValidationScheduler</A></DL> |
| </PRE> |
| |
| <P> |
| 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. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.1</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#DEFAULT_SESSION_VALIDATION_INTERVAL">DEFAULT_SESSION_VALIDATION_INTERVAL</A></B></CODE> |
| |
| <BR> |
| 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></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#QuartzSessionValidationScheduler()">QuartzSessionValidationScheduler</A></B>()</CODE> |
| |
| <BR> |
| Default constructor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#QuartzSessionValidationScheduler(org.apache.shiro.session.mgt.ValidatingSessionManager)">QuartzSessionValidationScheduler</A></B>(<A HREF="../../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</A> sessionManager)</CODE> |
| |
| <BR> |
| Constructor that specifies the session manager that should be used for validating sessions.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#disableSessionValidation()">disableSessionValidation</A></B>()</CODE> |
| |
| <BR> |
| Disables the session validation job.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#enableSessionValidation()">enableSessionValidation</A></B>()</CODE> |
| |
| <BR> |
| 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected org.quartz.Scheduler</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#getScheduler()">getScheduler</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#isEnabled()">isEnabled</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if this Scheduler is enabled and ready to begin validation at the appropriate time, |
| <code>false</code> otherwise.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#setScheduler(org.quartz.Scheduler)">setScheduler</A></B>(org.quartz.Scheduler scheduler)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#setSessionManager(org.apache.shiro.session.mgt.ValidatingSessionManager)">setSessionManager</A></B>(<A HREF="../../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</A> sessionManager)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#setSessionValidationInterval(long)">setSessionValidationInterval</A></B>(long sessionValidationInterval)</CODE> |
| |
| <BR> |
| 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.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="DEFAULT_SESSION_VALIDATION_INTERVAL"><!-- --></A><H3> |
| DEFAULT_SESSION_VALIDATION_INTERVAL</H3> |
| <PRE> |
| public static final long <A HREF="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.53"><B>DEFAULT_SESSION_VALIDATION_INTERVAL</B></A></PRE> |
| <DL> |
| <DD>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> |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler.DEFAULT_SESSION_VALIDATION_INTERVAL">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="QuartzSessionValidationScheduler()"><!-- --></A><H3> |
| QuartzSessionValidationScheduler</H3> |
| <PRE> |
| public <A HREF="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.92"><B>QuartzSessionValidationScheduler</B></A>()</PRE> |
| <DL> |
| <DD>Default constructor. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="QuartzSessionValidationScheduler(org.apache.shiro.session.mgt.ValidatingSessionManager)"><!-- --></A><H3> |
| QuartzSessionValidationScheduler</H3> |
| <PRE> |
| public <A HREF="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.100"><B>QuartzSessionValidationScheduler</B></A>(<A HREF="../../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</A> sessionManager)</PRE> |
| <DL> |
| <DD>Constructor that specifies the session manager that should be used for validating sessions. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>sessionManager</CODE> - the <tt>SessionManager</tt> that should be used to validate sessions.</DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getScheduler()"><!-- --></A><H3> |
| getScheduler</H3> |
| <PRE> |
| protected org.quartz.Scheduler <A HREF="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.108"><B>getScheduler</B></A>() |
| throws org.quartz.SchedulerException</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>org.quartz.SchedulerException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setScheduler(org.quartz.Scheduler)"><!-- --></A><H3> |
| setScheduler</H3> |
| <PRE> |
| public void <A HREF="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.116"><B>setScheduler</B></A>(org.quartz.Scheduler scheduler)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSessionManager(org.apache.shiro.session.mgt.ValidatingSessionManager)"><!-- --></A><H3> |
| setSessionManager</H3> |
| <PRE> |
| public void <A HREF="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.120"><B>setSessionManager</B></A>(<A HREF="../../../../../../org/apache/shiro/session/mgt/ValidatingSessionManager.html" title="interface in org.apache.shiro.session.mgt">ValidatingSessionManager</A> sessionManager)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isEnabled()"><!-- --></A><H3> |
| isEnabled</H3> |
| <PRE> |
| public boolean <A HREF="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.124"><B>isEnabled</B></A>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html#isEnabled()">SessionValidationScheduler</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this Scheduler is enabled and ready to begin validation at the appropriate time, |
| <code>false</code> otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSessionValidationInterval(long)"><!-- --></A><H3> |
| setSessionValidationInterval</H3> |
| <PRE> |
| public void <A HREF="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.136"><B>setSessionValidationInterval</B></A>(long sessionValidationInterval)</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>sessionValidationInterval</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="enableSessionValidation()"><!-- --></A><H3> |
| enableSessionValidation</H3> |
| <PRE> |
| public void <A HREF="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.148"><B>enableSessionValidation</B></A>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="disableSessionValidation()"><!-- --></A><H3> |
| disableSessionValidation</H3> |
| <PRE> |
| public void <A HREF="../../../../../../src-html/org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#line.186"><B>disableSessionValidation</B></A>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/shiro/session/mgt/SessionValidationScheduler.html#disableSessionValidation()">SessionValidationScheduler</A></CODE></B></DD> |
| <DD>Disables the session validation job. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/QuartzSessionValidationScheduler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/apache/shiro/session/mgt/quartz/QuartzSessionValidationJob.html" title="class in org.apache.shiro.session.mgt.quartz"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="QuartzSessionValidationScheduler.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
