javax.management.monitor
Interface GaugeMonitorMBean

All Superinterfaces:

MonitorMBean

All Known Implementing Classes:

GaugeMonitor

public interface GaugeMonitorMBean

extends MonitorMBean

Exposes the remote management interface of the gauge monitor MBean.

Author:

Young Yang

Method Summary

java.lang.Number	getDerivedGauge() Gets the derived gauge.
long	getDerivedGaugeTimeStamp() Gets the derived gauge timestamp.
boolean	getDifferenceMode() Gets the difference mode flag value.
java.lang.Number	getHighThreshold() Gets the high threshold value.
java.lang.Number	getLowThreshold() Gets the low threshold value.
boolean	getNotifyHigh() Gets the high notification's on/off switch value.
boolean	getNotifyLow() Gets the low notification's on/off switch value.
void	setDifferenceMode(boolean value) Sets the difference mode flag value.
void	setNotifyHigh(boolean value) Sets the high notification's on/off switch value.
void	setNotifyLow(boolean value) Sets the low notification's on/off switch value.
void	setThresholds(java.lang.Number highValue, java.lang.Number lowValue) Sets the high and the low threshold values.

Methods inherited from interface javax.management.monitor.MonitorMBean

getGranularityPeriod, getObservedAttribute, getObservedObject, isActive, setGranularityPeriod, setObservedAttribute, setObservedObject

Method Detail

getDerivedGauge

public java.lang.Number getDerivedGauge()

Gets the derived gauge.

Returns:

The derived gauge.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp()

Gets the derived gauge timestamp.

Returns:

The derived gauge timestamp.

getHighThreshold

public java.lang.Number getHighThreshold()

Gets the high threshold value.

Returns:

The high threshold value.

getLowThreshold

public java.lang.Number getLowThreshold()

Gets the low threshold value.

Returns:

The low threshold value.

setThresholds

public void setThresholds(java.lang.Number highValue,
                          java.lang.Number lowValue)
                   throws java.lang.IllegalArgumentException

Sets the high and the low threshold values.

Parameters:

highValue - The high threshold value.

lowValue - The low threshold value.

Throws:

java.lang.IllegalArgumentException - The specified high/low threshold is null or the low threshold is greater than the high threshold or the high threshold and the low threshold are not of the same type.

getNotifyHigh

public boolean getNotifyHigh()

Gets the high notification's on/off switch value.

Returns:

true if the gauge monitor notifies when exceeding the high threshold, false otherwise.

setNotifyHigh

public void setNotifyHigh(boolean value)

Sets the high notification's on/off switch value.

Parameters:

value - The high notification's on/off switch value.

getNotifyLow

public boolean getNotifyLow()

Gets the low notification's on/off switch value.

Returns:

true if the gauge monitor notifies when exceeding the low threshold, false otherwise.

setNotifyLow

public void setNotifyLow(boolean value)

Sets the low notification's on/off switch value.

Parameters:

value - The low notification's on/off switch value.

getDifferenceMode

public boolean getDifferenceMode()

Gets the difference mode flag value.

Returns:

true if the difference mode is used, false otherwise.

setDifferenceMode

public void setDifferenceMode(boolean value)

Sets the difference mode flag value.

Parameters:

value - The difference mode flag value.