public class Cache
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
void |
clear()
This method clears everything from the cache,
so that it is just like when it was instantiated.
|
void |
clearDisk()
This method clears everything from the disk cache.
|
java.util.Collection |
getAllDependencyIds()
This method returns the dependency IDs for all cache entries in the memory cache.
|
java.util.Enumeration |
getAllIds()
This method returns the cache IDs for all cache entries from memory cache.
|
java.util.Collection |
getCacheIdsByDependency(java.lang.String dependency)
This method returns the cache IDs of the entries in the memory cache specified by the dependency ID.
|
java.util.Collection |
getCacheIdsByTemplate(java.lang.String template)
This method returns the cache IDs of the entries in the memory cache specified by the template.
|
CacheStatisticsListener |
getCacheStatisticsListener()
This method returns an instance of CacheStatisticsListener.
|
long |
getCleanupFrequency()
This method returns a value for the disk cache cleanup frequency, in minutes.
|
int |
getDefaultPriority()
This method returns the default priority value as set in the Administrator console GUI/dynacache.xml file.
|
boolean |
getDelayOffload()
This method returns a boolean to indicate whether the disk cache is using buffers for dependency
IDs and templates.
|
long |
getDelayOffloadDepIdBuckets()
This method returns a value for the maximum number of dependency identifier buckets in the disk cache
metadata in memory.
|
long |
getDelayOffloadEntriesLimit()
This method returns a value for the maximum number of cache identifiers that are stored for an
individual dependency ID or template in the disk cache metadata in memory.
|
long |
getDelayOffloadTemplateBuckets()
This method returns a value for the maximum number of template buckets in the disk cache
metadata in memory.
|
java.util.Collection |
getDepIdsByRangeDisk(int index,
int length)
This method returns the dependency IDs found in the disk cache based on specified the index and the length.
|
int |
getDepIdsSizeDisk()
This method returns the current number of dependency IDs in the disk cache.
|
java.util.Collection |
getDepIdValueDisk(java.lang.Object depId)
This method returns the cache IDs of the entries in the disk cache specified by the dependency ID.
|
long |
getDiskCacheEntrySizeInMBLimit()
This method returns the maximum size of an individual cache entry in megabytes (MB).
|
int |
getDiskCacheEvictionPolicy()
This method returns the eviction algorithm that the disk cache will use to evict entries
once the high threshold is reached.
|
int |
getDiskCacheHighThreshold()
This method returns the high threshold is expressed in terms of the percentage of the disk cache
size in GB or entries.
|
int |
getDiskCacheLowThreshold()
This method returns the low threshold is expressed in terms of the percentage of the disk cache
size in GB or entries.
|
int |
getDiskCachePerformanceLevel()
This method returns the performance level to tune the performance of the disk cache.
|
long |
getDiskCacheSizeInGBLimit()
This method returns the maximum number of disk cache size in gigabytes (GB).
|
float |
getDiskCacheSizeInMBs()
This method returns the current disk cache size in Megabytes (MB).
|
long |
getDiskCacheSizeLimit()
This method returns the maximum number of cache entries that are held in disk cache.
|
CacheEntry |
getEntry(java.lang.Object cacheId)
This method returns an instance of CacheEntry specified cache ID.
|
CacheEntry |
getEntryDisk(java.lang.Object cacheId)
This method returns the cache entry specified by cache ID from the disk cache.
|
boolean |
getFlushToDiskOnStop()
This method returns a boolean to indicate whether in-memory cached objects are saved to disk when the server stops.
|
java.util.Collection |
getIdsByRangeDisk(int index,
int length)
This method returns the cache IDs found in the disk cache based on specified the index and the length.
|
int |
getIdsSizeDisk()
This method returns the current number of cache entries in the disk cache.
|
int |
getMaxCacheSizeInMB()
This method returns the maximum space on the JVM heap that can be occupied by
the cache entries.
|
int |
getMaxNumberCacheEntries()
This method returns the maximum number of cache entries that are held in memory cache.
|
float |
getMemoryCacheSizeInMB()
This method returns the current space on the JVM heap that is occupied by
the cache entries.
|
int |
getNumberCacheEntries()
This method returns the current number of cache entries for this cache instance.
|
boolean |
getSwapToDisk()
This method determines the disk offloaded feature is enabled or not.
|
java.util.Collection |
getTemplatesByRangeDisk(int index,
int length)
This method returns the templates found in the disk cache based on specified the index and the length.
|
int |
getTemplatesSizeDisk()
This method returns the current number of templates in the disk cache.
|
java.util.Collection |
getTemplateValueDisk(java.lang.String template)
This method returns the cache IDs of the entries in the disk cache specified by the template.
|
void |
invalidateById(java.lang.String id,
boolean waitOnInvalidation)
This method invalidates in all caches all entries dependent on the specified
id.
|
void |
invalidateByTemplate(java.lang.String template,
boolean waitOnInvalidation)
This method invalidates in all caches all entries dependent on the specified
template.
|
void |
refreshEntry(CacheEntry ce)
This method moves the specified entry to the end of the LRU queue.
|
public Cache(Cache ci)
public void refreshEntry(CacheEntry ce)
ce
- The cache entrypublic boolean getSwapToDisk()
public CacheEntry getEntryDisk(java.lang.Object cacheId)
cacheId
- the cache IDpublic void clearDisk()
public java.util.Collection getIdsByRangeDisk(int index, int length)
index
- If index = 0, it starts the beginning. If index = 1, it means "next". If Index = -1, it means "previous".length
- The max number of cache IDs to be read. If length = -1, it reads all cache IDs until the end.public java.util.Collection getTemplatesByRangeDisk(int index, int length)
index
- If index = 0, it starts the beginning. If index = 1, it means "next". If Index = -1, it means "previous".length
- The max number of templates to be read. If length = -1, it reads all templates until the end.public CacheStatisticsListener getCacheStatisticsListener()
public CacheEntry getEntry(java.lang.Object cacheId)
cacheId
- the cache IDpublic void invalidateById(java.lang.String id, boolean waitOnInvalidation)
id
- The cache id or data id.waitOnInvalidation
- True indicates that this method should
not return until the invalidations have taken effect on all caches.
False indicates that the invalidations will be queued for later
batch processing.public void invalidateByTemplate(java.lang.String template, boolean waitOnInvalidation)
template
- The template name.waitOnInvalidation
- True indicates that this method should
not return until the invalidations have taken effect on all caches.
False indicates that the invalidations will be queued for later
batch processing.public void clear()
public java.util.Enumeration getAllIds()
public int getMaxNumberCacheEntries()
public int getNumberCacheEntries()
public int getMaxCacheSizeInMB()
public float getMemoryCacheSizeInMB()
public int getDefaultPriority()
public java.util.Collection getAllDependencyIds()
public java.util.Collection getCacheIdsByDependency(java.lang.String dependency)
dependency
- ID for the group of cache IDs.public java.util.Collection getCacheIdsByTemplate(java.lang.String template)
template
- for the group of cache IDs.public int getTemplatesSizeDisk()
public java.util.Collection getTemplateValueDisk(java.lang.String template)
template
- for the group of cache IDs.public int getIdsSizeDisk()
public int getDepIdsSizeDisk()
public java.util.Collection getDepIdsByRangeDisk(int index, int length)
index
- If index = 0, it starts the beginning. If index = 1, it means "next". If Index = -1, it means "previous".length
- The max number of dependency IDs to be read. If length = -1, it reads all dependency IDs until the end.public java.util.Collection getDepIdValueDisk(java.lang.Object depId)
depId
- for the group of cache IDs.public long getDiskCacheSizeLimit()
public long getDiskCacheSizeInGBLimit()
public long getDiskCacheEntrySizeInMBLimit()
public boolean getFlushToDiskOnStop()
public int getDiskCachePerformanceLevel()
public long getCleanupFrequency()
public boolean getDelayOffload()
public long getDelayOffloadEntriesLimit()
public long getDelayOffloadDepIdBuckets()
public long getDelayOffloadTemplateBuckets()
public int getDiskCacheEvictionPolicy()
public int getDiskCacheHighThreshold()
public int getDiskCacheLowThreshold()
public float getDiskCacheSizeInMBs()