ehcache

net.sf.ehcache.management.sampled
Interface CacheManagerSampler

All Known Subinterfaces:
SampledCacheManagerMBean
All Known Implementing Classes:
CacheManagerSamplerImpl, SampledCacheManager

public interface CacheManagerSampler

An abstraction for sampled cache manager usage statistics.

Author:
Abhishek Sanoujam, byoukste

Method Summary
 void clearAll()
          Clears the contents of all caches in the CacheManager, but without removing any caches.
 String generateActiveConfigDeclaration()
          generateActiveConfigDeclaration
 String generateActiveConfigDeclaration(String cacheName)
          generateActiveConfigDeclaration
 float getCacheAverageGetTime()
           
 long getCacheAverageSearchTime()
           
 long getCacheEvictionRate()
           
 long getCacheExpirationRate()
           
 long getCacheHitRate()
           
 long getCacheInMemoryHitRate()
           
 long getCacheInMemoryMissRate()
           
 Map<String,long[]> getCacheMetrics()
          Get a map of cache name to performance metrics (hits, misses).
 long getCacheMissRate()
           
 String[] getCacheNames()
          Gets the cache names managed by the CacheManager
 long getCacheOffHeapHitRate()
           
 long getCacheOffHeapMissRate()
           
 long getCacheOnDiskHitRate()
           
 long getCacheOnDiskMissRate()
           
 long getCachePutRate()
           
 long getCacheRemoveRate()
           
 long getCacheSearchRate()
           
 long getCacheUpdateRate()
           
 String getClusterUUID()
          Gets the cluster uuid if applicable.
 boolean getHasWriteBehindWriter()
          Returns whether any caches are configured for write-behind
 long getMaxBytesLocalDisk()
          Maximum number of bytes of entries in the disk stores of all caches that did not declare their own max size.
 String getMaxBytesLocalDiskAsString()
           
 long getMaxBytesLocalHeap()
          Maximum number of bytes of entries in the heap memory stores of all caches that did not declare their own max size.
 String getMaxBytesLocalHeapAsString()
           
 long getMaxBytesLocalOffHeap()
          Maximum number of bytes of entries in the off-heap stores of all caches that did not declare their own max size.
 String getMaxBytesLocalOffHeapAsString()
           
 String getName()
          Gets the actual name of the cache manager.
 boolean getSearchable()
           
 String getStatus()
          Gets the status attribute of the Ehcache
 boolean getTransactional()
          Are any of the caches transactional
 long getTransactionCommitRate()
           
 long getTransactionCommittedCount()
          Get the committed transactions count
 long getTransactionRollbackRate()
           
 long getTransactionRolledBackCount()
          Get the rolled back transactions count
 long getTransactionTimedOutCount()
          Get the timed out transactions count.
 int getWriterMaxQueueSize()
          Maximum elements that can be queued for processing by the write-behind writer
 long getWriterQueueLength()
          Returns the total length of all write-behind queues across all caches
 boolean isEnabled()
          Returns if each cache is enabled.
 void setEnabled(boolean enabled)
          Enables/disables each cache contained by this CacheManager
 void setMaxBytesLocalDisk(long maxBytes)
           
 void setMaxBytesLocalDiskAsString(String maxBytes)
           
 void setMaxBytesLocalHeap(long maxBytes)
           
 void setMaxBytesLocalHeapAsString(String maxBytes)
           
 void shutdown()
          Shuts down the CacheManager.
 

Method Detail

getName

String getName()
Gets the actual name of the cache manager.


getClusterUUID

String getClusterUUID()
Gets the cluster uuid if applicable.

Returns:
the cluster uuid

getStatus

String getStatus()
Gets the status attribute of the Ehcache

Returns:
The status value, as a String from the Status enum class

setEnabled

void setEnabled(boolean enabled)
Enables/disables each cache contained by this CacheManager

Parameters:
enabled -

isEnabled

boolean isEnabled()
Returns if each cache is enabled.

Returns:
boolean indicating that each cache is enabled

shutdown

void shutdown()
Shuts down the CacheManager.

If the shutdown occurs on the singleton, then the singleton is removed, so that if a singleton access method is called, a new singleton will be created.


clearAll

void clearAll()
Clears the contents of all caches in the CacheManager, but without removing any caches.

This method is not synchronized. It only guarantees to clear those elements in a cache at the time that the Ehcache.removeAll() mehod on each cache is called.


getCacheNames

String[] getCacheNames()
                       throws IllegalStateException
Gets the cache names managed by the CacheManager

Throws:
IllegalStateException

getCacheMetrics

Map<String,long[]> getCacheMetrics()
Get a map of cache name to performance metrics (hits, misses).

Returns:
a map of cache metrics

getCacheHitRate

long getCacheHitRate()
Returns:
aggregate hit rate

getCacheInMemoryHitRate

long getCacheInMemoryHitRate()
Returns:
aggregate in-memory hit rate

getCacheOffHeapHitRate

