org.rakeshv.filters
Class CachingFilter.Attributes

java.lang.Object
  org.rakeshv.filters.CachingFilter.Attributes

Enclosing class:

CachingFilter

public class CachingFilter.Attributes
extends java.lang.Object

A data structure used to hold the cache validity period attributes. Fields in this data structure are used to control the TTL for cached files, or the interval at which the cache directory is to be purged.

Field Summary

static boolean	CLEAN_BASE_DIRECTORY The value to indicate that the cleanBaseDirectory is to be enabled.
private boolean	cleanBaseDirectory A flag that indicates whether the CachingFilter.baseDirectory should be cleaned on application start or not.
static boolean	NO_CLEAN_BASE_DIRECTORY The value to indicate that the cleanBaseDirectory is to be disabled.
static int	NO_PURGE_INTERVAL The value to indicate that the purgeInterval variable should not be considered.
static int	NO_TIME_TO_LIVE The value to indicate that the timeToLive variable should not be considered.
private int	purgeInterval The time interval at which the cached files must be automatically purged.
private CachingFilter.PurgeTime	purgeTime The time of day at which the cached files must be automatically purged.
private int	timeToLive The time in seconds till which an individual cache file must persist.

Constructor Summary

protected

CachingFilter.Attributes() Default constructor.

Method Summary

private void	initCleanBaseDirectory() Initialise the cleanBaseDirectory field.
private void	initPurgeInterval() Initialise the purgeInterval field.
private void	initPurgeTime() Initialise the purgeTime field.
private void	initTimeToLive() Initialise the timeToLive field.

Methods inherited from class java.lang.Object

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

Field Detail

CLEAN_BASE_DIRECTORY

public static final boolean CLEAN_BASE_DIRECTORY

The value to indicate that the cleanBaseDirectory is to be enabled.

See Also:

Constant Field Values

NO_CLEAN_BASE_DIRECTORY

public static final boolean NO_CLEAN_BASE_DIRECTORY

The value to indicate that the cleanBaseDirectory is to be disabled.

See Also:

Constant Field Values

NO_TIME_TO_LIVE

public static final int NO_TIME_TO_LIVE

The value to indicate that the timeToLive variable should not be considered.

See Also:

Constant Field Values

NO_PURGE_INTERVAL

public static final int NO_PURGE_INTERVAL

The value to indicate that the purgeInterval variable should not be considered.

See Also:

Constant Field Values

cleanBaseDirectory

private boolean cleanBaseDirectory

A flag that indicates whether the CachingFilter.baseDirectory should be cleaned on application start or not.

timeToLive

private int timeToLive

The time in seconds till which an individual cache file must persist.

purgeInterval

private int purgeInterval

The time interval at which the cached files must be automatically purged.

purgeTime

private CachingFilter.PurgeTime purgeTime

The time of day at which the cached files must be automatically purged.

Constructor Detail

CachingFilter.Attributes

protected CachingFilter.Attributes()

Default constructor. Initialises the purgeTime.

Method Detail

initCleanBaseDirectory

private void initCleanBaseDirectory()

Initialise the cleanBaseDirectory field. Set to NO_CLEAN_BASE_DIRECTORY if no configuration was found, or if the value is the same as NO_CLEAN_BASE_DIRECTORY

initTimeToLive

private void initTimeToLive()

Initialise the timeToLive field. Set to NO_TIME_TO_LIVE if no configuration was found, or if the value is the same as NO_TIME_TO_LIVE.

initPurgeInterval

private void initPurgeInterval()

Initialise the purgeInterval field. Set to NO_PURGE_INTERVAL if no configuration was found, or if the value is the same as NO_PURGE_INTERVAL.

initPurgeTime

private void initPurgeTime()

Initialise the purgeTime field. Set to CachingFilter.NO_PURGE_TIME if no configuration was found, or if the * is the same as CachingFilter.NO_PURGE_TIME.