ehcache

net.sf.ehcache.management.sampled
Interface CacheSampler

All Superinterfaces:
LegacyCacheStatistics
All Known Subinterfaces:
SampledCacheMBean
All Known Implementing Classes:
CacheSamplerImpl, SampledCache

public interface CacheSampler
extends LegacyCacheStatistics

An interface for exposing cache statistics. Extends from both LiveCacheStatistics and LegacyCacheStatistics

Author:
Abhishek Sanoujam, byoukste

Method Summary
 void flush()
          Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
 long getAverageGetTime()
          Gets the average get time.
 SampledRateCounter getAverageGetTimeSample()
          Get the SampledRateCounter for average time taken for get() operation in the cache.
 long getAverageSearchTime()
          Gets the average search time.
 SampledRateCounter getAverageSearchTimeSample()
          Get the SampledRateCounter for average search execution time for searches finishing within the last sample period.
 SampledCounter getCacheClusterOfflineSample()
          Get the SampledCounter for offline cache cluster events.
 SampledCounter getCacheClusterOnlineSample()
          Get the SampledCounter for online cache cluster events.
 SampledCounter getCacheClusterRejoinSample()
          Get the SampledCounter for rejoin cache cluster events.
 SampledCounter getCacheElementEvictedSample()
          Get the SampledCounter element evicted from cache.
 SampledCounter getCacheElementExpiredSample()
          Get the SampledCounter element expired from cache.
 SampledCounter getCacheElementPutSample()
          Get the SampledCounter element puts in the cache.
 SampledCounter getCacheElementRemovedSample()
          Get the SampledCounter element removed from cache.
 SampledCounter getCacheElementUpdatedSample()
          Get the SampledCounter element updates , i.e.
 long getCacheEvictionRate()
          Gets the cache eviction rate.
 long getCacheExpirationRate()
          Gets the cache expiration rate.
 SampledCounter getCacheHitInMemorySample()
          Get the SampledCounter for in-memory cache hit.
 SampledCounter getCacheHitOffHeapSample()
          Get the SampledCounter for off-heap cache hit.
 SampledCounter getCacheHitOnDiskSample()
          Get the SampledCounter for on-disk cache hit.
 long getCacheHitRate()
          Gets the cache hit rate.
 SampledCounter getCacheHitRatioSample()
          Get the SampledCounter for cache hit ratio.
 SampledCounter getCacheHitSample()
          Get the SampledCounter for cache hit.
 long getCacheInMemoryHitRate()
          Gets the cache in memory hit rate.
 long getCacheInMemoryMissRate()
          Gets the cache in memory miss rate.
 SampledCounter getCacheMissExpiredSample()
          Get the SampledCounter for cache miss as result of the element getting expired.
 SampledCounter getCacheMissInMemorySample()
          Get the SampledCounter for in-memory cache miss.
 SampledCounter getCacheMissNotFoundSample()
          Get the SampledCounter for cache miss as result of the element not found in cache.
 SampledCounter getCacheMissOffHeapSample()
          Get the SampledCounter for off-heap cache miss.
 SampledCounter getCacheMissOnDiskSample()
          Get the SampledCounter for on-disk cache miss.
 long getCacheMissRate()
          Gets the cache miss rate.
 SampledCounter getCacheMissSample()
          Get the SampledCounter for cache miss.
 long getCacheOffHeapHitRate()
          Gets the cache off heap hit rate.
 long getCacheOffHeapMissRate()
          Gets the cache off heap miss rate.
 long getCacheOnDiskHitRate()
          Gets the cache on disk hit rate.
 long getCacheOnDiskMissRate()
          Gets the cache on disk miss rate.
 long getCachePutRate()
          Gets the cache put rate.
 long getCacheRemoveRate()
          Gets the cache remove rate.
 long getCacheSearchRate()
          Gets the cache search rate.
 long getCacheUpdateRate()
          Gets the cache update rate.
 SampledCounter getCacheXaCommitsSample()
          Get the SampledCounter for number of XA Transaction commits that have completed in the interval.
 SampledCounter getCacheXaRollbacksSample()
          Get the SampledCounter for number of XA Transaction rollbacks that have completed in the interval.
 long getDiskExpiryThreadIntervalSeconds()
          Configuration property accessor
 boolean getHasWriteBehindWriter()
          Is there a registered Write-behind CacheWriter.
 SampledCounter getLocalDiskSizeInBytesSample()
          Get the SampledCounter for local disk size in bytes.
 SampledCounter getLocalDiskSizeSample()
          Get the SampledCounter for local disk size.
 SampledCounter getLocalHeapSizeInBytesSample()
          Get the SampledCounter for local heap size in bytes.
 SampledCounter getLocalHeapSizeSample()
          Get the SampledCounter for local heap size.
 SampledCounter getLocalOffHeapSizeInBytesSample()
          Get the SampledCounter for local offheap size in bytes.
 SampledCounter getLocalOffHeapSizeSample()
          Get the SampledCounter for local offheap size.
 long getMaxBytesLocalDisk()
          Configuration property accessor.
 String getMaxBytesLocalDiskAsString()
          Configuration property accessor.
 long getMaxBytesLocalHeap()
          Configuration property accessor.
 String getMaxBytesLocalHeapAsString()
          Configuration property accessor.
 long getMaxBytesLocalOffHeap()
          Configuration property accessor.
 String getMaxBytesLocalOffHeapAsString()
          Configuration property accessor.
 int getMaxElementsOnDisk()
          Configuration property accessor.
 long getMaxEntriesInCache()
          Configuration property accessor.
 long getMaxEntriesLocalDisk()
          Configuration property accessor.
 long getMaxEntriesLocalHeap()
          Configuration property accessor.
 String getMemoryStoreEvictionPolicy()
          Configuration property accessor.
 long getMostRecentRejoinTimeStampMillis()
          Get the timestamp in nanos of the last rejoin.
 SampledCounter getMostRecentRejoinTimestampMillisSample()
          Get the SampledCounter for last rejoin timestamp.
 long getNonStopFailureRate()
          Gets the non stop failure most recent sample.
 SampledCounter getNonStopFailureSample()
          Gets the nonstop failure sample.
 long getNonStopRejoinTimeoutRate()
          Gets the non stop rejoin most recent sample.
 SampledCounter getNonStopRejoinTimeoutSample()
          Gets the nonstop rejoin sample.
 long getNonStopSuccessRate()
          Gets the non stop success most recent sample.
 SampledCounter getNonStopSuccessSample()
          Gets the nonstop success sample.
 long getNonStopTimeoutRate()
          Gets the non stop timeout most recent sample.
 SampledCounter getNonStopTimeoutSample()
          Gets the nonstop timeout sample.
 String getPersistenceStrategy()
          getPersistenceStrategy
 String getPinnedToStore()
          Configuration property accessor.
 SampledCounter getPutIfAbsentMissSample()
          Gets the putIfAbsent miss sample
 SampledCounter getPutIfAbsentSuccessSample()
          Gets the putIfAbsent success sample
 SampledCounter getRemoteSizeSample()
          Get the SampledCounter for remote size.
 SampledCounter getRemoveElementMissSample()
          Gets the removeElement miss sample
 SampledCounter getRemoveElementSuccessSample()
          Gets the removeElement success sample
 SampledCounter getReplaceOneArgMissSample()
          Gets the one arg replace miss sample
 SampledCounter getReplaceOneArgSuccessSample()
          Gets the one arg replace success sample
 SampledCounter getReplaceTwoArgMissSample()
          Gets the two arg replace miss sample
 SampledCounter getReplaceTwoArgSuccessSample()
          Gets the two arg replace success sample
 boolean getSearchable()
          Is the cache configured for search.
 Map<String,String> getSearchAttributes()
          Get the declared search attributes and their type names.
 SampledCounter getSearchesPerSecondSample()
          Get the SampledCounter for number of searches that have finished in the interval.
 SampledCounter getSizeSample()
          Get the SampledCounter for cache size.
 String getStatus()
          Gets the status attribute of the Cache.
 String getTerracottaConsistency()
          Returns a textual description of a Terracotta-clustered cache's consistency mode.
 long getTimeToIdleSeconds()
          Configuration property accessor.
 long getTimeToLiveSeconds()
          Configuration property accessor.
 boolean getTransactional()
          Is the cache a transactional one.
 long getTransactionCommitRate()
          Gets the transaction commit rate.
 long getTransactionRollbackRate()
          Gets the transaction rollback rate.
 int getWriterConcurrency()
          Returns the number of configured write-behind queues/threads.
 int getWriterMaxQueueSize()
          Returns the maximum size of any write-behind queues.
 long getWriterQueueLength()
          Returns the total length of all write-behind queues for this cache.
 SampledCounter getWriterQueueLengthSample()
          Get the SampledCounter for writer queue length.
 boolean isClusterBulkLoadEnabled()
          Is the cache in bulk-load mode cluster-wide?.
 boolean isDiskPersistent()
          Configuration property accessor.
 boolean isEnabled()
          Is the cache enabled?.
 boolean isEternal()
          Configuration property accessor.
 boolean isLoggingEnabled()
          Configuration property accessor.
 boolean isNodeBulkLoadEnabled()
          Is the cache in bulk-load mode locally?.
 boolean isOverflowToDisk()
          Configuration property accessor.
 boolean isOverflowToOffHeap()
          isOverflowToOffHeap
 boolean isPinned()
          Configuration property accessor.
 boolean isTerracottaClustered()
          Is the cache configured with Terracotta clustering?.
 void removeAll()
          Removes all cached items.
 void setDiskExpiryThreadIntervalSeconds(long seconds)
          setDiskExpiryThreadIntervalSeconds.
 void setDiskPersistent(boolean diskPersistent)
          setDiskPersistent.
 void setEnabled(boolean enabled)
          Enabled/disable the cache.
 void setEternal(boolean eternal)
          setEternal.
 void setLoggingEnabled(boolean enabled)
          setLoggingEnabled.
 void setMaxBytesLocalDisk(long maxBytes)
          setMaxBytesLocalDisk.
 void setMaxBytesLocalDiskAsString(String maxBytes)
          setMaxBytesLocalDisk.
 void setMaxBytesLocalHeap(long maxBytes)
          setMaxBytesLocalHeap.
 void setMaxBytesLocalHeapAsString(String maxBytes)
          setMaxBytesLocalHeap.
 void setMaxElementsOnDisk(int maxElements)
          setMaxElementsOnDisk.
 void setMaxEntriesInCache(long maxEntries)
          setMaxEntriesInCache.
 void setMaxEntriesLocalDisk(long maxEntries)
          setMaxEntriesLocalDisk.
 void setMaxEntriesLocalHeap(long maxEntries)
          setMaxEntriesLocalHeap.
 void setMemoryStoreEvictionPolicy(String evictionPolicy)
          setMemoryStoreEvictionPolicy.
 void setNodeBulkLoadEnabled(boolean bulkLoadEnabled)
          Enabled/disable bulk-load mode for this node.
 void setOverflowToDisk(boolean overflowToDisk)
          setOverflowToDisk.
 void setTimeToIdleSeconds(long tti)
          setTimeToIdleSeconds.
 void setTimeToLiveSeconds(long ttl)
          setTimeToLiveSeconds.
 
