HouseKeeper (Aspectran API Reference (6.5.0-RC2))

java.lang.Object
- com.aspectran.core.component.session.HouseKeeper

```
public class HouseKeeper
extends java.lang.Object
```
The housekeeper for session scavenging. There is 1 session HouseKeeper per SessionManager instance.

Constructor Summary

Constructors
Constructor Description

HouseKeeper(SessionHandler sessionHandler)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getScavengingInterval()`	Get the period between scavenge cycles.
`boolean`	`isScavengable()`
`void`	`setScavengingInterval(int intervalInSecs)`	Set the period between scavenge cycles.
`void`	`startScavenging()`
`void`	`startScavenging(int intervalInSecs)`	If scavenging is not scheduled, schedule it.
`void`	`stopScavenging()`	If scavenging is scheduled, stop it.
`java.lang.String`	`toString()`

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

- 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)
  - isScavengable
```
public boolean isScavengable()
```
  - startScavenging
```
public void startScavenging()
```
  - startScavenging
```
public void startScavenging(int intervalInSecs)
```
    If scavenging is not scheduled, schedule it.
    
    Parameters:
    
    intervalInSecs - the interval (in seconds)
  - stopScavenging
```
public void stopScavenging()
```
    If scavenging is scheduled, stop it.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object