com.sun.jbi.management

Interface MBeanSet

public interface MBeanSet

MBeanSet is used to manage a set of Standard MBean's. We provide methods that to operate on the set as a whole; for example register and deregister the set. All operations are keyed by the Object Name of the MBean.

Author:

Sun Microsystems, Inc.

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.

Method Detail

add

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

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

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

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

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

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

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

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

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

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

Replace a Standard MBean in the Set.

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

boolean delete(ObjectName theMBeanName)

Delete an MBean from an existing MBean Set.

Parameters:

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

Returns:

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

exists

boolean exists(ObjectName theMBeanName)

True if an MBean exists in the named MBean Set.

Parameters:

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

Returns:

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

isRegistered

boolean isRegistered(ObjectName theMBeanName)

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

Parameters:

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

Returns:

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

register

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.

Returns:

true iff all mbeans are now registered.

unregister

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.

Returns:

true iff all mbeans are unregistered.

dump

void dump(String aTitle)

dump contents of an MBeanSet to the log.

Parameters:

aTitle - - the title of the dump.