Methods inherited from interface net.sf.ehcache.management.sampled.LegacyCacheStatistics
dispose, getAverageGetTimeNanos, getAverageGetTimeNanosMostRecentSample, getAverageSearchTimeNanos, getCacheClusterOfflineCount, getCacheClusterOfflineMostRecentSample, getCacheClusterOnlineCount, getCacheClusterOnlineMostRecentSample, getCacheClusterRejoinCount, getCacheClusterRejoinMostRecentSample, getCacheElementEvictedMostRecentSample, getCacheElementExpiredMostRecentSample, getCacheElementPutMostRecentSample, getCacheElementRemovedMostRecentSample, getCacheElementUpdatedMostRecentSample, getCacheHitCount, getCacheHitInMemoryMostRecentSample, getCacheHitMostRecentSample, getCacheHitOffHeapMostRecentSample, getCacheHitOnDiskMostRecentSample, getCacheHitRatio, getCacheHitRatioMostRecentSample, getCacheMissCount, getCacheMissCountExpired, getCacheMissExpiredMostRecentSample, getCacheMissInMemoryMostRecentSample, getCacheMissMostRecentSample, getCacheMissNotFoundMostRecentSample, getCacheMissOffHeapMostRecentSample, getCacheMissOnDiskMostRecentSample, getCacheName, getCacheXaCommitsMostRecentSample, getCacheXaRollbacksMostRecentSample, getEvictedCount, getExpiredCount, getInMemoryHitCount, getInMemoryMissCount, getInMemorySize, getLocalDiskSize, getLocalDiskSizeInBytes, getLocalHeapSize, getLocalHeapSizeInBytes, getLocalOffHeapSize, getLocalOffHeapSizeInBytes, getMaxGetTimeNanos, getMinGetTimeNanos, getNonStopFailureCount, getNonStopFailureMostRecentSample, getNonStopRejoinTimeoutCount, getNonStopRejoinTimeoutMostRecentSample, getNonStopSuccessCount, getNonStopSuccessMostRecentSample, getNonStopTimeoutCount, getNonStopTimeoutMostRecentSample, getNonstopTimeoutRatio, getOffHeapHitCount, getOffHeapMissCount, getOffHeapSize, getOnDiskHitCount, getOnDiskMissCount, getOnDiskSize, getPutCount, getPutIfAbsentMissCount, getPutIfAbsentMissRate, getPutIfAbsentSuccessCount, getPutIfAbsentSuccessRate, getRemovedCount, getRemoveElementMissCount, getRemoveElementMissRate, getRemoveElementSuccessCount, getRemoveElementSuccessRate, getReplaceOneArgMissCount, getReplaceOneArgMissRate, getReplaceOneArgSuccessCount, getReplaceOneArgSuccessRate, getReplaceTwoArgMissCount, getReplaceTwoArgMissRate, getReplaceTwoArgSuccessCount, getReplaceTwoArgSuccessRate, getSearchesPerSecond, getSize, getUpdateCount, getXaCommitCount, getXaRecoveredCount, getXaRollbackCount, isLocalHeapCountBased
 

