org.springframework.boot.actuate.cache

Class AbstractJmxCacheStatisticsProvider<C extends Cache>

java.lang.Object

org.springframework.boot.actuate.cache.AbstractJmxCacheStatisticsProvider<C>

Type Parameters:

C - The cache type

All Implemented Interfaces:

CacheStatisticsProvider<C>

Direct Known Subclasses:

InfinispanCacheStatisticsProvider, JCacheCacheStatisticsProvider

public abstract class AbstractJmxCacheStatisticsProvider<C extends Cache>
extends Object
implements CacheStatisticsProvider<C>

Base CacheStatisticsProvider implementation that uses JMX to retrieve the cache statistics.

Since:

1.3.0

Author:

Stephane Nicoll

Constructor Summary

Constructors

Constructor and Description
AbstractJmxCacheStatisticsProvider()

Method Summary

Modifier and Type	Method and Description
protected <T> T	getAttribute(ObjectName objectName, String attributeName, Class<T> type)
CacheStatistics	getCacheStatistics(CacheManager cacheManager, C cache) Return the current CacheStatistics snapshot for the specified Cache or null if the given cache could not be handled.
protected abstract CacheStatistics	getCacheStatistics(ObjectName objectName) Return the current CacheStatistics snapshot from the MBean identified by the specified ObjectName.
protected MBeanServer	getMBeanServer()
protected abstract ObjectName	getObjectName(C cache) Return the ObjectName of the MBean that is managing the specified cache or null if none is found.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJmxCacheStatisticsProvider

public AbstractJmxCacheStatisticsProvider()

Method Detail

getCacheStatistics

public CacheStatistics getCacheStatistics(CacheManager cacheManager,
                                          C cache)

Description copied from interface: CacheStatisticsProvider

Return the current CacheStatistics snapshot for the specified Cache or null if the given cache could not be handled.

Specified by:

getCacheStatistics in interface CacheStatisticsProvider<C extends Cache>

Parameters:

cacheManager - the CacheManager handling this cache

cache - the cache to handle

Returns:

the current cache statistics or null

getObjectName

protected abstract ObjectName getObjectName(C cache)
                                     throws MalformedObjectNameException

Return the ObjectName of the MBean that is managing the specified cache or null if none is found.

Parameters:

cache - the cache to handle

Returns:

the object name of the cache statistics MBean

Throws:

MalformedObjectNameException - if the ObjectName for that cache is invalid

getCacheStatistics

protected abstract CacheStatistics getCacheStatistics(ObjectName objectName)

Return the current CacheStatistics snapshot from the MBean identified by the specified ObjectName.

Parameters:

objectName - the object name of the cache statistics MBean

Returns:

the current cache statistics

getMBeanServer

protected MBeanServer getMBeanServer()

getAttribute

protected <T> T getAttribute(ObjectName objectName,
                             String attributeName,
                             Class<T> type)