Class AbstractMXBean
java.lang.Object
org.opendaylight.controller.md.sal.common.util.jmx.AbstractMXBean
- Direct Known Subclasses:
RemoteActionRegistryMXBeanImpl
,RemoteRpcRegistryMXBeanImpl
,ThreadExecutorStatsMXBeanImpl
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 -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractMXBean
(@NonNull String beanName, @NonNull String beanType, @Nullable String beanCategory) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionReturns theCategory
property of the bean's ObjectName.Returns thename
property of the bean's ObjectName.Returns thetype
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
Registers this bean with the platform MBean server with the domain defined byBASE_JMX_PREFIX
.void
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
Unregisters this bean with the platform MBean server.
-
Field Details
-
BASE_JMX_PREFIX
- See Also:
-
-
Constructor Details
-
AbstractMXBean
protected AbstractMXBean(@NonNull String beanName, @NonNull String beanType, @Nullable String beanCategory) Constructor.- Parameters:
beanName
- Used as thename
property in the bean's ObjectName.beanType
- Used as thetype
property in the bean's ObjectName.beanCategory
- Used as theCategory
property in the bean's ObjectName.
-
-
Method Details
-
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 byBASE_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
Returns thename
property of the bean's ObjectName. -
getMBeanType
Returns thetype
property of the bean's ObjectName. -
getMBeanCategory
Returns theCategory
property of the bean's ObjectName.
-