Package org.infinispan.jmx

Class CacheJmxRegistration

java.lang.Object

org.infinispan.jmx.CacheJmxRegistration

All Implemented Interfaces:

ObjectNameKeys

public final class CacheJmxRegistration
extends Object

If Configuration.statistics() is enabled, then class will register all the MBeans from cache local's ConfigurationRegistry to the MBean server.

Since:

4.0

Author:

Mircea.Markus@jboss.com, Galder Zamarreño

Field Summary

Fields inherited from interface org.infinispan.jmx.ObjectNameKeys

COMPONENT, MANAGER, NAME, TYPE

Constructor Summary

Constructors

Constructor	Description
CacheJmxRegistration()

Method Summary

Modifier and Type	Method	Description
boolean	enabled()	Checks that JMX is effectively enabled.
String	getDomain()	Gets the domain name.
String	getGroupName()	Gets the group name.
MBeanServer	getMBeanServer()	Gets the MBean server.
protected String	initGroup()	Subclasses must implement this hook to initialize groupName during start.
ObjectName	registerExternalMBean(Object managedComponent, String groupName)	Registers a MBean, but does not track it to perform automatic unregistration on stop.
void	registerMBean(Object managedComponent)	Registers a MBean (and tracks it to perform automatic unregistration on stop).
void	registerMBean(Object managedComponent, String groupName)	Registers a MBean (and tracks it to perform automatic unregistration on stop).
void	start()	Looks up the MBean server and initializes domain and group.
void	stop()	Unregisters the MBeans that were registered on start.
void	unregisterMBean(ObjectName objectName)	Unregisters the MBean located under the given ObjectName, if it exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheJmxRegistration

public CacheJmxRegistration()

Method Detail

start

public void start()

Looks up the MBean server and initializes domain and group. Overriders must ensure they call super.

stop

public void stop()

Unregisters the MBeans that were registered on start. Overriders must ensure they call super.

initGroup

protected String initGroup()

Subclasses must implement this hook to initialize groupName during start.

enabled

public final boolean enabled()

Checks that JMX is effectively enabled.

getDomain

public final String getDomain()

Gets the domain name. This should not be called unless JMX is enabled.

getGroupName

public final String getGroupName()

Gets the group name. This should not be called unless JMX is enabled.

getMBeanServer

public final MBeanServer getMBeanServer()

Gets the MBean server. This should not be called unless JMX is enabled.

registerExternalMBean

public ObjectName registerExternalMBean(Object managedComponent,
                                        String groupName)
                                 throws Exception

Registers a MBean, but does not track it to perform automatic unregistration on stop. The caller is expected to perform unregistration using the returned ObjectName.

Throws:

Exception

registerMBean

public void registerMBean(Object managedComponent)
                   throws Exception

Registers a MBean (and tracks it to perform automatic unregistration on stop). This method should be used for components that are registered after the startup of the component registry and did not get registered automatically.

Throws:

Exception

registerMBean

public void registerMBean(Object managedComponent,
                          String groupName)
                   throws Exception

Registers a MBean (and tracks it to perform automatic unregistration on stop). This method should be used only for components that are registered after the startup of the component registry and did not get registered automatically.

Throws:

Exception

unregisterMBean

public void unregisterMBean(ObjectName objectName)
                     throws Exception

Unregisters the MBean located under the given ObjectName, if it exists.

Parameters:

objectName - ObjectName where the MBean is registered

Throws:

Exception - If unregistration could not be completed.