Method Detail

isEnabled

boolean isEnabled()
Is the cache enabled?.

Returns:
true, if is enabled

setNodeBulkLoadEnabled

void setNodeBulkLoadEnabled(boolean bulkLoadEnabled)
Enabled/disable bulk-load mode for this node.

Parameters:
bulkLoadEnabled - the new node bulk load enabled

isClusterBulkLoadEnabled

boolean isClusterBulkLoadEnabled()
Is the cache in bulk-load mode cluster-wide?.

Returns:
true, if is cluster bulk load enabled

isNodeBulkLoadEnabled

boolean isNodeBulkLoadEnabled()
Is the cache in bulk-load mode locally?.

Returns:
true, if is node bulk load enabled

setEnabled

void setEnabled(boolean enabled)
Enabled/disable the cache.

Parameters:
enabled - the new enabled

removeAll

void removeAll()
Removes all cached items.


flush

void flush()
Flushes all cache items from memory to the disk store, and from the DiskStore to disk.


getStatus

String getStatus()
Gets the status attribute of the Cache.

Returns:
The status value from the Status enum class

isTerracottaClustered

boolean isTerracottaClustered()
Is the cache configured with Terracotta clustering?.

Returns:
true if clustered with terracotta

getTerracottaConsistency

String getTerracottaConsistency()
Returns a textual description of a Terracotta-clustered cache's consistency mode.

