com.sun.jbi.monitoring

Interface StatisticsBase

All Superinterfaces:

StatisticsMBean

public interface StatisticsBase
extends StatisticsMBean

This interface provides the common base for all of the statistics monitoring interfaces. The methods here provide the infrastucture for creating an object tree that represents the statistics for the entire JBI instance. Each instance of a statistics class has a parent and optionally one or more children. Note that the top object in the tree has no parent.

Author:

Sun Microsystems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(StatisticsBase child) Add a child statistics object.
StatisticsBase	getChild(String key) Get a particular child of this statistics object based on a key.
List	getChildren() Get a list of all children of this statistics object.
String	getKey() Get the key of this statistics object.
StatisticsBase	getParent() Get the parent of this statistics object.
void	registerMBean(Class interfaceClass, Object instance, ObjectName mbeanName) Register an MBean to represent this set of statistics.
void	setParent(StatisticsBase parent) Set the parent of this statistics object.
void	unregisterMBean() Unregister the MBean for this set of statistics.

Methods inherited from interface com.sun.jbi.monitoring.StatisticsMBean

isEnabled, setDisabled, setEnabled

Method Detail

getKey

String getKey()

Get the key of this statistics object.

Returns:

the key of this object.

getParent

StatisticsBase getParent()

Get the parent of this statistics object. The parent of the top object in the tree is always null.

Returns:

the parent object of this object.

setParent

void setParent(StatisticsBase parent)

Set the parent of this statistics object.

Parameters:

parent - the parent object of this object.

addChild

void addChild(StatisticsBase child)

Add a child statistics object.

Parameters:

child - the statistics object that is a child of this object.

getChild

StatisticsBase getChild(String key)

Get a particular child of this statistics object based on a key.

Parameters:

key - the string containing the key for the child object.

Returns:

the statistics object with the specified key, or null if none is found.

getChildren

List getChildren()

Get a list of all children of this statistics object.

Returns:

a List containing all the children objects. Returns an empty list if no children exist.

registerMBean

void registerMBean(Class interfaceClass,
                 Object instance,
                 ObjectName mbeanName)
                   throws JBIException

Register an MBean to represent this set of statistics.

Parameters:

interfaceClass - the interface implemented by the MBean instance.

instance - the MBean instance to register.

mbeanName - the JMX ObjectName to use for this MBean.

Throws:

JBIException - If the MBean creation or registration fails.

unregisterMBean

void unregisterMBean()
                     throws JBIException

Unregister the MBean for this set of statistics.

Throws:

JBIException - If the MBean unregistration fails.