HouseKeeper (Aspectran API Reference (7.0.0))

java.lang.Object
- com.aspectran.core.util.lifecycle.AbstractLifeCycle
- - com.aspectran.core.component.session.HouseKeeper

All Implemented Interfaces:

LifeCycle
```
public class HouseKeeper
extends AbstractLifeCycle
```
The housekeeper for session scavenging. There is 1 session HouseKeeper per SessionManager instance.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.aspectran.core.util.lifecycle.LifeCycle
  LifeCycle.Listener

Field Summary

Fields
Modifier and Type Field Description

static long DEFAULT_SCAVENGING_INTERVAL_MS
- Fields inherited from interface com.aspectran.core.util.lifecycle.LifeCycle
  FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors
Constructor Description

HouseKeeper(SessionHandler sessionHandler)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doStart()`
`protected void`	`doStop()`
`int`	`getScavengingInterval()`	Get the period between scavenge cycles.
`void`	`setScavengingInterval(int intervalInSecs)`	Set the period between scavenge cycles.
`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 com.aspectran.core.util.lifecycle.AbstractLifeCycle
addLifeCycleListener, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_SCAVENGING_INTERVAL_MS
```
public static final long DEFAULT_SCAVENGING_INTERVAL_MS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HouseKeeper
```
public HouseKeeper(SessionHandler sessionHandler)
```
    Parameters:
    
    sessionHandler - SessionHandler associated with this scavenger
- Method Detail
  - getScavengingInterval
```
public int getScavengingInterval()
```
    Get the period between scavenge cycles.
    
    Returns:
    
    the interval (in seconds)
  - setScavengingInterval
```
public void setScavengingInterval(int intervalInSecs)
```
    Set the period between scavenge cycles.
    
    Parameters:
    
    intervalInSecs - the interval (in seconds)
  - startScavenging
```
protected void startScavenging()
```
    If scavenging is not scheduled, schedule it.
  - stopScavenging
```
protected void stopScavenging()
```
    If scavenging is scheduled, stop it.
  - doStart
```
protected void doStart()
                throws java.lang.Exception
```
    Overrides:
    
    doStart in class AbstractLifeCycle
    
    Throws:
    
    java.lang.Exception
  - doStop
```
protected void doStop()
               throws java.lang.Exception
```
    Overrides:
    
    doStop in class AbstractLifeCycle
    
    Throws:
    
    java.lang.Exception
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class AbstractLifeCycle