com.sun.jbi.util.jmx

Class MBeanUtils

java.lang.Object

com.sun.jbi.util.jmx.MBeanUtils

public class MBeanUtils
extends Object

Helper class for frequently used MBean housekeeping. This is a static class that must have a reference to the MBean server currently being used. Early in the initialization of the JBI framework, the MBean server reference is set by the framework, before any other JBI services are initialized. This ensures that the MBean server reference will always be available. While not an ideal design, in the context of the JBI runtime, this is a workable solution and prevents every caller from having to have a reference to the MBean server.

Author:

Sun Microsystems, Inc.

Constructor Summary

Constructors

Constructor and Description
MBeanUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	init(MBeanServer server) Initialize the static data.
static void	registerStandardMBean(Class interfaceClass, Object instance, ObjectName mbeanName, boolean replace) Create and register a standard MBean with the main MBean Server.
static void	unregisterMBean(ObjectName mbeanName) Unregister an MBean from the MBean server.

Methods inherited from class java.lang.Object

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

Constructor Detail

MBeanUtils

public MBeanUtils()

Method Detail

init

public static void init(MBeanServer server)

Initialize the static data. This method is called by the framework during initialization so that all other code can use the other methods in the class at any time. This is also used by the ProxyBinding as it has its own classloader so it needs to initialize the same static data.

Parameters:

server - The MBean Server reference to be used.

registerStandardMBean

public static void registerStandardMBean(Class interfaceClass,
                         Object instance,
                         ObjectName mbeanName,
                         boolean replace)
                                  throws JBIException

Create and register a standard MBean with the main MBean Server.

Parameters:

interfaceClass - the MBean interface implemented by the instance.

instance - the MBean implementation instance.

mbeanName - the JMX ObjectName for the MBean.

replace - indicates whether an existing registration should be replaced or cause an error. If true, an existing registration should be replaced; if false, an existing registration should cause an error.

Throws:

JBIException - If the MBean creation or registration fails.

unregisterMBean

public static void unregisterMBean(ObjectName mbeanName)
                            throws JBIException

Unregister an MBean from the MBean server.

Parameters:

mbeanName - the JMX ObjectName for the MBean.

Throws:

JBIException - if the unregistration fails.