Returns:
"STRONG", "EVENTUAL", or "na" if the cache is not Terracotta-clustered

getMaxEntriesLocalHeap

long getMaxEntriesLocalHeap()
Configuration property accessor.

Returns:
Max entries local heap config setting value

setMaxEntriesLocalHeap

void setMaxEntriesLocalHeap(long maxEntries)
setMaxEntriesLocalHeap.

Parameters:
maxEntries - the new max entries local heap

getMaxBytesLocalHeap

long getMaxBytesLocalHeap()
Configuration property accessor.

Returns:
Max bytes local heap config setting value

setMaxBytesLocalHeap

void setMaxBytesLocalHeap(long maxBytes)
setMaxBytesLocalHeap.

Parameters:
maxBytes - the new max bytes local heap

setMaxBytesLocalHeapAsString

void setMaxBytesLocalHeapAsString(String maxBytes)
setMaxBytesLocalHeap.

Parameters:
maxBytes - the new max bytes local heap as string

getMaxBytesLocalHeapAsString

String getMaxBytesLocalHeapAsString()
Configuration property accessor.

Returns:
Max bytes local heap config setting value as string

getMaxBytesLocalOffHeap

long getMaxBytesLocalOffHeap()
Configuration property accessor.

Returns:
Max bytes local offheap config setting value

getMaxBytesLocalOffHeapAsString

String getMaxBytesLocalOffHeapAsString()
Configuration property accessor.

Returns:
Max bytes local offheap config setting value as string

getMaxEntriesLocalDisk

long getMaxEntriesLocalDisk()
Configuration property accessor.

