javax.management.monitor
Interface CounterMonitorMBean

All Superinterfaces:

MonitorMBean (src)

All Known Implementing Classes:

CounterMonitor (src)

public interface CounterMonitorMBean

extends MonitorMBean (src)

The counter monitor service MBean interface.

getDerivedGauge

public java.lang.Number getDerivedGauge()

Deprecated. use getDerivedGauge(ObjectName)

Retrieves the derived gauge.

Returns:

the derived gauge.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp()

Deprecated. use getDerivedGaugeTimeStamp(ObjectName)

Retrieves the derived gauge timestamp.

Returns:

the derived gauge timestamp.

getThreshold

public java.lang.Number getThreshold()

Deprecated. use getThreshold(ObjectName)

Retrieves the threshold.

Returns:

the threshold.

setThreshold

public void setThreshold(java.lang.Number value)
                  throws java.lang.IllegalArgumentException

Deprecated. use setInitThreshold(Number)

Sets the threshold.

Parameters:

value - the threshold value, pass zero for no threshold.

Throws:

java.lang.IllegalArgumentException - when the threshold is null or less than zero.

getDerivedGauge

public java.lang.Number getDerivedGauge(ObjectName (src)  name)

Retrieves the derived gauge.

Parameters:

name - the object name of the mbean.

Returns:

the derived gauge.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp(ObjectName (src)  name)

Retrieves the derived gauge timestamp.

Parameters:

name - the object name of the mbean.

Returns:

the derived gauge timestamp.

getThreshold

public java.lang.Number getThreshold(ObjectName (src)  name)

Retrieves the threshold.

Parameters:

name - the object name of the mbean.

Returns:

the threshold.

getInitThreshold

public java.lang.Number getInitThreshold()

Retrieves the initial threshold.

Returns:

the initial threshold.

setInitThreshold

public void setInitThreshold(java.lang.Number value)
                      throws java.lang.IllegalArgumentException

Sets the initial threshold.

Parameters:

value - the initial threshold.

Throws:

java.lang.IllegalArgumentException

getOffset

public java.lang.Number getOffset()

Retrieves the offset.

Returns:

the offset value, zero means no offset.

setOffset

public void setOffset(java.lang.Number value)
               throws java.lang.IllegalArgumentException

Sets the offset.

Parameters:

value - the offset value, pass zero for no offset.

Throws:

java.lang.IllegalArgumentException - when the offset is null or less than zero.

getModulus

public java.lang.Number getModulus()

Retrieves the modulus.

Returns:

the modulus value, zero means no modulus.

setModulus

public void setModulus(java.lang.Number value)
                throws java.lang.IllegalArgumentException

Sets the modulus.

Parameters:

value - the modulus value, pass zero for no modulus.

Throws:

java.lang.IllegalArgumentException - when the modulus is null or less than zero.

getNotify

public boolean getNotify()

Retrieves the notify on/off switch.

Returns:

true if notifications occur, false otherwise.

setNotify

public void setNotify(boolean value)

Sets the notify on/off switch.

Parameters:

value - pass true notifications, false otherwise.

getDifferenceMode

public boolean getDifferenceMode()

Retrieves the difference mode flag.

Returns:

true when in difference mode, false otherwise.

setDifferenceMode

public void setDifferenceMode(boolean value)

Sets the difference mode flag.

Parameters:

value - pass true for difference mode, false otherwise.