Package org.jgroups.jmx

Class JmxConfigurator

java.lang.Object

org.jgroups.jmx.JmxConfigurator

public final class JmxConfigurator
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final Log	log

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JmxConfigurator()

Method Summary

Modifier and Type	Method	Description
private static String	getChannelRegistrationName(String domain, String clusterName)
private static String	getChannelRegistrationName(ObjectName prefix, String clusterName)
private static ObjectName	getObjectName(Object obj, String name)
private static String	getProtocolRegistrationName(String clusterName, String domain, Protocol p)
private static String	getProtocolRegistrationName(String clusterName, ObjectName prefix, Protocol p)
private static void	internalRegister(Object obj, MBeanServer server, String name)
private static void	internalUnregister(Object obj, MBeanServer s, String name)
static void	register(Object obj, MBeanServer server, String name)
static void	registerChannel(JChannel channel, MBeanServer server, String name)	Registers an already created channel with the given MBeanServer.
static void	registerChannel(JChannel channel, MBeanServer server, String domain, String cluster_name, boolean register_protocols)	Registers an already created channel with the given MBeanServer.
static void	registerChannel(JChannel ch, MBeanServer server, ObjectName namePrefix, String cluster_name, boolean register_protocols)
static void	unregister(Object obj, MBeanServer server, String name)
static void	unregister(MBeanServer server, String object_name)	Unregisters object_name and everything under it
static void	unregisterChannel(MBeanServer server, String name)
static void	unregisterChannel(MBeanServer server, ObjectName name)
static void	unregisterChannel(JChannel c, MBeanServer server, String clusterName)
static void	unregisterChannel(JChannel c, MBeanServer server, String domain, String clusterName)
static void	unregisterChannel(JChannel c, MBeanServer server, ObjectName prefix, String clusterName)
static DynamicMBean	wrap(JChannel ch)	Wrap JChannel with DynamicMBean interface.
static DynamicMBean	wrap(Protocol p)	Wrap Protocol with DynamicMBean interface.

Methods inherited from class java.lang.Object

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

Field Details

log

static final Log log

Constructor Details

JmxConfigurator

private JmxConfigurator()

Method Details

registerChannel

public static void registerChannel(JChannel channel,
 MBeanServer server,
 String domain,
 String cluster_name,
 boolean register_protocols)
                            throws Exception

Registers an already created channel with the given MBeanServer. Wraps instance of JChannel with DynamicMBean and delegates all calls to the actual JChannel wrapped.

Optionally, this method will also wrap each protocol in the given channel with DynamicMBean and register it as well.

Parameters:

channel - The channel

server - The MBeanServer

domain - Has to be a JMX ObjectName of the domain, e.g. DefaultDomain:name=JGroups

register_protocols - Whether or not to register the protocols, too

Throws:

Exception

registerChannel

public static void registerChannel(JChannel channel,
 MBeanServer server,
 String name)
                            throws Exception

Registers an already created channel with the given MBeanServer. Wraps instance of JChannel with DynamicMBean and delegates all calls to the actual JChannel wrapped.

This method will also wrap each protocol in the given channel with DynamicMBean and register it as well.

Parameters:

channel - The channel

server - The MBeanServer

name - Has to be a JMX ObjectName of the domain, e.g. DefaultDomain:name=JGroups

Throws:

Exception

registerChannel

public static void registerChannel(JChannel ch,
 MBeanServer server,
 ObjectName namePrefix,
 String cluster_name,
 boolean register_protocols)
                            throws Exception

Throws:

Exception

unregisterChannel

public static void unregisterChannel(MBeanServer server,
 ObjectName name)
                              throws Exception

Throws:

Exception

unregisterChannel

public static void unregisterChannel(MBeanServer server,
 String name)
                              throws Exception

Throws:

Exception

unregisterChannel

public static void unregisterChannel(JChannel c,
 MBeanServer server,
 String clusterName)
                              throws Exception

Throws:

Exception

unregisterChannel

public static void unregisterChannel(JChannel c,
 MBeanServer server,
 String domain,
 String clusterName)
                              throws Exception

Throws:

Exception

unregisterChannel

public static void unregisterChannel(JChannel c,
 MBeanServer server,
 ObjectName prefix,
 String clusterName)
                              throws Exception

Throws:

Exception

register

public static void register(Object obj,
 MBeanServer server,
 String name)
                     throws MBeanRegistrationException,
MalformedObjectNameException

Throws:

MBeanRegistrationException

MalformedObjectNameException

unregister

public static void unregister(Object obj,
 MBeanServer server,
 String name)
                       throws MBeanRegistrationException,
MalformedObjectNameException

Throws:

MBeanRegistrationException

MalformedObjectNameException

wrap

public static DynamicMBean wrap(JChannel ch)

Wrap JChannel with DynamicMBean interface. All annotated attributes and methods will be exposed through DynamicMBean API.

Parameters:

ch - channel to be wrapped

Returns:

Channel ch wrapped as a DynamicBean

See Also:

• ManagedAttribute
• ManagedOperation

wrap

public static DynamicMBean wrap(Protocol p)

Wrap Protocol with DynamicMBean interface. All annotated attributes and methods will be exposed through DynamicMBean API.

Parameters:

p - protocol to be wrapped

Returns:

Protocol p as a DynamicMBean

See Also:

• ManagedAttribute
• ManagedOperation

internalRegister

private static void internalRegister(Object obj,
 MBeanServer server,
 String name)
                              throws MalformedObjectNameException,
MBeanRegistrationException

Throws:

MalformedObjectNameException

MBeanRegistrationException

internalUnregister

private static void internalUnregister(Object obj,
 MBeanServer s,
 String name)
                                throws MBeanRegistrationException

Throws:

MBeanRegistrationException

getObjectName

private static ObjectName getObjectName(Object obj,
 String name)
                                 throws MalformedObjectNameException

Throws:

MalformedObjectNameException

unregister

public static void unregister(MBeanServer server,
 String object_name)
                       throws Exception

Unregisters object_name and everything under it

Parameters:

object_name -

Throws:

Exception

getChannelRegistrationName

private static String getChannelRegistrationName(String domain,
 String clusterName)

getChannelRegistrationName

private static String getChannelRegistrationName(ObjectName prefix,
 String clusterName)

getProtocolRegistrationName

private static String getProtocolRegistrationName(String clusterName,
 String domain,
 Protocol p)

getProtocolRegistrationName

private static String getProtocolRegistrationName(String clusterName,
 ObjectName prefix,
 Protocol p)