org.eclipse.jetty.server.session

Class HouseKeeper

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.server.session.HouseKeeper

All Implemented Interfaces:

LifeCycle

@ManagedObject
public class HouseKeeper
extends AbstractLifeCycle

HouseKeeper There is 1 session HouseKeeper per SessionIdManager instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HouseKeeper.Runner Runner

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_ownScheduler
protected HouseKeeper.Runner	_runner
protected Scheduler	_scheduler
protected SessionIdManager	_sessionIdManager
protected Scheduler.Task	_task
static long	DEFAULT_PERIOD_MS

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
HouseKeeper()

Method Summary

Modifier and Type	Method and Description
protected void	doStart()
protected void	doStop()
protected void	findScheduler() Get a scheduler.
long	getIntervalSec() Get the period between scavenge cycles.
void	scavenge() Periodically do session housekeeping
void	setIntervalSec(long sec) Set the period between scavenge cycles
void	setSessionIdManager(SessionIdManager sessionIdManager) SessionIdManager associated with this scavenger
protected void	startScavenging() If scavenging is not scheduled, schedule it.
protected void	stopScavenging() If scavenging is scheduled, stop it.
java.lang.String	toString()

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

start, stop

Field Detail

DEFAULT_PERIOD_MS

public static final long DEFAULT_PERIOD_MS

See Also:

Constant Field Values

_sessionIdManager

protected SessionIdManager _sessionIdManager

_scheduler

protected Scheduler _scheduler

_task

protected Scheduler.Task _task

_runner

protected HouseKeeper.Runner _runner

_ownScheduler

protected boolean _ownScheduler

Constructor Detail

HouseKeeper

public HouseKeeper()

Method Detail

setSessionIdManager

public void setSessionIdManager(SessionIdManager sessionIdManager)

SessionIdManager associated with this scavenger

Parameters:

sessionIdManager - the session id manager

doStart

protected void doStart()
                throws java.lang.Exception

Overrides:

doStart in class AbstractLifeCycle

Throws:

java.lang.Exception

See Also:

AbstractLifeCycle.doStart()

findScheduler

protected void findScheduler()
                      throws java.lang.Exception

Get a scheduler. First try a common scheduler, failing that create our own.

Throws:

java.lang.Exception - when the scheduler cannot be started

startScavenging

protected void startScavenging()
                        throws java.lang.Exception

If scavenging is not scheduled, schedule it.

Throws:

java.lang.Exception - if any error during scheduling the scavenging

stopScavenging

protected void stopScavenging()
                       throws java.lang.Exception

If scavenging is scheduled, stop it.

Throws:

java.lang.Exception - if any error during stopping the scavenging

doStop

protected void doStop()
               throws java.lang.Exception

Overrides:

doStop in class AbstractLifeCycle

Throws:

java.lang.Exception

See Also:

AbstractLifeCycle.doStop()

setIntervalSec

public void setIntervalSec(long sec)
                    throws java.lang.Exception

Set the period between scavenge cycles

Parameters:

sec - the interval (in seconds)

Throws:

java.lang.Exception - if any error during restarting the scavenging

getIntervalSec

@ManagedAttribute(value="secs between scavenge cycles",
                  readonly=true)
public long getIntervalSec()

Get the period between scavenge cycles.

Returns:

the interval (in seconds)

scavenge

public void scavenge()

Periodically do session housekeeping

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()