Returns:
Max entries local disk config setting value

setMaxEntriesLocalDisk

void setMaxEntriesLocalDisk(long maxEntries)
setMaxEntriesLocalDisk.

Parameters:
maxEntries - the new max entries local disk

getMaxElementsOnDisk

int getMaxElementsOnDisk()
Configuration property accessor.

Returns:
Max elements on disk config setting value

getMaxEntriesInCache

long getMaxEntriesInCache()
Configuration property accessor.

Returns:
Max entries in cache config setting value

setMaxElementsOnDisk

void setMaxElementsOnDisk(int maxElements)
setMaxElementsOnDisk.

Parameters:
maxElements - the new max elements on disk

setMaxEntriesInCache

void setMaxEntriesInCache(long maxEntries)
setMaxEntriesInCache.

Parameters:
maxEntries - the new max entries in cache

getMaxBytesLocalDisk

long getMaxBytesLocalDisk()
Configuration property accessor.

Returns:
Max bytes local disk config setting value

setMaxBytesLocalDisk

void setMaxBytesLocalDisk(long maxBytes)
setMaxBytesLocalDisk.

Parameters:
maxBytes - the new max bytes local disk

setMaxBytesLocalDiskAsString

void setMaxBytesLocalDiskAsString(String maxBytes)
setMaxBytesLocalDisk.

Parameters:
maxBytes - the new max bytes local disk as string

getMaxBytesLocalDiskAsString

String getMaxBytesLocalDiskAsString()
Configuration property accessor.

Returns:
Max bytes local disk config setting value as string

getMemoryStoreEvictionPolicy

String getMemoryStoreEvictionPolicy()
Configuration property accessor.

Returns:
a String representation of the policy

setMemoryStoreEvictionPolicy

void setMemoryStoreEvictionPolicy(String evictionPolicy)
setMemoryStoreEvictionPolicy.

Parameters:
evictionPolicy - the new memory store eviction policy

isEternal

boolean isEternal()
Configuration property accessor.

Returns:
true if set to eternal in config

setEternal

void setEternal(boolean eternal)
setEternal.

Parameters:
eternal - the new eternal

getTimeToIdleSeconds

long getTimeToIdleSeconds()
Configuration property accessor.

Returns:
TTI in config

setTimeToIdleSeconds

void setTimeToIdleSeconds(long tti)
setTimeToIdleSeconds.

Parameters:
tti - the new time to idle seconds

getTimeToLiveSeconds

long getTimeToLiveSeconds()
Configuration property accessor.

Returns:
TTL in config

setTimeToLiveSeconds

void setTimeToLiveSeconds(long ttl)
setTimeToLiveSeconds.

Parameters:
ttl - the new time to live seconds

isOverflowToDisk

boolean isOverflowToDisk()
Configuration property accessor.

Returns:
true if overflow to disk specified in config

setOverflowToDisk

void setOverflowToDisk(boolean overflowToDisk)
setOverflowToDisk.

Parameters:
overflowToDisk - the new overflow to disk

isDiskPersistent

boolean isDiskPersistent()
Configuration property accessor.

Returns:
true if configured with disk persistence

setDiskPersistent

void setDiskPersistent(boolean diskPersistent)
setDiskPersistent.

Parameters:
diskPersistent - the new disk persistent

isOverflowToOffHeap

boolean isOverflowToOffHeap()
isOverflowToOffHeap

Returns:
true if configured for offheap

getPersistenceStrategy

String getPersistenceStrategy()
getPersistenceStrategy

Returns:
the strategy name
See Also:
PersistenceConfiguration

getDiskExpiryThreadIntervalSeconds

long getDiskExpiryThreadIntervalSeconds()
Configuration property accessor

Returns:
Value for disk expiry thread interval in seconds specified in config

setDiskExpiryThreadIntervalSeconds

void setDiskExpiryThreadIntervalSeconds(long seconds)
setDiskExpiryThreadIntervalSeconds.

Parameters:
seconds - the new disk expiry thread interval seconds

isLoggingEnabled

boolean isLoggingEnabled()
Configuration property accessor.

Returns:
true if logging is enabled on the cache

setLoggingEnabled

void setLoggingEnabled(boolean enabled)
setLoggingEnabled.

Parameters:
enabled - the new logging enabled

isPinned

boolean isPinned()
Configuration property accessor.

Returns:
true if the cache is pinned
See Also:
PinningConfiguration

