Interface IDiskCacheAttributes
- All Superinterfaces:
AuxiliaryCacheAttributes
,Cloneable
,Serializable
- All Known Implementing Classes:
AbstractDiskCacheAttributes
,BlockDiskCacheAttributes
,IndexedDiskCacheAttributes
,JDBCDiskCacheAttributes
,MySQLDiskCacheAttributes
Common disk cache attributes.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
This is the default purgatory size limit. -
Method Summary
Modifier and TypeMethodDescriptionGets the diskPath attribute of the attributes objectint
Gets the maxKeySize attribute of the DiskCacheAttributes objectint
Get the amount of time in seconds we will wait for elements to move to disk during shutdown for a particular region.boolean
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
setDiskLimitType
(IDiskCacheAttributes.DiskLimitType diskLimitType) set the type of the limit of the cache sizevoid
setDiskLimitTypeName
(String diskLimitTypeName) Translates and stores String values of DiskLimitType Allowed values: "COUNT" and "SIZE"void
setDiskPath
(String path) Sets the diskPath attribute of the IJISPCacheAttributes objectvoid
setMaxPurgatorySize
(int maxPurgatorySize) Sets the maxPurgatorySize attribute of the DiskCacheAttributes objectvoid
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.commons.jcs3.auxiliary.AuxiliaryCacheAttributes
clone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
-
Field Details
-
MAX_PURGATORY_SIZE_DEFAULT
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:
-
-
Method Details
-
setDiskPath
Sets the diskPath attribute of the IJISPCacheAttributes object- Parameters:
path
- The new diskPath value
-
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
Sets the maxPurgatorySize attribute of the DiskCacheAttributes object- Parameters:
maxPurgatorySize
- The new maxPurgatorySize value
-
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
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
If this is false, then remove all requests will not be honored.This provides a safety mechanism for the persistent store.
- Parameters:
allowRemoveAll
-
-
setDiskLimitType
set the type of the limit of the cache size- Parameters:
diskLimitType
- COUNT - limit by count of the elements, SIZE, limit by sum of element's size
-
setDiskLimitTypeName
Translates and stores String values of DiskLimitType Allowed values: "COUNT" and "SIZE"- Parameters:
diskLimitTypeName
-
-
getDiskLimitType
- Returns:
- active DiskLimitType
-