Top Description Methods
javax.management.monitor

public Interface GaugeMonitorMBean

extends MonitorMBean
Known Direct Implementers
javax.management.monitor.GaugeMonitor
Imports
javax.management.ObjectName
Exposes the remote management interface of the gauge monitor MBean.
Since
1.5

Method Summary

Modifier and TypeMethod and Description
public Number

Returns:

The derived gauge.
getDerivedGauge()
Deprecated As of JMX 1.2, replaced by getDerivedGauge(ObjectName)

Gets the derived gauge.

public Number

Returns:

The derived gauge for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.
getDerivedGauge(ObjectName
the MBean for which the derived gauge is to be returned
object)

Gets the derived gauge for the specified MBean.

public long

Returns:

The derived gauge timestamp.
getDerivedGaugeTimeStamp()
Deprecated As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName)

Gets the derived gauge timestamp.

public long

Returns:

The derived gauge timestamp for the specified MBean if this MBean is in the set of observed MBeans, or null otherwise.
getDerivedGaugeTimeStamp(ObjectName
the MBean for which the derived gauge timestamp is to be returned
object)

Gets the derived gauge timestamp for the specified MBean.

public boolean

Returns:

true if the difference mode is used, false otherwise.
getDifferenceMode()

Gets the difference mode flag value.

public Number

Returns:

The high threshold value.
getHighThreshold()

Gets the high threshold value.

public Number

Returns:

The low threshold value.
getLowThreshold()

Gets the low threshold value.

public boolean

Returns:

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

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

public boolean

Returns:

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

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

public void
setDifferenceMode(boolean
The difference mode flag value.
value)

Sets the difference mode flag value.

public void
setNotifyHigh(boolean
The high notification's on/off switch value.
value)

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

public void
setNotifyLow(boolean
The low notification's on/off switch value.
value)

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

public void
setThresholds(Number
The high threshold value.
highValue, Number
The low threshold value.
lowValue)

Sets the high and the low threshold values.

Inherited from javax.management.monitor.MonitorMBean:
addObservedObjectcontainsObservedObjectgetGranularityPeriodgetObservedAttributegetObservedObjectgetObservedObjectsisActiveremoveObservedObjectsetGranularityPeriodsetObservedAttributesetObservedObjectstartstop

Method Detail

getDerivedGaugeback to summary
public Number getDerivedGauge()

Deprecated

As of JMX 1.2, replaced by getDerivedGauge(ObjectName)

Gets the derived gauge.

Returns:Number

The derived gauge.

Annotations
@Deprecated
getDerivedGaugeback to summary
public Number getDerivedGauge(ObjectName object)

Gets the derived gauge for the specified MBean.

Parameters
object:ObjectName

the MBean for which the derived gauge is to be returned

Returns:Number

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

getDerivedGaugeTimeStampback to summary
public long getDerivedGaugeTimeStamp()

Deprecated

As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName)

Gets the derived gauge timestamp.

Returns:long

The derived gauge timestamp.

Annotations
@Deprecated
getDerivedGaugeTimeStampback to summary
public long getDerivedGaugeTimeStamp(ObjectName object)

Gets the derived gauge timestamp for the specified MBean.

Parameters
object:ObjectName

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

Returns:long

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

getDifferenceModeback to summary
public boolean getDifferenceMode()

Gets the difference mode flag value.

Returns:boolean

true if the difference mode is used, false otherwise.

See Also
setDifferenceMode
getHighThresholdback to summary
public Number getHighThreshold()

Gets the high threshold value.

Returns:Number

The high threshold value.

getLowThresholdback to summary
public Number getLowThreshold()

Gets the low threshold value.

Returns:Number

The low threshold value.

getNotifyHighback to summary
public boolean getNotifyHigh()

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

Returns:boolean

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

See Also
setNotifyHigh
getNotifyLowback to summary
public boolean getNotifyLow()

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

Returns:boolean

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

See Also
setNotifyLow
setDifferenceModeback to summary
public void setDifferenceMode(boolean value)

Sets the difference mode flag value.

Parameters
value:boolean

The difference mode flag value.

See Also
getDifferenceMode
setNotifyHighback to summary
public void setNotifyHigh(boolean value)

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

Parameters
value:boolean

The high notification's on/off switch value.

See Also
getNotifyHigh
setNotifyLowback to summary
public void setNotifyLow(boolean value)

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

Parameters
value:boolean

The low notification's on/off switch value.

See Also
getNotifyLow
setThresholdsback to summary
public void setThresholds(Number highValue, Number lowValue) throws IllegalArgumentException

Sets the high and the low threshold values.

Parameters
highValue:Number

The high threshold value.

lowValue:Number

The low threshold value.

Exceptions
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.