org.apache.jcs.auxiliary.disk
Class AbstractDiskCacheAttributes

java.lang.Object
  org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes
      org.apache.jcs.auxiliary.disk.AbstractDiskCacheAttributes

All Implemented Interfaces:

AuxiliaryCacheAttributes, java.lang.Cloneable, IDiskCacheAttributes, java.io.Serializable

Direct Known Subclasses:

HSQLCacheAttributes, IndexedDiskCacheAttributes

public abstract class AbstractDiskCacheAttributes

extends AbstractAuxiliaryCacheAttributes

implements IDiskCacheAttributes

This has common attributes that any conceivable disk cache would need.

Author:

aaronsm

See Also:

Serialized Form

Field Summary

protected java.lang.String	diskPath path to disk
protected int	maxPurgatorySize default to 5000
protected int	shutdownSpoolTimeLimit This default determines how long the shutdown will wait for the key spool and data defrag to finish.

Fields inherited from class org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes

cacheName, eventQueuePoolName, eventQueueType, name

Fields inherited from interface org.apache.jcs.auxiliary.disk.behavior.IDiskCacheAttributes

MAX_PURGATORY_SIZE_DEFUALT

Fields inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes

POOLED_QUEUE_TYPE, SINGLE_QUEUE_TYPE

Constructor Summary

AbstractDiskCacheAttributes()

Method Summary

AuxiliaryCacheAttributes	copy() Description of the Method
java.lang.String	getDiskPath() Gets the diskPath attribute of the IJISPCacheAttributes object
int	getMaxPurgatorySize() Gets the maxKeySize attribute of the DiskCacheAttributes object
int	getShutdownSpoolTimeLimit() Get the amount of time in seconds we will wait for elements to move to disk during shutdown for a particular region.
void	setDiskPath(java.lang.String path) Sets the diskPath attribute of the IJISPCacheAttributes object
void	setMaxPurgatorySize(int maxPurgatorySize) Sets the maxPurgatorySize attribute of the DiskCacheAttributes object
void	setShutdownSpoolTimeLimit(int shutdownSpoolTimeLimit) Sets the amount of time in seconds we will wait for elements to move to disk during shutdown for a particular region.
java.lang.String	toString() Description of the Method

Methods inherited from class org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes

getCacheName, getEventQueuePoolName, getEventQueueType, getEventQueueTypeFactoryCode, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes

getCacheName, getEventQueuePoolName, getEventQueueType, getEventQueueTypeFactoryCode, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName

Field Detail

diskPath

protected java.lang.String diskPath

path to disk

maxPurgatorySize

protected int maxPurgatorySize

default to 5000

shutdownSpoolTimeLimit

protected int shutdownSpoolTimeLimit

This default determines how long the shutdown will wait for the key spool and data defrag to finish.

Constructor Detail

AbstractDiskCacheAttributes

public AbstractDiskCacheAttributes()

Method Detail

setDiskPath

public void setDiskPath(java.lang.String path)

Description copied from interface: IDiskCacheAttributes

Sets the diskPath attribute of the IJISPCacheAttributes object

Specified by:

setDiskPath in interface IDiskCacheAttributes

Parameters:

path - The new diskPath value

getDiskPath

public java.lang.String getDiskPath()

Description copied from interface: IDiskCacheAttributes

Gets the diskPath attribute of the IJISPCacheAttributes object

Specified by:

getDiskPath in interface IDiskCacheAttributes

Returns:

The diskPath value

getMaxPurgatorySize

public int getMaxPurgatorySize()

Description copied from interface: IDiskCacheAttributes

Gets the maxKeySize attribute of the DiskCacheAttributes object

Specified by:

getMaxPurgatorySize in interface IDiskCacheAttributes

Returns:

The maxPurgatorySize value

setMaxPurgatorySize

public void setMaxPurgatorySize(int maxPurgatorySize)

Description copied from interface: IDiskCacheAttributes

Sets the maxPurgatorySize attribute of the DiskCacheAttributes object

Specified by:

setMaxPurgatorySize in interface IDiskCacheAttributes

Parameters:

maxPurgatorySize - The new maxPurgatorySize value

getShutdownSpoolTimeLimit

public int getShutdownSpoolTimeLimit()

Description copied from interface: IDiskCacheAttributes

Get the amount of time in seconds we will wait for elements to move to disk during shutdown for a particular region.

Specified by:

getShutdownSpoolTimeLimit in interface IDiskCacheAttributes

Returns:

the time in seconds.

setShutdownSpoolTimeLimit

public void setShutdownSpoolTimeLimit(int shutdownSpoolTimeLimit)

Description copied from interface: IDiskCacheAttributes

Sets the amount of time in seconds we will wait for elements to move to disk during shutdown for a particular region.

This is how long we give the event queue to empty.

The default is 60 seconds.

Specified by:

setShutdownSpoolTimeLimit in interface IDiskCacheAttributes

Parameters:

shutdownSpoolTimeLimit - the time in seconds

copy

public AuxiliaryCacheAttributes copy()

Description of the Method

Specified by:

copy in interface AuxiliaryCacheAttributes

Returns:

AuxiliaryCacheAttributes

toString

public java.lang.String toString()

Description of the Method

Returns:

String