Package org.opendaylight.controller.md.sal.common.util.jmx

Class AbstractMXBean

java.lang.Object

org.opendaylight.controller.md.sal.common.util.jmx.AbstractMXBean

Direct Known Subclasses:

CommitStatsMXBeanImpl, DatastoreConfigurationMXBeanImpl, DatastoreInfoMXBeanImpl, RemoteActionRegistryMXBeanImpl, RemoteRpcRegistryMXBeanImpl, ShardDataTreeListenerInfoMXBeanImpl, ShardStats, ThreadExecutorStatsMXBeanImpl

@Beta
public abstract class AbstractMXBean
extends Object

Abstract base for an MXBean implementation class.

This class is not intended for use outside of MD-SAL and its part of private implementation (still exported as public to be reused across MD-SAL implementation components) and may be removed in subsequent releases.

Author:

Thomas Pantelis

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_JMX_PREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMXBean(@NonNull String beanName, @NonNull String beanType, @Nullable String beanCategory)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getMBeanCategory()	Returns the Category property of the bean's ObjectName.
String	getMBeanName()	Returns the name property of the bean's ObjectName.
String	getMBeanType()	Returns the type property of the bean's ObjectName.
void	register()	This method is a wrapper for registerMBean with void return type so it can be invoked by dependency injection frameworks such as Spring and Blueprint.
boolean	registerMBean()	Registers this bean with the platform MBean server with the domain defined by BASE_JMX_PREFIX.
void	unregister()	This method is a wrapper for unregisterMBean with void return type so it can be invoked by dependency injection frameworks such as Spring and Blueprint.
boolean	unregisterMBean()	Unregisters this bean with the platform MBean server.

Methods inherited from class java.lang.Object

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

Field Detail

BASE_JMX_PREFIX

public static final String BASE_JMX_PREFIX

See Also:

Constant Field Values

Constructor Detail

AbstractMXBean

protected AbstractMXBean(@NonNull String beanName,
                         @NonNull String beanType,
                         @Nullable String beanCategory)

Constructor.

Parameters:

beanName - Used as the name property in the bean's ObjectName.

beanType - Used as the type property in the bean's ObjectName.

beanCategory - Used as the Category property in the bean's ObjectName.

Method Detail

register

public void register()

This method is a wrapper for registerMBean with void return type so it can be invoked by dependency injection frameworks such as Spring and Blueprint.

registerMBean

public boolean registerMBean()

Registers this bean with the platform MBean server with the domain defined by BASE_JMX_PREFIX.

Returns:

true is successfully registered, false otherwise.

unregister

public void unregister()

This method is a wrapper for unregisterMBean with void return type so it can be invoked by dependency injection frameworks such as Spring and Blueprint.

unregisterMBean

public boolean unregisterMBean()

Unregisters this bean with the platform MBean server.

Returns:

true is successfully unregistered, false otherwise.

getMBeanName

public String getMBeanName()

Returns the name property of the bean's ObjectName.

getMBeanType

public String getMBeanType()

Returns the type property of the bean's ObjectName.

getMBeanCategory

public String getMBeanCategory()

Returns the Category property of the bean's ObjectName.