Class AbstractDiskCacheAttributes
java.lang.Object
org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheAttributes
org.apache.commons.jcs3.auxiliary.disk.AbstractDiskCacheAttributes
- All Implemented Interfaces:
- Serializable,- Cloneable,- AuxiliaryCacheAttributes,- IDiskCacheAttributes
- Direct Known Subclasses:
- BlockDiskCacheAttributes,- IndexedDiskCacheAttributes,- JDBCDiskCacheAttributes
public abstract class AbstractDiskCacheAttributes
extends AbstractAuxiliaryCacheAttributes
implements IDiskCacheAttributes
This has common attributes that any conceivable disk cache would need.
- See Also:
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.apache.commons.jcs3.auxiliary.disk.behavior.IDiskCacheAttributesIDiskCacheAttributes.DiskLimitType
- 
Field SummaryFields inherited from interface org.apache.commons.jcs3.auxiliary.disk.behavior.IDiskCacheAttributesMAX_PURGATORY_SIZE_DEFAULT
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionGets the diskPath attribute of the attributes objectintGets the maxKeySize attribute of the DiskCacheAttributes objectintGet the amount of time in seconds we will wait for elements to move to disk during shutdown for a particular region.booleanIf this is true then remove all is not prohibited.voidsetAllowRemoveAll(boolean allowRemoveAll) If this is false, then remove all requests will not be honored.voidsetDiskLimitType(IDiskCacheAttributes.DiskLimitType diskLimitType) set the type of the limit of the cache sizevoidsetDiskLimitTypeName(String diskLimitTypeName) Translates and stores String values of DiskLimitType Allowed values: "COUNT" and "SIZE"voidsetDiskPath(File diskPath) Sets the diskPath attribute of the DiskCacheAttributes objectvoidsetDiskPath(String path) Sets the diskPath attribute of the DiskCacheAttributes objectvoidsetMaxPurgatorySize(int maxPurgatorySize) Sets the maxPurgatorySize attribute of the DiskCacheAttributes objectvoidsetShutdownSpoolTimeLimit(int shutdownSpoolTimeLimit) Sets the amount of time in seconds we will wait for elements to move to disk during shutdown for a particular region.toString()Includes the common attributes for a debug message.Methods inherited from class org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheAttributesclone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setNameMethods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.jcs3.auxiliary.AuxiliaryCacheAttributesclone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
- 
Constructor Details- 
AbstractDiskCacheAttributespublic AbstractDiskCacheAttributes()
 
- 
- 
Method Details- 
setDiskPathSets the diskPath attribute of the DiskCacheAttributes object- Specified by:
- setDiskPathin interface- IDiskCacheAttributes
- Parameters:
- path- The new diskPath value
 
- 
setDiskPathSets the diskPath attribute of the DiskCacheAttributes object- Parameters:
- diskPath- The new diskPath value
 
- 
getDiskPathGets the diskPath attribute of the attributes object- Specified by:
- getDiskPathin interface- IDiskCacheAttributes
- Returns:
- The diskPath value
 
- 
getMaxPurgatorySizeGets the maxKeySize attribute of the DiskCacheAttributes object- Specified by:
- getMaxPurgatorySizein interface- IDiskCacheAttributes
- Returns:
- The maxPurgatorySize value
 
- 
setMaxPurgatorySizeSets the maxPurgatorySize attribute of the DiskCacheAttributes object- Specified by:
- setMaxPurgatorySizein interface- IDiskCacheAttributes
- Parameters:
- maxPurgatorySize- The new maxPurgatorySize value
 
- 
getShutdownSpoolTimeLimitGet the amount of time in seconds we will wait for elements to move to disk during shutdown for a particular region.- Specified by:
- getShutdownSpoolTimeLimitin interface- IDiskCacheAttributes
- Returns:
- the time in seconds.
 
- 
setShutdownSpoolTimeLimitSets 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:
- setShutdownSpoolTimeLimitin interface- IDiskCacheAttributes
- Parameters:
- shutdownSpoolTimeLimit- the time in seconds
 
- 
setAllowRemoveAllDescription copied from interface:IDiskCacheAttributesIf this is false, then remove all requests will not be honored.This provides a safety mechanism for the persistent store. - Specified by:
- setAllowRemoveAllin interface- IDiskCacheAttributes
- Parameters:
- allowRemoveAll- The allowRemoveAll to set.
 
- 
isAllowRemoveAllDescription copied from interface:IDiskCacheAttributesIf this is true then remove all is not prohibited.- Specified by:
- isAllowRemoveAllin interface- IDiskCacheAttributes
- Returns:
- Returns the allowRemoveAll.
 
- 
toStringIncludes the common attributes for a debug message.
- 
setDiskLimitTypeDescription copied from interface:IDiskCacheAttributesset the type of the limit of the cache size- Specified by:
- setDiskLimitTypein interface- IDiskCacheAttributes
- Parameters:
- diskLimitType- COUNT - limit by count of the elements, SIZE, limit by sum of element's size
 
- 
setDiskLimitTypeNameDescription copied from interface:IDiskCacheAttributesTranslates and stores String values of DiskLimitType Allowed values: "COUNT" and "SIZE"- Specified by:
- setDiskLimitTypeNamein interface- IDiskCacheAttributes
 
- 
getDiskLimitType- Specified by:
- getDiskLimitTypein interface- IDiskCacheAttributes
- Returns:
- active DiskLimitType
 
 
-