long getCacheOffHeapHitRate()
Returns:
aggregate off-heap hit rate

getCacheOnDiskHitRate

long getCacheOnDiskHitRate()
Returns:
aggregate on-disk hit rate

getCacheMissRate

long getCacheMissRate()
Returns:
aggregate miss rate

getCacheInMemoryMissRate

long getCacheInMemoryMissRate()
Returns:
aggregate in-memory miss rate

getCacheOffHeapMissRate

long getCacheOffHeapMissRate()
Returns:
aggregate off-heap miss rate

getCacheOnDiskMissRate

long getCacheOnDiskMissRate()
Returns:
aggregate on-disk miss rate

getCachePutRate

long getCachePutRate()
Returns:
aggregate put rate

getCacheUpdateRate

long getCacheUpdateRate()
Returns:
aggregate update rate

getCacheRemoveRate

long getCacheRemoveRate()
Returns:
aggregate remove rate

getCacheEvictionRate

long getCacheEvictionRate()
Returns:
aggregate eviction rate

getCacheExpirationRate

long getCacheExpirationRate()
Returns:
aggregate expiration rate

getCacheAverageGetTime

float getCacheAverageGetTime()
Returns:
aggregate average get time (ms.)

getSearchable

boolean getSearchable()
Returns:
if any contained caches are configured for search

getCacheSearchRate

long getCacheSearchRate()
Returns:
aggregate search rate

getCacheAverageSearchTime

long getCacheAverageSearchTime()
Returns:
aggregate search time

generateActiveConfigDeclaration

String generateActiveConfigDeclaration()
generateActiveConfigDeclaration

Returns:
CacheManager configuration as String

generateActiveConfigDeclaration

String generateActiveConfigDeclaration(String cacheName)
generateActiveConfigDeclaration

Parameters:
cacheName -
Returns:
Cache configuration as String

getTransactional

boolean getTransactional()
Are any of the caches transactional

See Also:
CacheConfiguration.TransactionalMode

getTransactionCommittedCount

long getTransactionCommittedCount()
Get the committed transactions count

Returns:
the committed transactions count

getTransactionCommitRate

long getTransactionCommitRate()
Returns:
aggregate Xa commit rate

getTransactionRolledBackCount

long getTransactionRolledBackCount()
Get the rolled back transactions count

Returns:
the rolled back transactions count

getTransactionRollbackRate

long getTransactionRollbackRate()
Returns:
aggregate Xa rollback rate

getTransactionTimedOutCount

long getTransactionTimedOutCount()
Get the timed out transactions count. Note that only transactions which failed to commit due to a timeout are taken into account

Returns:
the timed out transactions count

getHasWriteBehindWriter

boolean getHasWriteBehindWriter()
Returns whether any caches are configured for write-behind


getWriterQueueLength

long getWriterQueueLength()
Returns the total length of all write-behind queues across all caches

Returns:
aggregate writer-behind queue length

getWriterMaxQueueSize

int getWriterMaxQueueSize()
Maximum elements that can be queued for processing by the write-behind writer

Returns:
aggregate of the maximum elements that can be waiting to be processed by the write-behind writer across all caches

getMaxBytesLocalDisk

long getMaxBytesLocalDisk()
Maximum number of bytes of entries in the disk stores of all caches that did not declare their own max size.

Returns:
maximum number of bytes in the disk stores of all caches that did not declare their own max size.

setMaxBytesLocalDisk

void setMaxBytesLocalDisk(long maxBytes)
Parameters:
maxBytes -

setMaxBytesLocalDiskAsString

void setMaxBytesLocalDiskAsString(String maxBytes)
Parameters:
maxBytes -

getMaxBytesLocalDiskAsString

String getMaxBytesLocalDiskAsString()
Returns:
Original input for maxBytesLocalDisk

getMaxBytesLocalHeap

long getMaxBytesLocalHeap()
Maximum number of bytes of entries in the heap memory stores of all caches that did not declare their own max size.

Returns:
maximum number of bytes in the heap memory stores of all caches that did not declare their own max size.

getMaxBytesLocalHeapAsString

String getMaxBytesLocalHeapAsString()
Returns:
Original input for maxBytesLocalHeap

setMaxBytesLocalHeap

void setMaxBytesLocalHeap(long maxBytes)
Parameters:
maxBytes -

setMaxBytesLocalHeapAsString

void setMaxBytesLocalHeapAsString(String maxBytes)
Parameters:
maxBytes -

getMaxBytesLocalOffHeap

long getMaxBytesLocalOffHeap()
Maximum number of bytes of entries in the off-heap stores of all caches that did not declare their own max size.

Returns:
maximum number of bytes in the off-heap stores of all caches that did not declare their own max size.

getMaxBytesLocalOffHeapAsString

String getMaxBytesLocalOffHeapAsString()
Returns:
Original input for maxBytesLocalOffHeap

ehcache

Copyright 2001-2014, Terracotta, Inc.