getPinnedToStore

String getPinnedToStore()
Configuration property accessor.

Returns:
the store to which this cache is pinned
See Also:
PinningConfiguration

getHasWriteBehindWriter

boolean getHasWriteBehindWriter()
Is there a registered Write-behind CacheWriter.

Returns:
the checks for write behind writer

getWriterQueueLength

long getWriterQueueLength()
Returns the total length of all write-behind queues for this cache.

Specified by:
getWriterQueueLength in interface LegacyCacheStatistics
Returns:
writer-behind queue length

getMostRecentRejoinTimeStampMillis

long getMostRecentRejoinTimeStampMillis()
Get the timestamp in nanos of the last rejoin.

Returns:
the most recent rejoin time stamp millis

getWriterMaxQueueSize

int getWriterMaxQueueSize()
Returns the maximum size of any write-behind queues.

Returns:
Maximum elements that can be queued for processing by the write-behind writer
See Also:
CacheWriterConfiguration.getWriteBehindMaxQueueSize()

getWriterConcurrency

int getWriterConcurrency()
Returns the number of configured write-behind queues/threads.

Returns:
Number of configured processing queues/threads for use by the write-behind writer
See Also:
CacheWriterConfiguration.getWriteBehindConcurrency()

getTransactional

boolean getTransactional()
Is the cache a transactional one.

Returns:
the transactional
See Also:
CacheConfiguration.TransactionalMode

getTransactionCommitRate

long getTransactionCommitRate()
Gets the transaction commit rate.

Returns:
Xa commit rate

getTransactionRollbackRate

long getTransactionRollbackRate()
Gets the transaction rollback rate.

Returns:
Xa rollback rate

getSearchable

boolean getSearchable()
Is the cache configured for search.

Returns:
the searchable
See Also:
Searchable

getSearchAttributes

Map<String,String> getSearchAttributes()
Get the declared search attributes and their type names. Note: doesn't deal with DynamicAttributeExctractor.

Returns:
map of search attribute name -> type name

getCacheSearchRate

long getCacheSearchRate()
Gets the cache search rate.

Returns:
search rate

getAverageSearchTime

long getAverageSearchTime()
Gets the average search time.

Returns:
search time

getCacheHitRate

long getCacheHitRate()
Gets the cache hit rate.

Returns:
hit rate

getCacheInMemoryHitRate

long getCacheInMemoryHitRate()
Gets the cache in memory hit rate.

Returns:
in-memory hit rate

getCacheOffHeapHitRate

long getCacheOffHeapHitRate()
Gets the cache off heap hit rate.

Returns:
off-heap hit rate

getCacheOnDiskHitRate

long getCacheOnDiskHitRate()
Gets the cache on disk hit rate.

Returns:
on-disk hit rate

getCacheMissRate

long getCacheMissRate()
Gets the cache miss rate.

Returns:
miss rate

getCacheInMemoryMissRate

long getCacheInMemoryMissRate()
Gets the cache in memory miss rate.

Returns:
in-memory miss rate

getCacheOffHeapMissRate

long getCacheOffHeapMissRate()
Gets the cache off heap miss rate.

Returns:
off-heap miss rate

getCacheOnDiskMissRate

long getCacheOnDiskMissRate()
Gets the cache on disk miss rate.

Returns:
on-disk miss rate

getCachePutRate

long getCachePutRate()
Gets the cache put rate.

Returns:
put rate

getCacheUpdateRate

long getCacheUpdateRate()
Gets the cache update rate.

Returns:
update rate

getCacheRemoveRate

long getCacheRemoveRate()
Gets the cache remove rate.

Returns:
remove rate

getCacheEvictionRate

long getCacheEvictionRate()
Gets the cache eviction rate.

Returns:
eviction rate

getCacheExpirationRate

long getCacheExpirationRate()
Gets the cache expiration rate.

Returns:
expiration rate

getAverageGetTime

long getAverageGetTime()
Gets the average get time.

Returns:
average get time (nanos.)

getCacheHitSample

SampledCounter getCacheHitSample()
Get the SampledCounter for cache hit.

Returns:
the SampledCounter for cache hit count

getCacheHitRatioSample

SampledCounter getCacheHitRatioSample()
Get the SampledCounter for cache hit ratio.

Returns:
the SampledCounter for cache hit ratio

getCacheHitInMemorySample

