APIdia Launch Partner
Top Description Methods
javax.management.monitor

public Interface CounterMonitorMBean

extends MonitorMBean
Known Direct Implementers
javax.management.monitor.CounterMonitor
Imports
javax.management.ObjectName

Exposes the remote management interface of the counter 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 0 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 initial threshold value.
getInitThreshold
()

Gets the initial threshold value common to all observed objects.

public Number

Returns:

The modulus value.
getModulus
()

Gets the modulus value.

public boolean

Returns:

true if the counter monitor notifies when exceeding the threshold, false otherwise.
getNotify
()

Gets the notification's on/off switch value.

public Number

Returns:

The offset value.
getOffset
()

Gets the offset value.

public Number

Returns:

The threshold value.
getThreshold
()
Deprecated As of JMX 1.2, replaced by getThreshold(ObjectName)

Gets the threshold value.

public Number

Returns:

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

Gets the threshold value for the specified MBean.

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

Sets the difference mode flag value.

public void
setInitThreshold(Number
The initial threshold value.
value
)

Sets the initial threshold value common to all observed MBeans.

public void
setModulus(Number
The modulus value.
value
)

Sets the modulus value.

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

Sets the notification's on/off switch value.

public void
setOffset(Number
The offset value.
value
)

Sets the offset value.

public void
setThreshold(Number
The threshold value.
value
)
Deprecated As of JMX 1.2, replaced by setInitThreshold

Sets the threshold value.

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 0 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
getInitThresholdback to summary
public Number getInitThreshold()

Gets the initial threshold value common to all observed objects.

Returns:Number

The initial threshold value.

See Also
setInitThreshold
getModulusback to summary
public Number getModulus()

Gets the modulus value.

Returns:Number

The modulus value.

See Also
setModulus
getNotifyback to summary
public boolean getNotify()

Gets the notification's on/off switch value.

Returns:boolean

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

See Also
setNotify
getOffsetback to summary
public Number getOffset()

Gets the offset value.

Returns:Number

The offset value.

See Also
setOffset(Number)
getThresholdback to summary
public Number getThreshold()

Deprecated

As of JMX 1.2, replaced by getThreshold(ObjectName)

Gets the threshold value.

Returns:Number

The threshold value.

Annotations
@Deprecated
See Also
setThreshold(Number)
getThresholdback to summary
public Number getThreshold(ObjectName object)

Gets the threshold value for the specified MBean.

Parameters
object:ObjectName

the MBean for which the threshold value is to be returned

Returns:Number

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

See Also
setThreshold
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
setInitThresholdback to summary
public void setInitThreshold(Number value) throws IllegalArgumentException

Sets the initial threshold value common to all observed MBeans.

Parameters
value:Number

The initial threshold value.

Exceptions
IllegalArgumentException:
The specified threshold is null or the threshold value is less than zero.
See Also
getInitThreshold
setModulusback to summary
public void setModulus(Number value) throws IllegalArgumentException

Sets the modulus value.

Parameters
value:Number

The modulus value.

Exceptions
IllegalArgumentException:
The specified modulus is null or the modulus value is less than zero.
See Also
getModulus
setNotifyback to summary
public void setNotify(boolean value)

Sets the notification's on/off switch value.

Parameters
value:boolean

The notification's on/off switch value.

See Also
getNotify
setOffsetback to summary
public void setOffset(Number value) throws IllegalArgumentException

Sets the offset value.

Parameters
value:Number

The offset value.

Exceptions
IllegalArgumentException:
The specified offset is null or the offset value is less than zero.
See Also
getOffset()
setThresholdback to summary
public void setThreshold(Number value) throws IllegalArgumentException

Deprecated

As of JMX 1.2, replaced by setInitThreshold

Sets the threshold value.

Parameters
value:Number

The threshold value.

Annotations
@Deprecated
Exceptions
IllegalArgumentException:
The specified threshold is null or the threshold value is less than zero.
See Also
getThreshold()