net.sf.ehcache.management.sampled
Class SampledCacheManager

java.lang.Object
  net.sf.ehcache.management.sampled.SampledCacheManager

All Implemented Interfaces:

SampledCacheManagerMBean

public class SampledCacheManager
extends java.lang.Object
implements SampledCacheManagerMBean

An implementation of SampledCacheManagerMBean

Since:

1.7

Author:

Abhishek Sanoujam

Constructor Summary

SampledCacheManager(CacheManager cacheManager)
Constructor taking the backing CacheManager

Method Summary

void	clearAll() Clears the contents of all caches in the CacheManager, but without removing any caches.
long	getCacheEvictionRate()
long	getCacheExpirationRate()
long	getCacheHitRate()
java.util.Map<java.lang.String,long[]>	getCacheMetrics() Get a map of cache name to performance metrics (hits, misses).
long	getCacheMissRate()
java.lang.String[]	getCacheNames() Gets the cache names managed by the CacheManager
long	getCachePutRate()
long	getCacheUpdateRate()
java.lang.String	getMBeanRegisteredName() Gets the name used to register this mbean.
java.lang.String	getName() Gets the actual name of the cache manager.
java.lang.String	getStatus() Gets the status attribute of the Ehcache
void	shutdown() Shuts down the CacheManager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SampledCacheManager

public SampledCacheManager(CacheManager cacheManager)

Constructor taking the backing CacheManager

Parameters:

cacheManager -

Method Detail

clearAll

public 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.

Specified by:

clearAll in interface SampledCacheManagerMBean

getCacheNames

public java.lang.String[] getCacheNames()
                                 throws java.lang.IllegalStateException

Gets the cache names managed by the CacheManager

Specified by:

getCacheNames in interface SampledCacheManagerMBean

Throws:

java.lang.IllegalStateException

getStatus

public java.lang.String getStatus()

Gets the status attribute of the Ehcache

Specified by:

getStatus in interface SampledCacheManagerMBean

Returns:

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

shutdown

public 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.

Specified by:

shutdown in interface SampledCacheManagerMBean

getCacheMetrics

public java.util.Map<java.lang.String,long[]> getCacheMetrics()

Description copied from interface: SampledCacheManagerMBean

Get a map of cache name to performance metrics (hits, misses).

Specified by:

getCacheMetrics in interface SampledCacheManagerMBean

Returns:

map of cache metrics (hits, misses)

getCacheHitRate

public long getCacheHitRate()

Specified by:

getCacheHitRate in interface SampledCacheManagerMBean

Returns:

aggregate hit rate

getCacheMissRate

public long getCacheMissRate()

Specified by:

getCacheMissRate in interface SampledCacheManagerMBean

Returns:

aggregate miss rate

getCachePutRate

public long getCachePutRate()

Specified by:

getCachePutRate in interface SampledCacheManagerMBean

Returns:

aggregate put rate

getCacheUpdateRate

public long getCacheUpdateRate()

Specified by:

getCacheUpdateRate in interface SampledCacheManagerMBean

Returns:

aggregate update rate

getCacheEvictionRate

public long getCacheEvictionRate()

Specified by:

getCacheEvictionRate in interface SampledCacheManagerMBean

Returns:

aggregate eviction rate

getCacheExpirationRate

public long getCacheExpirationRate()

Specified by:

getCacheExpirationRate in interface SampledCacheManagerMBean

Returns:

aggregate expiration rate

getName

public java.lang.String getName()

Gets the actual name of the cache manager. This may be different from the name used to register this mbean as there can potentially be multiple cache managers with same name

Specified by:

getName in interface SampledCacheManagerMBean

See Also:

SampledCacheManagerMBean.getName()

getMBeanRegisteredName

public java.lang.String getMBeanRegisteredName()

Gets the name used to register this mbean.

Specified by:

getMBeanRegisteredName in interface SampledCacheManagerMBean

See Also:

SampledCacheManagerMBean.getName()