org.apache.shiro.session.mgt.quartz
Class QuartzSessionValidationScheduler

java.lang.Object
  extended by org.apache.shiro.session.mgt.quartz.QuartzSessionValidationScheduler
All Implemented Interfaces:
SessionValidationScheduler

public class QuartzSessionValidationScheduler
extends Object
implements SessionValidationScheduler

An implementation of the SessionValidationScheduler that uses Quartz to schedule a job to call ValidatingSessionManager.validateSessions() on a regular basis.

Since:
0.1

Field Summary
static long DEFAULT_SESSION_VALIDATION_INTERVAL
          The default interval at which sessions will be validated (1 hour); This can be overridden by calling setSessionValidationInterval(long)
 
Constructor Summary
QuartzSessionValidationScheduler()
          Default constructor.
QuartzSessionValidationScheduler(ValidatingSessionManager sessionManager)
          Constructor that specifies the session manager that should be used for validating sessions.
 
Method Summary
 void disableSessionValidation()
          Disables the session validation job.
 void enableSessionValidation()
          Starts session validation by creating a Quartz simple trigger, linking it to the QuartzSessionValidationJob, and scheduling it with the Quartz scheduler.
protected  org.quartz.Scheduler getScheduler()
           
 boolean isEnabled()
          Returns true if this Scheduler is enabled and ready to begin validation at the appropriate time, false otherwise.
 void setScheduler(org.quartz.Scheduler scheduler)
           
 void setSessionManager(ValidatingSessionManager sessionManager)
           
 void setSessionValidationInterval(long sessionValidationInterval)
          Specifies how frequently (in milliseconds) this Scheduler will call the ValidatingSessionManager#validateSessions() method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_SESSION_VALIDATION_INTERVAL

public static final long DEFAULT_SESSION_VALIDATION_INTERVAL
The default interval at which sessions will be validated (1 hour); This can be overridden by calling setSessionValidationInterval(long)

See Also:
Constant Field Values
Constructor Detail

QuartzSessionValidationScheduler

public QuartzSessionValidationScheduler()
Default constructor.


QuartzSessionValidationScheduler

public QuartzSessionValidationScheduler(ValidatingSessionManager sessionManager)
Constructor that specifies the session manager that should be used for validating sessions.

Parameters:
sessionManager - the SessionManager that should be used to validate sessions.
Method Detail

getScheduler

protected org.quartz.Scheduler getScheduler()
                                     throws org.quartz.SchedulerException
Throws:
org.quartz.SchedulerException

setScheduler

public void setScheduler(org.quartz.Scheduler scheduler)

setSessionManager

public void setSessionManager(ValidatingSessionManager sessionManager)

isEnabled

public boolean isEnabled()
Description copied from interface: SessionValidationScheduler
Returns true if this Scheduler is enabled and ready to begin validation at the appropriate time, false otherwise.

It does not indicate if the validation is actually executing at that instant - only that it is prepared to do so at the appropriate time.

Specified by:
isEnabled in interface SessionValidationScheduler
Returns:
true if this Scheduler is enabled and ready to begin validation at the appropriate time, false otherwise.

setSessionValidationInterval

public void setSessionValidationInterval(long sessionValidationInterval)
Specifies how frequently (in milliseconds) this Scheduler will call the ValidatingSessionManager#validateSessions() method.

Unless this method is called, the default value is DEFAULT_SESSION_VALIDATION_INTERVAL.

Parameters:
sessionValidationInterval -

enableSessionValidation

public void enableSessionValidation()
Starts session validation by creating a Quartz simple trigger, linking it to the QuartzSessionValidationJob, and scheduling it with the Quartz scheduler.

Specified by:
enableSessionValidation in interface SessionValidationScheduler

disableSessionValidation

public void disableSessionValidation()
Description copied from interface: SessionValidationScheduler
Disables the session validation job.

Specified by:
disableSessionValidation in interface SessionValidationScheduler


Copyright © 2004-2014 The Apache Software Foundation. All Rights Reserved.