Interface ICompositeCacheAttributes
- All Superinterfaces:
- Cloneable,- Serializable
- All Known Implementing Classes:
- CompositeCacheAttributes
This defines the minimal behavior for the Cache Configuration settings.
- 
Nested Class SummaryNested Classes
- 
Method SummaryModifier and TypeMethodDescriptionclone()Clone objectGets the cacheName attribute of the ICompositeCacheAttributes objectlongIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.intGets the maxObjects attribute of the ICompositeCacheAttributes objectintIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.Gets the memoryCacheName attribute of the ICompositeCacheAttributes objectlongIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.intNumber to send to disk at time when memory is full.booleanGets the useDisk attribute of the ICompositeCacheAttributes objectbooleanGets the useLateral attribute of the ICompositeCacheAttributes objectbooleanWhether the memory cache should perform background memory shrinkage.booleanreturns whether the cache is remote enabledvoidSets the name of the cache, referenced by the appropriate manager.voidsetDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePattern diskUsagePattern) By default this is SWAP_ONLY.voidsetDiskUsagePatternName(String diskUsagePatternName) Translates the name to the disk usage pattern short value.voidsetMaxMemoryIdleTimeSeconds(long seconds) If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.voidsetMaxObjects(int size) SetMaxObjects is used to set the attribute to determine the maximum number of objects allowed in the memory cache.voidsetMaxSpoolPerRun(int maxSpoolPerRun) If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.voidSets the name of the MemoryCache, referenced by the appropriate manager.voidsetShrinkerIntervalSeconds(long seconds) If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.voidsetSpoolChunkSize(int spoolChunkSize) Number to send to disk at a time.voidsetUseDisk(boolean useDisk) Sets the useDisk attribute of the ICompositeCacheAttributes objectvoidsetUseLateral(boolean d) set whether the cache should use a lateral cachevoidsetUseMemoryShrinker(boolean useShrinker) Whether the memory cache should perform background memory shrinkage.voidsetUseRemote(boolean isRemote) Sets whether the cache is remote enabled
- 
Method Details- 
setMaxObjectsSetMaxObjects is used to set the attribute to determine the maximum number of objects allowed in the memory cache. If the max number of objects or the cache size is set, the default for the one not set is ignored. If both are set, both are used to determine the capacity of the cache, i.e., object will be removed from the cache if either limit is reached. TODO: move to MemoryCache config file.- Parameters:
- size- The new maxObjects value
 
- 
getMaxObjectsint getMaxObjects()Gets the maxObjects attribute of the ICompositeCacheAttributes object- Returns:
- The maxObjects value
 
- 
setUseDiskSets the useDisk attribute of the ICompositeCacheAttributes object- Parameters:
- useDisk- The new useDisk value
 
- 
isUseDiskboolean isUseDisk()Gets the useDisk attribute of the ICompositeCacheAttributes object- Returns:
- The useDisk value
 
- 
setUseLateralset whether the cache should use a lateral cache- Parameters:
- d- The new useLateral value
 
- 
isUseLateralboolean isUseLateral()Gets the useLateral attribute of the ICompositeCacheAttributes object- Returns:
- The useLateral value
 
- 
setUseRemoteSets whether the cache is remote enabled- Parameters:
- isRemote- The new useRemote value
 
- 
isUseRemoteboolean isUseRemote()returns whether the cache is remote enabled- Returns:
- The useRemote value
 
- 
setCacheNameSets the name of the cache, referenced by the appropriate manager.- Parameters:
- s- The new cacheName value
 
- 
getCacheNameGets the cacheName attribute of the ICompositeCacheAttributes object- Returns:
- The cacheName value
 
- 
setMemoryCacheNameSets the name of the MemoryCache, referenced by the appropriate manager. TODO: create a separate memory cache attribute class.- Parameters:
- s- The new memoryCacheName value
 
- 
getMemoryCacheNameGets the memoryCacheName attribute of the ICompositeCacheAttributes object- Returns:
- The memoryCacheName value
 
- 
setUseMemoryShrinkerWhether the memory cache should perform background memory shrinkage.- Parameters:
- useShrinker- The new UseMemoryShrinker value
 
- 
isUseMemoryShrinkerboolean isUseMemoryShrinker()Whether the memory cache should perform background memory shrinkage.- Returns:
- The UseMemoryShrinker value
 
- 
setMaxMemoryIdleTimeSecondsIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.- Parameters:
- seconds- The new MaxMemoryIdleTimeSeconds value
 
- 
getMaxMemoryIdleTimeSecondslong getMaxMemoryIdleTimeSeconds()If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.- Returns:
- The MaxMemoryIdleTimeSeconds value
 
- 
setShrinkerIntervalSecondsIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This sets the shrinker interval.- Parameters:
- seconds- The new ShrinkerIntervalSeconds value
 
- 
getShrinkerIntervalSecondslong getShrinkerIntervalSeconds()If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This gets the shrinker interval.- Returns:
- The ShrinkerIntervalSeconds value
 
- 
setMaxSpoolPerRunIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This sets the maximum number of items to spool per run.- Parameters:
- maxSpoolPerRun- The new maxSpoolPerRun value
 
- 
getMaxSpoolPerRunint getMaxSpoolPerRun()If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This gets the maximum number of items to spool per run.- Returns:
- The maxSpoolPerRun value
 
- 
setDiskUsagePatternBy default this is SWAP_ONLY.- Parameters:
- diskUsagePattern- The diskUsagePattern to set.
 
- 
setDiskUsagePatternNameTranslates the name to the disk usage pattern short value.The allowed values are SWAP and UPDATE. - Parameters:
- diskUsagePatternName- The diskUsagePattern to set.
 
- 
getDiskUsagePattern- Returns:
- Returns the diskUsagePattern.
 
- 
getSpoolChunkSizeint getSpoolChunkSize()Number to send to disk at time when memory is full.- Returns:
- int
 
- 
setSpoolChunkSizeNumber to send to disk at a time.- Parameters:
- spoolChunkSize-
 
- 
cloneClone object
 
-