Class ExecutorServiceSessionValidationScheduler

java.lang.Object

org.apache.shiro.session.mgt.ExecutorServiceSessionValidationScheduler

All Implemented Interfaces:

Runnable, SessionValidationScheduler

public class ExecutorServiceSessionValidationScheduler
extends Object
implements SessionValidationScheduler, Runnable

SessionValidationScheduler implementation that uses a ScheduledExecutorService to call ValidatingSessionManager.validateSessions() every sessionValidationInterval milliseconds.

Since:

0.9

Constructor Summary

Constructors

Constructor	Description
ExecutorServiceSessionValidationScheduler()
ExecutorServiceSessionValidationScheduler(ValidatingSessionManager sessionManager)

Method Summary

Modifier and Type	Method	Description
void	disableSessionValidation()	Disables the session validation job.
void	enableSessionValidation()	Creates a single thread ScheduledExecutorService to validate sessions at fixed intervals and enables this scheduler.
ValidatingSessionManager	getSessionManager()
long	getSessionValidationInterval()
String	getThreadNamePrefix()
boolean	isEnabled()	Returns true if this Scheduler is enabled and ready to begin validation at the appropriate time, false otherwise.
void	run()
void	setSessionManager(ValidatingSessionManager sessionManager)
void	setSessionValidationInterval(long sessionValidationInterval)
void	setThreadNamePrefix(String threadNamePrefix)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExecutorServiceSessionValidationScheduler

public ExecutorServiceSessionValidationScheduler()

ExecutorServiceSessionValidationScheduler

public ExecutorServiceSessionValidationScheduler(ValidatingSessionManager sessionManager)

Method Details

getSessionManager

public ValidatingSessionManager getSessionManager()

setSessionManager

public void setSessionManager(ValidatingSessionManager sessionManager)

getSessionValidationInterval

public long getSessionValidationInterval()

setSessionValidationInterval

public void setSessionValidationInterval(long sessionValidationInterval)

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.

setThreadNamePrefix

public void setThreadNamePrefix(String threadNamePrefix)

getThreadNamePrefix

public String getThreadNamePrefix()

enableSessionValidation

public void enableSessionValidation()

Creates a single thread ScheduledExecutorService to validate sessions at fixed intervals and enables this scheduler. The executor is created as a daemon thread to allow JVM to shut down

Specified by:

enableSessionValidation in interface SessionValidationScheduler

run

public void run()

Specified by:

run in interface Runnable

disableSessionValidation

public void disableSessionValidation()

Description copied from interface: SessionValidationScheduler

Disables the session validation job.

Specified by:

disableSessionValidation in interface SessionValidationScheduler