com.sun.jbi.util.monitoring

Class StatisticsBaseImpl

java.lang.Object

com.sun.jbi.util.monitoring.StatisticsBaseImpl

All Implemented Interfaces:

StatisticsBase, StatisticsMBean

public class StatisticsBaseImpl
extends Object
implements StatisticsBase

This class provides the common utility methods used by all of the statistics gathering classes. 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.

Author:

Sun Microsystems, Inc.

Constructor Summary

Constructors

Constructor and Description
StatisticsBaseImpl(String key) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(StatisticsBase child) Add a child.
StatisticsBase	getChild(String key) Get a particular child of this object based on a key.
List	getChildren() Get the list of children of this object.
String	getKey() Get the key of this object.
StatisticsBase	getParent() Get the parent of this object.
boolean	isEnabled() Test whether or not statistics are enabled.
void	registerMBean(Class interfaceClass, Object instance, ObjectName mbeanName) Create and register a StandardMBean for this instance, using the specified interface and MBean ObjectName.
void	setDisabled() Disable statistics.
void	setEnabled() Enable statistics.
void	setParent(StatisticsBase parent) Set the parent of this object.
void	unregisterMBean() Unregister the MBean for this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatisticsBaseImpl

public StatisticsBaseImpl(String key)

Constructor.

Parameters:

key - The key string for this statistics object.

Method Detail

getKey

public String getKey()

Get the key of this object.

Specified by:

getKey in interface StatisticsBase

Returns:

the string key for this instance.

setParent

public void setParent(StatisticsBase parent)

Set the parent of this object.

Specified by:

setParent in interface StatisticsBase

Parameters:

parent - the StatisticsBase instance that is the parent of this instance.

getParent

public StatisticsBase getParent()

Get the parent of this object.

Specified by:

getParent in interface StatisticsBase

Returns:

the StatisticsBase instance that is the parent of this instance.

addChild

public void addChild(StatisticsBase child)

Add a child.

Specified by:

addChild in interface StatisticsBase

Parameters:

child - the StatisticsBase instance to be added to the list of children of this instance.

getChild

public StatisticsBase getChild(String key)

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

Specified by:

getChild in interface StatisticsBase

Parameters:

key - the string key of the requested child.

Returns:

the StatisticsBase instance referenced by the specified key, or null if none is found.

getChildren

public List getChildren()

Get the list of children of this object.

Specified by:

getChildren in interface StatisticsBase

Returns:

the list of instances that are children of this instance.

isEnabled

public boolean isEnabled()

Test whether or not statistics are enabled.

Specified by:

isEnabled in interface StatisticsMBean

Returns:

true if statistics are enabled, false if not.

setDisabled

public void setDisabled()

Disable statistics.

Specified by:

setDisabled in interface StatisticsMBean

setEnabled

public void setEnabled()

Enable statistics.

Specified by:

setEnabled in interface StatisticsMBean

registerMBean

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

Create and register a StandardMBean for this instance, using the specified interface and MBean ObjectName.

Specified by:

registerMBean in interface StatisticsBase

Parameters:

interfaceClass - The interface implemented by the instance.

mbeanName - The MBean ObjectName to use for this MBean.

Throws:

JBIException - If the MBean creation or registration fails.

unregisterMBean

public void unregisterMBean()
                     throws JBIException

Unregister the MBean for this instance.

Specified by:

unregisterMBean in interface StatisticsBase

Throws:

JBIException - If the MBean unregistration fails.