org.apache.jcs.auxiliary.disk.behavior
Interface IDiskCacheAttributes

All Superinterfaces:
AuxiliaryCacheAttributes, java.lang.Cloneable, java.io.Serializable
All Known Implementing Classes:
AbstractDiskCacheAttributes, BlockDiskCacheAttributes, IndexedDiskCacheAttributes, JDBCDiskCacheAttributes, MySQLDiskCacheAttributes

public interface IDiskCacheAttributes
extends AuxiliaryCacheAttributes

Common disk cache attributes.


Field Summary
static int MAX_PURGATORY_SIZE_DEFUALT
          This is the default purgatory size limit.
 
Fields inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes
POOLED_QUEUE_TYPE, SINGLE_QUEUE_TYPE
 
Method Summary
 java.lang.String getDiskPath()
          Gets the diskPath attribute of the attributes 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.
 boolean isAllowRemoveAll()
          If this is true then remove all is not prohibited.
 void setAllowRemoveAll(boolean allowRemoveAll)
          If this is false, then remove all requests will not be honored.
 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.
 
Methods inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes
copy, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
 

Field Detail

MAX_PURGATORY_SIZE_DEFUALT

static final int MAX_PURGATORY_SIZE_DEFUALT
This is the default purgatory size limit. Purgatory is the area where items to be spooled are temporarily stored. It basically provides access to items on the to-be-spooled queue.

See Also:
Constant Field Values
Method Detail

setDiskPath

void setDiskPath(java.lang.String path)
Sets the diskPath attribute of the IJISPCacheAttributes object

Parameters:
path - The new diskPath value

getDiskPath

java.lang.String getDiskPath()
Gets the diskPath attribute of the attributes object

Returns:
The diskPath value

getMaxPurgatorySize

int getMaxPurgatorySize()
Gets the maxKeySize attribute of the DiskCacheAttributes object

Returns:
The maxPurgatorySize value

setMaxPurgatorySize

void setMaxPurgatorySize(int maxPurgatorySize)
Sets the maxPurgatorySize attribute of the DiskCacheAttributes object

Parameters:
maxPurgatorySize - The new maxPurgatorySize value

getShutdownSpoolTimeLimit

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

Returns:
the time in seconds.

setShutdownSpoolTimeLimit

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.

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

The default is 60 seconds.

Parameters:
shutdownSpoolTimeLimit - the time in seconds

isAllowRemoveAll

boolean isAllowRemoveAll()
If this is true then remove all is not prohibited.

Returns:
boolean

setAllowRemoveAll

void setAllowRemoveAll(boolean allowRemoveAll)
If this is false, then remove all requests will not be honored.

This provides a safety mechanism for the persistent store.

Parameters:
allowRemoveAll -


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.