org.opendaylight.infrautils.diagstatus

Class MBeanUtils

java.lang.Object

org.opendaylight.infrautils.diagstatus.MBeanUtils

public final class MBeanUtils
extends Object

MBeanUtils is a utility that can be used for registering a new MBean or accessing any MBean service.

Author:

Faseela K - initial author, Michael Vorburger.ch - exception handling improvements and introduction of strongly typed getMBean()

Field Summary

Fields

Modifier and Type	Field and Description
static String	JMX_HOST_PREFIX
static String	JMX_OBJECT_NAME
static String	JMX_SVCSTATUS_OPERATION_DETAILED
static String	JMX_TARGET_PREFIX
static String	JMX_URL_SEPARATOR
static String	JMX_URL_SUFFIX
static int	RMI_REGISTRY_PORT

Method Summary

Modifier and Type	Method and Description
static String	constructJmxUrl(String targetHost, int rmiRegistryPort)
static JMXServiceURL	getJMXUrl(String targetHost)
static <T> T	getMBean(String jmxName, Class<T> klass)
static Object	getMBeanAttribute(String objName, String attribute)
static Object	invokeMBeanFunction(String objName, String functionName)
static String	invokeRemoteJMXOperation(String host, String mbeanName)
static Object	readMBeanAttribute(String objName, String attribute) Deprecated. Use getMBeanAttribute(String, String) instead.
static MBeanServer	registerServerMBean(Object mxBeanImplementor, String objNameStr)
static org.apache.commons.lang3.tuple.Pair<JMXConnectorServer,Registry>	startRMIConnectorServer(MBeanServer mbeanServer, String selfAddress)
static void	stopRMIConnectorServer(org.apache.commons.lang3.tuple.Pair<JMXConnectorServer,Registry> jmxConnector)
static void	unregisterServerMBean(Object mxBeanImplementor, String objNameStr)

Methods inherited from class java.lang.Object

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

Field Detail

JMX_OBJECT_NAME

public static final String JMX_OBJECT_NAME

See Also:

Constant Field Values

JMX_SVCSTATUS_OPERATION_DETAILED

public static final String JMX_SVCSTATUS_OPERATION_DETAILED

See Also:

Constant Field Values

JMX_HOST_PREFIX

public static final String JMX_HOST_PREFIX

See Also:

Constant Field Values

JMX_TARGET_PREFIX

public static final String JMX_TARGET_PREFIX

See Also:

Constant Field Values

JMX_URL_SUFFIX

public static final String JMX_URL_SUFFIX

See Also:

Constant Field Values

JMX_URL_SEPARATOR

public static final String JMX_URL_SEPARATOR

See Also:

Constant Field Values

RMI_REGISTRY_PORT

public static final int RMI_REGISTRY_PORT

See Also:

Constant Field Values

Method Detail

getJMXUrl

public static JMXServiceURL getJMXUrl(String targetHost)
                               throws MalformedURLException

Throws:

MalformedURLException

constructJmxUrl

public static String constructJmxUrl(String targetHost,
                                     int rmiRegistryPort)

startRMIConnectorServer

public static org.apache.commons.lang3.tuple.Pair<JMXConnectorServer,Registry> startRMIConnectorServer(MBeanServer mbeanServer,
                                                                                                       String selfAddress)
                                                                                                throws IOException

Throws:

IOException

stopRMIConnectorServer

public static void stopRMIConnectorServer(org.apache.commons.lang3.tuple.Pair<JMXConnectorServer,Registry> jmxConnector)
                                   throws IOException

Throws:

IOException

registerServerMBean

public static MBeanServer registerServerMBean(Object mxBeanImplementor,
                                              String objNameStr)
                                       throws JMException

Throws:

JMException

unregisterServerMBean

public static void unregisterServerMBean(Object mxBeanImplementor,
                                         String objNameStr)
                                  throws MalformedObjectNameException,
                                         InstanceNotFoundException,
                                         MBeanRegistrationException

Throws:

MalformedObjectNameException

InstanceNotFoundException

MBeanRegistrationException

invokeMBeanFunction

public static Object invokeMBeanFunction(String objName,
                                         String functionName)

getMBeanAttribute

@Nullable
public static Object getMBeanAttribute(String objName,
                                                 String attribute)
                                          throws JMException

Throws:

JMException

readMBeanAttribute

@Nullable
 @Deprecated
public static Object readMBeanAttribute(String objName,
                                                               String attribute)

Deprecated. Use getMBeanAttribute(String, String) instead.

TODO remove this as soon as the usage in org.opendaylight.genius.mdsalutil.diagstatus.internal.DatastoreServiceStatusProvider.getServiceDescriptor() is removed.

getMBean

public static <T> T getMBean(String jmxName,
                             Class<T> klass)
                      throws MalformedObjectNameException

Throws:

MalformedObjectNameException

invokeRemoteJMXOperation

public static String invokeRemoteJMXOperation(String host,
                                              String mbeanName)
                                       throws Exception

Throws:

Exception