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.

Since:: 1.5

Method Summary

Modifier and Type	Method	Description
`Number`	`getDerivedGauge()`	Deprecated. As of JMX 1.2, replaced by `getDerivedGauge(ObjectName)`
`Number`	`getDerivedGauge(ObjectName object)`	Gets the derived gauge for the specified MBean.
`long`	`getDerivedGaugeTimeStamp()`	Deprecated. As of JMX 1.2, replaced by `getDerivedGaugeTimeStamp(ObjectName)`
`long`	`getDerivedGaugeTimeStamp(ObjectName object)`	Gets the derived gauge timestamp for the specified MBean.
`boolean`	`getDifferenceMode()`	Gets the difference mode flag value.
`Number`	`getHighThreshold()`	Gets the high threshold value.
`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(Number highValue, Number lowValue)`	Sets the high and the low threshold values.

Methods declared in interface MonitorMBean

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

Modifier and Type	Method	Description
`void`	`addObservedObject(ObjectName object)`	Adds the specified object in the set of observed MBeans.
`boolean`	`containsObservedObject(ObjectName object)`	Tests whether the specified object is in the set of observed MBeans.
`long`	`getGranularityPeriod()`	Gets the granularity period (in milliseconds).
`String`	`getObservedAttribute()`	Gets the attribute being observed.
`ObjectName`	`getObservedObject()`	Deprecated. As of JMX 1.2, replaced by `MonitorMBean.getObservedObjects()`
`ObjectName[]`	`getObservedObjects()`	Returns an array containing the objects being observed.
`boolean`	`isActive()`	Tests if the monitor MBean is active.
`void`	`removeObservedObject(ObjectName object)`	Removes the specified object from the set of observed MBeans.
`void`	`setGranularityPeriod(long period)`	Sets the granularity period (in milliseconds).
`void`	`setObservedAttribute(String attribute)`	Sets the attribute to observe.
`void`	`setObservedObject(ObjectName object)`	Deprecated. As of JMX 1.2, replaced by `MonitorMBean.addObservedObject(ObjectName)`
`void`	`start()`	Starts the monitor.
`void`	`stop()`	Stops the monitor.

Method Details

getDerivedGauge

@Deprecated Number getDerivedGauge()

Deprecated.

As of JMX 1.2, replaced by getDerivedGauge(ObjectName)

Gets the derived gauge.

Returns:: The derived gauge.

getDerivedGaugeTimeStamp

@Deprecated long getDerivedGaugeTimeStamp()

Deprecated.

As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName)

Gets the derived gauge timestamp.

Returns:: The derived gauge timestamp.

getDerivedGauge

Number getDerivedGauge(ObjectName object)

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

long getDerivedGaugeTimeStamp(ObjectName object)

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.

getHighThreshold

Number getHighThreshold()

Gets the high threshold value.

Returns:: The high threshold value.

getLowThreshold

Number getLowThreshold()

Gets the low threshold value.

Returns:: The low threshold value.

setThresholds

void setThresholds(Number highValue, Number lowValue) throws IllegalArgumentException

Sets the high and the low threshold values.

Parameters:: highValue - The high threshold value.; lowValue - The low threshold value.
Throws:: 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

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.

See Also:

setNotifyHigh

void setNotifyHigh(boolean value)

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

Parameters:

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

See Also:

getNotifyLow

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.

See Also:

setNotifyLow

void setNotifyLow(boolean value)

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

Parameters:

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

See Also:

getDifferenceMode

boolean getDifferenceMode()

Gets the difference mode flag value.

Returns:

true if the difference mode is used, false otherwise.

See Also:

setDifferenceMode

void setDifferenceMode(boolean value)

Sets the difference mode flag value.

Parameters:

value - The difference mode flag value.

See Also:

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.