SampledCounter getCacheHitInMemorySample()
Get the SampledCounter for in-memory cache hit.

Returns:
the SampledCounter for cache hit count in memory

getCacheHitOffHeapSample

SampledCounter getCacheHitOffHeapSample()
Get the SampledCounter for off-heap cache hit.

Returns:
the SampledCounter for cache hit count in off-heap

getCacheHitOnDiskSample

SampledCounter getCacheHitOnDiskSample()
Get the SampledCounter for on-disk cache hit.

Returns:
the SampledCounter for cache hit count on disk

getCacheMissSample

SampledCounter getCacheMissSample()
Get the SampledCounter for cache miss.

Returns:
the SampledCounter for cache miss count

getCacheMissInMemorySample

SampledCounter getCacheMissInMemorySample()
Get the SampledCounter for in-memory cache miss.

Returns:
the SampledCounter for cache miss count in memory

getCacheMissOffHeapSample

SampledCounter getCacheMissOffHeapSample()
Get the SampledCounter for off-heap cache miss.

Returns:
the SampledCounter for cache miss count in off-heap

getCacheMissOnDiskSample

SampledCounter getCacheMissOnDiskSample()
Get the SampledCounter for on-disk cache miss.

Returns:
the SampledCounter for cache miss count on disk

getCacheMissExpiredSample

SampledCounter getCacheMissExpiredSample()
Get the SampledCounter for cache miss as result of the element getting expired.

Returns:
the SampledCounter for cache miss count and the reason for miss being the element got expired

getCacheMissNotFoundSample

SampledCounter getCacheMissNotFoundSample()
Get the SampledCounter for cache miss as result of the element not found in cache.

Returns:
the SampledCounter for cache miss not found count

getCacheElementEvictedSample

SampledCounter getCacheElementEvictedSample()
Get the SampledCounter element evicted from cache.

Returns:
the SampledCounter for element evicted count

getCacheElementRemovedSample

SampledCounter getCacheElementRemovedSample()
Get the SampledCounter element removed from cache.

Returns:
the SampledCounter for element removed count

getCacheElementExpiredSample

SampledCounter getCacheElementExpiredSample()
Get the SampledCounter element expired from cache.

Returns:
Most recent value for element expired count

getCacheElementPutSample

SampledCounter getCacheElementPutSample()
Get the SampledCounter element puts in the cache.

Returns:
the SampledCounter for number of element puts

getCacheElementUpdatedSample

SampledCounter getCacheElementUpdatedSample()
Get the SampledCounter element updates , i.e. put() on elements with already existing keys in the cache

Returns:
the SampledCounterd value for element update count

getAverageGetTimeSample

SampledRateCounter getAverageGetTimeSample()
Get the SampledRateCounter for average time taken for get() operation in the cache.

Returns:
the SampledRateCounter of average get time taken for a get operation

getAverageSearchTimeSample

SampledRateCounter getAverageSearchTimeSample()
Get the SampledRateCounter for average search execution time for searches finishing within the last sample period.

Returns:
the SampledRateCounter of average search time taken

getSearchesPerSecondSample

SampledCounter getSearchesPerSecondSample()
Get the SampledCounter for number of searches that have finished in the interval.

Returns:
the SampledCounter for number of searches

getCacheXaCommitsSample

SampledCounter getCacheXaCommitsSample()
Get the SampledCounter for number of XA Transaction commits that have completed in the interval.

Returns:
the SampledCounter for number XA Transaction commits

getCacheXaRollbacksSample

SampledCounter getCacheXaRollbacksSample()
Get the SampledCounter for number of XA Transaction rollbacks that have completed in the interval.

Returns:
the SampledCounter for number XA Transaction rollbacks

getSizeSample

SampledCounter getSizeSample()
Get the SampledCounter for cache size.

Returns:
the SampledCounter for cache size

getLocalHeapSizeSample

SampledCounter getLocalHeapSizeSample()
Get the SampledCounter for local heap size.

Returns:
the SampledCounter for local heap size

getLocalHeapSizeInBytesSample

SampledCounter getLocalHeapSizeInBytesSample()
Get the SampledCounter for local heap size in bytes.

Returns:
the SampledCounter for local heap size in bytes

getLocalOffHeapSizeSample

SampledCounter getLocalOffHeapSizeSample()
Get the SampledCounter for local offheap size.

Returns:
the SampledCounter for local offheap size

