javax.management.monitor
Interface GaugeMonitorMBean

All Known Implementing Classes:

GaugeMonitor

public interface GaugeMonitorMBean

extends MonitorMBean

Exposes the remote management interface of the gauge monitor MBean.

Method Summary

java.lang.Number	getDerivedGauge() Deprecated. Replaced by getDerivedGauge(ObjectName)
java.lang.Number	getDerivedGauge(ObjectName object) This method gets the derived gauge for the specified MBean.
long	getDerivedGaugeTimeStamp() Deprecated. Replaced by getDerivedGaugeTimeStamp(ObjectName)
long	getDerivedGaugeTimeStamp(ObjectName object) This method gets the derived gauge timestamp for the specified MBean.
boolean	getDifferenceMode() This method gets the value of the difference mode.
java.lang.Number	getHighThreshold() This method gets the value of the high threshold.
java.lang.Number	getLowThreshold() This method gets the value of the low threshold.
boolean	getNotifyHigh() This method gets the high notification's on/off switch value.
boolean	getNotifyLow() This method gets the low notification's on/off switch value.
void	setDifferenceMode(boolean value) This method sets the state of the difference mode.
void	setNotifyHigh(boolean value) This method sets the high notification's on/off switch value.
void	setNotifyLow(boolean value) This method sets the low notification's on/off switch value.
void	setThresholds(java.lang.Number highvalue, java.lang.Number lowValue) This method sets the high threshold and low threshold values.

Methods inherited from interface javax.management.monitor.MonitorMBean

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

Method Detail

getDerivedGauge

public java.lang.Number getDerivedGauge()

Deprecated. Replaced by getDerivedGauge(ObjectName)

This method gets the value of the derived gauge. The derived gauge is either the exact value of the observed attribute , or the difference between the two consecutive observed values of the attribute.

Returns:

An instance of java.lang.Number giving the value of the derived gauge.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp()

Deprecated. Replaced by getDerivedGaugeTimeStamp(ObjectName)

This method gets the value of the derived gauge time stamp.The derived gauge time stamp is the value(in the nearest miliseconds) when the notification was triggered.

Returns:

long value representing the time the notification was triggered.

getDerivedGauge

public java.lang.Number getDerivedGauge(ObjectName object)

This method gets the derived gauge for the specified MBean.

Parameters:

object - the MBean for which the derived gauge is to be returned

Returns:

The derived gauge for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp(ObjectName object)

This method gets the derived gauge timestamp for the specified MBean.

Parameters:

object - the MBean for which the derived gauge timestamp is to be returned

Returns:

The derived gauge timestamp for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.

getDifferenceMode

public boolean getDifferenceMode()

This method gets the value of the difference mode. If the difference mode is true, the difference mode option is set to calculate the value of the derived gauge.

Returns:

true if the difference mode is used, false otherwise.

See Also:

setDifferenceMode(boolean)

setDifferenceMode

public void setDifferenceMode(boolean value)

This method sets the state of the difference mode.

Parameters:

value - boolean value representing the state of the difference mode.

See Also:

getDifferenceMode()

getHighThreshold

public java.lang.Number getHighThreshold()

This method gets the value of the high threshold.

Returns:

An instance of java.lang.Number giving the value of the high threshold.

getLowThreshold

public java.lang.Number getLowThreshold()

This method gets the value of the low threshold.

Returns:

An instance of java.lang.Number giving the value of the low threshold.

setThresholds

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

This method sets the high threshold and 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()

This method 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)

This method sets the high notification's on/off switch value.

Parameters:

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

getNotifyLow

public boolean getNotifyLow()

This method 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)

This method sets the low notification's on/off switch value.

Parameters:

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