javax.management.monitor
Interface GaugeMonitorMBean

All Superinterfaces:

MonitorMBean

All Known Implementing Classes:

GaugeMonitor

public interface GaugeMonitorMBean
extends MonitorMBean

The gauge monitor service MBean interface.

Version:

$Revision: 57200 $

Author:

Adrian Brock

Method Summary

Number	getDerivedGauge() Deprecated. use getDerivedGauge(ObjectName)
Number	getDerivedGauge(ObjectName name) Retrieves the derived gauge.
long	getDerivedGaugeTimeStamp() Deprecated. use getDerivedGaugeTimeStamp(ObjectName)
long	getDerivedGaugeTimeStamp(ObjectName name) Retrieves the derived gauge timestamp.
boolean	getDifferenceMode() Retrieves the difference mode flag.
Number	getHighThreshold() Retrieves the high threshold.
Number	getLowThreshold() Retrieves the low threshold.
boolean	getNotifyHigh() Retrieves the high notify on/off switch.
boolean	getNotifyLow() Retrieves the low notify on/off switch.
void	setDifferenceMode(boolean value) Sets the difference mode flag.
void	setNotifyHigh(boolean value) Sets the high notify on/off switch.
void	setNotifyLow(boolean value) Sets the low notify on/off switch.
void	setThresholds(Number highValue, Number lowValue) Sets the high and low threshold.

Methods inherited from interface javax.management.monitor.MonitorMBean

addObservedObject, containsObservedObject, getGranularityPeriod, getObservedAttribute, getObservedObject, getObservedObjects, isActive, removeObservedObject, setGranularityPeriod, setObservedAttribute, setObservedObject, start, stop

Method Detail

getDerivedGauge

Number getDerivedGauge()

Deprecated. use getDerivedGauge(ObjectName)

Retrieves the derived gauge.

Returns:

the derived gauge.

getDerivedGaugeTimeStamp

long getDerivedGaugeTimeStamp()

Deprecated. use getDerivedGaugeTimeStamp(ObjectName)

Retrieves the derived gauge timestamp.

Returns:

the derived gauge timestamp.

getDerivedGauge

Number getDerivedGauge(ObjectName name)

Retrieves the derived gauge.

Parameters:

name - the object name of the mbean.

Returns:

the derived gauge.

getDerivedGaugeTimeStamp

long getDerivedGaugeTimeStamp(ObjectName name)

Retrieves the derived gauge timestamp.

Parameters:

name - the object name of the mbean.

Returns:

the derived gauge timestamp.

getHighThreshold

Number getHighThreshold()

Retrieves the high threshold. REVIEW: zero threshold

Returns:

the high threshold value, zero means no threshold.

getLowThreshold

Number getLowThreshold()

Retrieves the low threshold. REVIEW: zero threshold

Returns:

the low threshold value, zero means no threshold.

setThresholds

void setThresholds(Number highValue,
                   Number lowValue)
                   throws IllegalArgumentException

Sets the high and low threshold. REVIEW: zero threshold

Parameters:

highValue - the high threshold value, pass zero for no high threshold.

lowValue - the low threshold value, pass zero for no low threshold.

Throws:

IllegalArgumentException - when either threshold is null or the high threshold is lower than the low threshold or the. thresholds have different types.

getNotifyHigh

boolean getNotifyHigh()

Retrieves the high notify on/off switch.

Returns:

true if high notifications occur, false otherwise.

setNotifyHigh

void setNotifyHigh(boolean value)

Sets the high notify on/off switch.

Parameters:

value - pass true for high notifications, false otherwise.

getNotifyLow

boolean getNotifyLow()

Retrieves the low notify on/off switch.

Returns:

true if low notifications occur, false otherwise.

setNotifyLow

void setNotifyLow(boolean value)

Sets the low notify on/off switch.

Parameters:

value - pass true for low notifications, false otherwise.

getDifferenceMode

boolean getDifferenceMode()

Retrieves the difference mode flag.

Returns:

true when in difference mode, false otherwise.

setDifferenceMode

void setDifferenceMode(boolean value)

Sets the difference mode flag.