getLocalOffHeapSizeInBytesSample

SampledCounter getLocalOffHeapSizeInBytesSample()
Get the SampledCounter for local offheap size in bytes.

Returns:
the SampledCounter for local offheap size in bytes

getLocalDiskSizeSample

SampledCounter getLocalDiskSizeSample()
Get the SampledCounter for local disk size.

Returns:
the SampledCounter for local disk size

getLocalDiskSizeInBytesSample

SampledCounter getLocalDiskSizeInBytesSample()
Get the SampledCounter for local disk size in bytes.

Returns:
the SampledCounter for local disk size in bytes

getRemoteSizeSample

SampledCounter getRemoteSizeSample()
Get the SampledCounter for remote size.

Returns:
the SampledCounter for remote size

getWriterQueueLengthSample

SampledCounter getWriterQueueLengthSample()
Get the SampledCounter for writer queue length.

Returns:
the SampledCounter for writer queue length

getMostRecentRejoinTimestampMillisSample

SampledCounter getMostRecentRejoinTimestampMillisSample()
Get the SampledCounter for last rejoin timestamp.

Returns:
the SampledCounter for last rejoin timestamp

getCacheClusterOfflineSample

SampledCounter getCacheClusterOfflineSample()
Get the SampledCounter for offline cache cluster events.

Returns:
the SampledCounter for offline cache cluster events

getCacheClusterOnlineSample

SampledCounter getCacheClusterOnlineSample()
Get the SampledCounter for online cache cluster events.

Returns:
the SampledCounter for online cache cluster events

getCacheClusterRejoinSample

SampledCounter getCacheClusterRejoinSample()
Get the SampledCounter for rejoin cache cluster events.

Returns:
the SampledCounter for rejoin cache cluster events

getNonStopSuccessSample

SampledCounter getNonStopSuccessSample()
Gets the nonstop success sample.

Returns:
the nonstop success sample

getNonStopFailureSample

SampledCounter getNonStopFailureSample()
Gets the nonstop failure sample.

Returns:
the nonstop failure sample

getNonStopRejoinTimeoutSample

SampledCounter getNonStopRejoinTimeoutSample()
Gets the nonstop rejoin sample.

Returns:
the nonstop rejoin sample

getNonStopTimeoutSample

SampledCounter getNonStopTimeoutSample()
Gets the nonstop timeout sample.

Returns:
the nonstop timeout sample

getNonStopSuccessRate

long getNonStopSuccessRate()
Gets the non stop success most recent sample.

Returns:
the non stop success most recent sample

getNonStopFailureRate

long getNonStopFailureRate()
Gets the non stop failure most recent sample.

Returns:
the non stop failure most recent sample

getNonStopRejoinTimeoutRate

long getNonStopRejoinTimeoutRate()
Gets the non stop rejoin most recent sample.

Returns:
the non stop rejoin most recent sample

getNonStopTimeoutRate

long getNonStopTimeoutRate()
Gets the non stop timeout most recent sample.

Returns:
the non stop timeout most recent sample

getReplaceOneArgSuccessSample

SampledCounter getReplaceOneArgSuccessSample()
Gets the one arg replace success sample

Returns:
one arg success sample

getReplaceOneArgMissSample

SampledCounter getReplaceOneArgMissSample()
Gets the one arg replace miss sample

Returns:
one arg miss sample

getReplaceTwoArgSuccessSample

SampledCounter getReplaceTwoArgSuccessSample()
Gets the two arg replace success sample

Returns:
two arg success sample

getReplaceTwoArgMissSample

SampledCounter getReplaceTwoArgMissSample()
Gets the two arg replace miss sample

Returns:
two arg miss sample

getPutIfAbsentSuccessSample

SampledCounter getPutIfAbsentSuccessSample()
Gets the putIfAbsent success sample

Returns:
putIfAbsent success sample

getPutIfAbsentMissSample

SampledCounter getPutIfAbsentMissSample()
Gets the putIfAbsent miss sample

Returns:
putIfAbsent miss sample

getRemoveElementSuccessSample

SampledCounter getRemoveElementSuccessSample()
Gets the removeElement success sample

Returns:
removeElement success sample

getRemoveElementMissSample

SampledCounter getRemoveElementMissSample()
Gets the removeElement miss sample

Returns:
removeElement miss sample

ehcache

Copyright 2001-2014, Terracotta, Inc.