net.anotheria.moskito.core.util

Class MBeanUtil

java.lang.Object

net.anotheria.moskito.core.util.MBeanUtil

public class MBeanUtil
extends java.lang.Object

Utility class to register and unregister MBeans. Methods that performs registration/unregistration is synchronized on MBean server.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Unregisters all beans, that been registered by this utility object.
static MBeanUtil	getInstance()
java.lang.String	registerMBean(java.lang.Object bean, java.lang.String name) Overloaded method with 'replace' parameter set to false.
java.lang.String	registerMBean(java.lang.Object bean, java.lang.String name, boolean replace) Registers MBean in local MBean server.
boolean	unregisterMBean(java.lang.String name) Unregisters MBean from platform MBean server.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static MBeanUtil getInstance()

registerMBean

public java.lang.String registerMBean(java.lang.Object bean,
                                      java.lang.String name)
                               throws javax.management.MalformedObjectNameException,
                                      javax.management.NotCompliantMBeanException,
                                      javax.management.MBeanRegistrationException

Overloaded method with 'replace' parameter set to false. See: registerMBean(Object, String, boolean)

Throws:

javax.management.MalformedObjectNameException

javax.management.NotCompliantMBeanException

javax.management.MBeanRegistrationException

registerMBean

public java.lang.String registerMBean(java.lang.Object bean,
                                      java.lang.String name,
                                      boolean replace)
                               throws javax.management.MalformedObjectNameException,
                                      javax.management.NotCompliantMBeanException,
                                      javax.management.MBeanRegistrationException

Registers MBean in local MBean server. Method has mechanism to resolve bean name duplication depends on `replace` parameter of ths method. If true - old bean be replaced by new one. If false - prefix been added to bean name from method parameter Prefix format: copy{$number}.{$originalName} where: $number - bean copy number (1 for first copy) $originalName - original bean name passed to this method

Parameters:

bean - MBean object

name - MBean name

replace - controls resolving of bean name duplication. true - old bean be replaced by new one. false - prefix be added to bean name.

Returns:

name of MBean string

Throws:

javax.management.MalformedObjectNameException - name from parameter is unacceptable as object name

javax.management.NotCompliantMBeanException - thrown by MBeanServer

javax.management.MBeanRegistrationException - thrown by MBeanServer

unregisterMBean

public boolean unregisterMBean(java.lang.String name)
                        throws javax.management.MBeanRegistrationException

Unregisters MBean from platform MBean server.

Parameters:

name - name of MBean to unregister

Returns:

true - bean unregistered false - bean with such name not found

Throws:

javax.management.MBeanRegistrationException - thrown by MBeanServer

cleanup

public void cleanup()

Unregisters all beans, that been registered by this utility object.