net.sf.ehcache.management.sampled
Interface SampledCacheManagerMBean

All Known Implementing Classes:

SampledCacheManager

public interface SampledCacheManagerMBean

An MBean for CacheManager exposing sampled cache usage statistics

Since:

1.7

Author:

Abhishek Sanoujam

Field Summary

static java.lang.String	CACHES_CLEARED CACHES_CLEARED
static java.lang.String	CACHES_ENABLED CACHES_ENABLED
static java.lang.String	STATISTICS_ENABLED STATISTICS_ENABLED
static java.lang.String	STATISTICS_RESET STATISTICS_RESET

Method Summary

void	clearAll() Clears the contents of all caches in the CacheManager, but without removing any caches.
void	clearStatistics() Clears statistics of all caches for the associated cacheManager
void	disableStatistics() Disable statistics for each cache contained by cacheManager
void	enableStatistics() Enable statistics for each cache contained by cacheManager
java.lang.String	generateActiveConfigDeclaration() generateActiveConfigDeclaration
java.lang.String	generateActiveConfigDeclaration(java.lang.String cacheName) generateActiveConfigDeclaration
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
boolean	isEnabled() Returns if each cache is enabled.
boolean	isStatisticsEnabled() Returns true iff each contained cache has statistics enabled
void	setEnabled(boolean enabled) Enables/disables each cache contained by this CacheManager
void	setStatisticsEnabled(boolean enabled) Enables/disables each contained cache
void	shutdown() Shuts down the CacheManager.

Field Detail

CACHES_ENABLED

static final java.lang.String CACHES_ENABLED

CACHES_ENABLED

See Also:

Constant Field Values

CACHES_CLEARED

static final java.lang.String CACHES_CLEARED

CACHES_CLEARED

See Also:

Constant Field Values

STATISTICS_RESET

static final java.lang.String STATISTICS_RESET

STATISTICS_RESET

See Also:

Constant Field Values

STATISTICS_ENABLED

static final java.lang.String STATISTICS_ENABLED

STATISTICS_ENABLED

See Also:

Constant Field Values

Method Detail

getName

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

getMBeanRegisteredName

java.lang.String getMBeanRegisteredName()

Gets the name used to register this mbean.

getStatus

java.lang.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

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

Gets the cache names managed by the CacheManager

Throws:

java.lang.IllegalStateException

getCacheMetrics

java.util.Map<java.lang.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

getCacheMissRate

long getCacheMissRate()

Returns:

aggregate miss rate

getCachePutRate

long getCachePutRate()

Returns:

aggregate put rate

getCacheUpdateRate

long getCacheUpdateRate()

Returns:

aggregate update rate

getCacheEvictionRate

long getCacheEvictionRate()

Returns:

aggregate eviction rate

getCacheExpirationRate

long getCacheExpirationRate()

Returns:

aggregate expiration rate

clearStatistics

void clearStatistics()

Clears statistics of all caches for the associated cacheManager

enableStatistics

void enableStatistics()

Enable statistics for each cache contained by cacheManager

disableStatistics

void disableStatistics()

Disable statistics for each cache contained by cacheManager

setStatisticsEnabled

void setStatisticsEnabled(boolean enabled)

Enables/disables each contained cache

isStatisticsEnabled

boolean isStatisticsEnabled()

Returns true iff each contained cache has statistics enabled

generateActiveConfigDeclaration

java.lang.String generateActiveConfigDeclaration()

generateActiveConfigDeclaration

Returns:

CacheManager configuration as String

generateActiveConfigDeclaration

java.lang.String generateActiveConfigDeclaration(java.lang.String cacheName)

generateActiveConfigDeclaration

Parameters:

cacheName -

Returns:

Cache configuration as String