com.atlassian.cache.memory.jmx

Class MemoryCacheMXBeanRegistrar

java.lang.Object

com.atlassian.cache.memory.jmx.MemoryCacheMXBeanRegistrar

public class MemoryCacheMXBeanRegistrar
extends Object

Helper for registering / unregistering JMX MBeans for Guava Cache.

Since:

v3.1

Constructor Summary

Constructors

Constructor and Description
MemoryCacheMXBeanRegistrar()

Method Summary

Modifier and Type	Method and Description
void	enableCollectingJMXMetrics(MBeanServer mbeanServer, CacheManager cacheManager) Enables collecting JMX metrics.
void	registerMBean(String cacheName) Registers JMX MBean for the specified cache name.
void	unregisterMBeans() Unregisters all registered JMX MBeans.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryCacheMXBeanRegistrar

public MemoryCacheMXBeanRegistrar()

Method Detail

enableCollectingJMXMetrics

public void enableCollectingJMXMetrics(@Nonnull
                                       MBeanServer mbeanServer,
                                       @Nonnull
                                       CacheManager cacheManager)

Enables collecting JMX metrics.

Note: it must be called to allow the method registerMBean registering MBeans.

Parameters:

mbeanServer - MBeanServer instance used for registering and unregistering MBeans

cacheManager - CacheManager instance used for retrieving caches metrics

registerMBean

public void registerMBean(@Nonnull
                          String cacheName)

Registers JMX MBean for the specified cache name.

Note: it will not register anything if the method enableCollectingJMXMetrics was not called before or unregisterMBeans was called .

Parameters:

cacheName - the cache name for which MBean should be registered

unregisterMBeans

public void unregisterMBeans()

Unregisters all registered JMX MBeans.

Note: it will unregister all registered Cache JMX MBeans