blob: d6c908f5d53ce8348e9353c156ec553a17bd2e8b [file] [log] [blame]
<!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 Tue Feb 25 18:17:26 EST 2014 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
Index (Apache Shiro :: Support :: Quartz 1.2.3 API)
</TITLE>
<META NAME="date" CONTENT="2014-02-25">
<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="Index (Apache Shiro :: Support :: Quartz 1.2.3 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="./org/apache/shiro/session/mgt/quartz/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./org/apache/shiro/session/mgt/quartz/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Index</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV&nbsp;
&nbsp;NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="./index.html?index-all.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="index-all.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<A HREF="#_D_">D</A> <A HREF="#_E_">E</A> <A HREF="#_G_">G</A> <A HREF="#_I_">I</A> <A HREF="#_O_">O</A> <A HREF="#_Q_">Q</A> <A HREF="#_S_">S</A> <HR>
<A NAME="_D_"><!-- --></A><H2>
<B>D</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#DEFAULT_SESSION_VALIDATION_INTERVAL"><B>DEFAULT_SESSION_VALIDATION_INTERVAL</B></A> -
Static variable in class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationScheduler</A>
<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>QuartzSessionValidationScheduler.setSessionValidationInterval(long)</CODE></A>
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#disableSessionValidation()"><B>disableSessionValidation()</B></A> -
Method in class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationScheduler</A>
<DD>&nbsp;
</DL>
<HR>
<A NAME="_E_"><!-- --></A><H2>
<B>E</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#enableSessionValidation()"><B>enableSessionValidation()</B></A> -
Method in class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationScheduler</A>
<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.
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationJob.html#execute(org.quartz.JobExecutionContext)"><B>execute(JobExecutionContext)</B></A> -
Method in class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationJob.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationJob</A>
<DD>Called when the job is executed by quartz.
</DL>
<HR>
<A NAME="_G_"><!-- --></A><H2>
<B>G</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#getScheduler()"><B>getScheduler()</B></A> -
Method in class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationScheduler</A>
<DD>&nbsp;
</DL>
<HR>
<A NAME="_I_"><!-- --></A><H2>
<B>I</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#isEnabled()"><B>isEnabled()</B></A> -
Method in class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationScheduler</A>
<DD>&nbsp;
</DL>
<HR>
<A NAME="_O_"><!-- --></A><H2>
<B>O</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/package-summary.html"><B>org.apache.shiro.session.mgt.quartz</B></A> - package org.apache.shiro.session.mgt.quartz<DD><a href="http://www.opensymphony.com/quartz/" target="_top">Quartz</a>-based implementations of
components that help <tt>SessionManager</tt> implementations maintain sessions (timed expiration, orphan cleanup,
etc).</DL>
<HR>
<A NAME="_Q_"><!-- --></A><H2>
<B>Q</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationJob.html" title="class in org.apache.shiro.session.mgt.quartz"><B>QuartzSessionValidationJob</B></A> - Class in <A HREF="./org/apache/shiro/session/mgt/quartz/package-summary.html">org.apache.shiro.session.mgt.quartz</A><DD>A quartz job that basically just calls the <CODE>ValidatingSessionManager.validateSessions()</CODE>
method on a configured session manager.<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationJob.html#QuartzSessionValidationJob()"><B>QuartzSessionValidationJob()</B></A> -
Constructor for class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationJob.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationJob</A>
<DD>&nbsp;
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt.quartz"><B>QuartzSessionValidationScheduler</B></A> - Class in <A HREF="./org/apache/shiro/session/mgt/quartz/package-summary.html">org.apache.shiro.session.mgt.quartz</A><DD>An implementation of the <CODE>SessionValidationScheduler</CODE> that uses Quartz to schedule a
job to call <CODE>ValidatingSessionManager.validateSessions()</CODE> on
a regular basis.<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#QuartzSessionValidationScheduler()"><B>QuartzSessionValidationScheduler()</B></A> -
Constructor for class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationScheduler</A>
<DD>Default constructor.
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#QuartzSessionValidationScheduler(org.apache.shiro.session.mgt.ValidatingSessionManager)"><B>QuartzSessionValidationScheduler(ValidatingSessionManager)</B></A> -
Constructor for class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationScheduler</A>
<DD>Constructor that specifies the session manager that should be used for validating sessions.
</DL>
<HR>
<A NAME="_S_"><!-- --></A><H2>
<B>S</B></H2>
<DL>
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#setScheduler(org.quartz.Scheduler)"><B>setScheduler(Scheduler)</B></A> -
Method in class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationScheduler</A>
<DD>&nbsp;
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#setSessionManager(org.apache.shiro.session.mgt.ValidatingSessionManager)"><B>setSessionManager(ValidatingSessionManager)</B></A> -
Method in class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationScheduler</A>
<DD>&nbsp;
<DT><A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html#setSessionValidationInterval(long)"><B>setSessionValidationInterval(long)</B></A> -
Method in class org.apache.shiro.session.mgt.quartz.<A HREF="./org/apache/shiro/session/mgt/quartz/QuartzSessionValidationScheduler.html" title="class in org.apache.shiro.session.mgt.quartz">QuartzSessionValidationScheduler</A>
<DD>Specifies how frequently (in milliseconds) this Scheduler will call the
<CODE>ValidatingSessionManager#validateSessions()</CODE> method.
</DL>
<HR>
<A HREF="#_D_">D</A> <A HREF="#_E_">E</A> <A HREF="#_G_">G</A> <A HREF="#_I_">I</A> <A HREF="#_O_">O</A> <A HREF="#_Q_">Q</A> <A HREF="#_S_">S</A>
<!-- ======= 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="./org/apache/shiro/session/mgt/quartz/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./org/apache/shiro/session/mgt/quartz/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Index</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="./help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV&nbsp;
&nbsp;NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="./index.html?index-all.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="index-all.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2004-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
</BODY>
</HTML>