com.sun.jbi.management.support

Class MBeanSet

java.lang.Object

com.sun.jbi.management.support.MBeanSet

All Implemented Interfaces:

MBeanSet

public class MBeanSet
extends Object
implements MBeanSet

Implementation of MBeanSet interface.

Author:

Sun Microsystems, Inc.

Constructor Summary

Constructors

Constructor and Description
MBeanSet(MBeanServer aMBeanServer, Logger aLogger) Constructs a MBeanSet.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(ObjectName theMBeanName, Class theMBeanDefinition, Object theMBeanImplementation) Add an Standard MBean to the Set that will not emit notifications.
boolean	add(ObjectName theMBeanName, Class theMBeanDefinition, Object theMBeanImplementation, boolean isEmitter) Add an Standard MBean to the Set that can potentially emit JMX notifications.
boolean	delete(ObjectName theMBeanName) Delete an MBean from an existing MBean Set.
void	dump(String aTitle) dump contents of an MBeanSet to the log.
boolean	exists(ObjectName theMBeanName) True if an MBean exists in the named MBean Set.
boolean	isRegistered(ObjectName theMBeanName) True if an MBean is part of this set and is registered.
boolean	register() Register all of the MBean's in an MBean Set.
boolean	replace(ObjectName theMBeanName, Class theMBeanDefinition, Object theMBeanImplementation) Replace a Standard MBean in the Set.
boolean	replace(ObjectName theMBeanName, Class theMBeanDefinition, Object theMBeanImplementation, boolean isEmitter) Replace a Standard MBean in the Set that can potentially emit JMX notifications.
boolean	unregister() Unregister all of the MBean's in an MBean Set.

Methods inherited from class java.lang.Object

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

Constructor Detail

MBeanSet

public MBeanSet(MBeanServer aMBeanServer,
        Logger aLogger)

Constructs a MBeanSet.

Parameters:

aMBeanServer - is the MBean server provided by the framework.

aLogger - is where this class should log messages.

Method Detail

add

public boolean add(ObjectName theMBeanName,
          Class theMBeanDefinition,
          Object theMBeanImplementation,
          boolean isEmitter)

Add an Standard MBean to the Set that can potentially emit JMX notifications.

Specified by:

add in interface MBeanSet

Parameters:

theMBeanName - - the object name of the mbean to add.

theMBeanDefinition - - the interface that defines the MBean.

theMBeanImplementation - - an instance of the MBean implementation class.

isEmitter - - true if this MBean wants to emit jmx notifications.

Returns:

true if mbean is added to the set, otherwise false.

add

public boolean add(ObjectName theMBeanName,
          Class theMBeanDefinition,
          Object theMBeanImplementation)

Add an Standard MBean to the Set that will not emit notifications.

Specified by:

add in interface MBeanSet

Parameters:

theMBeanName - - the object name of the mbean to add.

theMBeanDefinition - - the interface that defines the MBean.

theMBeanImplementation - - an instance of the MBean implementation class.

Returns:

true if mbean is added to the set, otherwise false.

replace

public boolean replace(ObjectName theMBeanName,
              Class theMBeanDefinition,
              Object theMBeanImplementation,
              boolean isEmitter)

Replace a Standard MBean in the Set that can potentially emit JMX notifications.

Specified by:

replace in interface MBeanSet

Parameters:

theMBeanName - - the object name of the mbean to replace.

theMBeanDefinition - - the interface that defines the MBean.

theMBeanImplementation - - an instance of the MBean implementation class.

isEmitter - - true if this MBean wants to emit jmx notifications.

Returns:

true if mbean is replaced in the set, otherwise false.

replace

public boolean replace(ObjectName theMBeanName,
              Class theMBeanDefinition,
              Object theMBeanImplementation)

Replace a Standard MBean in the Set.

Specified by:

replace in interface MBeanSet

Parameters:

theMBeanName - - the object name of the mbean to replace.

theMBeanDefinition - - the interface that defines the MBean.

theMBeanImplementation - - an instance of the MBean implementation class.

Returns:

true if mbean is replaced in the set, otherwise false.

delete

public boolean delete(ObjectName theMBeanName)

Delete an MBean from an existing MBean Set.

Specified by:

delete in interface MBeanSet

Parameters:

theMBeanName - - the object name of the mbean to delete.

Returns:

true if the MBean is deleted from the set, otherwise false.

exists

public boolean exists(ObjectName theMBeanName)

True if an MBean exists in the named MBean Set.

Specified by:

exists in interface MBeanSet

Parameters:

theMBeanName - - the object name of the mbean to check.

Returns:

true if the MBean exists in the set, otherwise false.

isRegistered

public boolean isRegistered(ObjectName theMBeanName)

True if an MBean is part of this set and is registered.

Specified by:

isRegistered in interface MBeanSet

Parameters:

theMBeanName - - the object name of the mbean to check.

Returns:

true if the MBean exists in the set, otherwise false.

register

public boolean register()

Register all of the MBean's in an MBean Set. Okay if some are already registered. Ignores null entries. To re-register, you must unregister the named object before registering the set.

Specified by:

register in interface MBeanSet

Returns:

true iff all mbeans are now registered.

unregister

public boolean unregister()

Unregister all of the MBean's in an MBean Set. It is not an error to unregister an MBean that is not registered.

Specified by:

unregister in interface MBeanSet

Returns:

true iff all mbeans are unregistered.

dump

public void dump(String aTitle)

dump contents of an MBeanSet to the log.

Specified by:

dump in interface MBeanSet

Parameters:

aTitle - - the title of the dump.