com.hazelcast.jmx
Class AbstractMBean<E>

java.lang.Object
  com.hazelcast.jmx.AbstractMBean<E>

All Implemented Interfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration

Direct Known Subclasses:

AtomicNumberMBean, ClusterMBean, CountDownLatchMBean, DataMBean, ListMBean, LockMBean, MapEntryMBean, MapMBean, MemberMBean, MultiMapMBean, QueueMBean, SemaphoreMBean, SetMBean, TopicMBean

public abstract class AbstractMBean<E>
extends java.lang.Object
implements javax.management.DynamicMBean, javax.management.MBeanRegistration

A generic class to instrument object with dynamic MBeans.

Implements the method instrument(), in which add attributes and operation exposed to JMX.

If the managed object is an immutable state of some other object that requires a special refresh strategy, override method refresh()

http://docs.sun.com/app/docs/doc/816-4178/6madjde4n?a=view

Author:

Marco Ferrante, DISI - University of Genoa

Field Summary

protected static java.util.logging.Logger	logger
protected ManagementService	managementService
protected javax.management.MBeanServer	mbeanServer

Constructor Summary

AbstractMBean(E managedObject, ManagementService service)

Method Summary

java.lang.Object	getAttribute(java.lang.String attribute) Local attribute override managed object attribute
javax.management.AttributeList	getAttributes(java.lang.String[] attributes) getAttributes() in interface DynamicMBean
E	getManagedObject()
javax.management.MBeanInfo	getMBeanInfo() From DynamicMBean interface
protected ObjectNameSpec	getNameSpec() Override to provide a JMX name
javax.management.ObjectName	getObjectName() The current objectName.
ObjectNameSpec	getParentName()
java.lang.Object	invoke(java.lang.String actionName, java.lang.Object[] params, java.lang.String[] signature) invoke() in interface DynamicMBean
void	postDeregister() From interface MBeanRegistration
void	postRegister(java.lang.Boolean registrationDone) From interface MBeanRegistration
void	preDeregister() From interface MBeanRegistration
javax.management.ObjectName	preRegister(javax.management.MBeanServer server, javax.management.ObjectName name) From interface MBeanRegistration
protected E	refresh() Override this method if the managed object requires some refresh before reading.
void	setAttribute(javax.management.Attribute attribute)
javax.management.AttributeList	setAttributes(javax.management.AttributeList attributes)
void	setParentName(ObjectNameSpec spec)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final java.util.logging.Logger logger

mbeanServer

protected transient javax.management.MBeanServer mbeanServer

managementService

protected final ManagementService managementService

Constructor Detail

AbstractMBean

public AbstractMBean(E managedObject,
                     ManagementService service)

Method Detail

getManagedObject

public final E getManagedObject()

refresh

protected E refresh()

Override this method if the managed object requires some refresh before reading. Return the new state/object.

getMBeanInfo

public javax.management.MBeanInfo getMBeanInfo()

From DynamicMBean interface

Specified by:

getMBeanInfo in interface javax.management.DynamicMBean

getAttribute

public final java.lang.Object getAttribute(java.lang.String attribute)
                                    throws javax.management.AttributeNotFoundException,
                                           javax.management.MBeanException,
                                           javax.management.ReflectionException

Local attribute override managed object attribute

Specified by:

getAttribute in interface javax.management.DynamicMBean

Throws:

javax.management.AttributeNotFoundException

javax.management.MBeanException

javax.management.ReflectionException

getAttributes

public final javax.management.AttributeList getAttributes(java.lang.String[] attributes)

getAttributes() in interface DynamicMBean

Specified by:

getAttributes in interface javax.management.DynamicMBean

Parameters:

attributes - A String array of names of the attributes to be retrieved.

Returns:

The array of the retrieved attributes.

Throws:

javax.management.RuntimeOperationsException - Wraps an IllegalArgumentException: The object name in parameter is null or attributes in parameter is null.

invoke

public final java.lang.Object invoke(java.lang.String actionName,
                                     java.lang.Object[] params,
                                     java.lang.String[] signature)
                              throws javax.management.MBeanException,
                                     javax.management.ReflectionException

invoke() in interface DynamicMBean

Specified by:

invoke in interface javax.management.DynamicMBean

Throws:

javax.management.MBeanException

javax.management.ReflectionException

setAttribute

public final void setAttribute(javax.management.Attribute attribute)
                        throws javax.management.AttributeNotFoundException,
                               javax.management.InvalidAttributeValueException,
                               javax.management.MBeanException,
                               javax.management.ReflectionException

Specified by:

setAttribute in interface javax.management.DynamicMBean

Throws:

javax.management.AttributeNotFoundException

javax.management.InvalidAttributeValueException

javax.management.MBeanException

javax.management.ReflectionException

setAttributes

public final javax.management.AttributeList setAttributes(javax.management.AttributeList attributes)

Specified by:

setAttributes in interface javax.management.DynamicMBean

setParentName

public void setParentName(ObjectNameSpec spec)

getParentName

public ObjectNameSpec getParentName()

getNameSpec

protected ObjectNameSpec getNameSpec()

Override to provide a JMX name

getObjectName

public final javax.management.ObjectName getObjectName()
                                                throws java.lang.Exception

The current objectName. To provide a default, override this method and pass null as name to the method MBeanServer.registerMBean()

Returns:

The current objectName

Throws:

java.lang.Exception

preRegister

public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
                                               javax.management.ObjectName name)
                                        throws java.lang.Exception

From interface MBeanRegistration

Specified by:

preRegister in interface javax.management.MBeanRegistration

Throws:

java.lang.Exception

postRegister

public void postRegister(java.lang.Boolean registrationDone)

From interface MBeanRegistration

Specified by:

postRegister in interface javax.management.MBeanRegistration

preDeregister

public void preDeregister()
                   throws java.lang.Exception

From interface MBeanRegistration

Specified by:

preDeregister in interface javax.management.MBeanRegistration

Throws:

java.lang.Exception

postDeregister

public void postDeregister()

From interface MBeanRegistration

Specified by:

postDeregister in interface javax.management.MBeanRegistration