javax.management.monitor
Interface CounterMonitorMBean

All Known Implementing Classes:

CounterMonitor

public interface CounterMonitorMBean

extends MonitorMBean

This exposes the remote management interface of the counter 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 difference mode flag value.
java.lang.Number	getInitThreshold() This method gets the initial threshold value common to all observed objects.
java.lang.Number	getModulus() This method gets the modulus value.
boolean	getNotify() This method gets the notification's on/off switch value.
java.lang.Number	getOffset() This method gets offset value .
java.lang.Number	getThreshold() Deprecated. Replaced by getThreshold(ObjectName)
java.lang.Number	getThreshold(ObjectName object) This method gets the threshold value for the specified MBean.
void	setDifferenceMode(boolean value) This method sets the difference mode flag value.
void	setInitThreshold(java.lang.Number value) This method sets the initial threshold value common to all observed MBeans.
void	setModulus(java.lang.Number value) This method sets the modulus value.
void	setNotify(boolean value) This method sets the notification's on/off switch value.
void	setOffset(java.lang.Number value) This method gets the offset value.
void	setThreshold(java.lang.Number value) Deprecated. Replaced by setInitThreshold(java.lang.Number)

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.

Returns:

The value of the derived gauge as an instance of java.lang.Number.

getDerivedGaugeTimeStamp

public long getDerivedGaugeTimeStamp()

Deprecated. Replaced by getDerivedGaugeTimeStamp(ObjectName)

This method gets the value of the derived gauge timestamp.It is the time when the notification is triggered nearest to the milliseconds.

Returns:

The value of the derived gauge timestamp.

getThreshold

public java.lang.Number getThreshold()

Deprecated. Replaced by getThreshold(ObjectName)

This method gets the threshold value.

Returns:

The threshold value as an instance of java.lang.Number.

setThreshold

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

Deprecated. Replaced by setInitThreshold(java.lang.Number)

This method sets the threshold value.

Parameters:

value - The Threshold Value.

Throws:

java.lang.IllegalArgumentException - The specified threshold is null or the threshold value is less than zero.

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.

getThreshold

public java.lang.Number getThreshold(ObjectName object)

This method gets the threshold value for the specified MBean.

Parameters:

object - the MBean for which the threashold value is to be returned

Returns:

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

See Also:

setThreshold(java.lang.Number)

getInitThreshold

public java.lang.Number getInitThreshold()

This method gets the initial threshold value common to all observed objects.

Returns:

The initial threshold value.

See Also:

setInitThreshold(java.lang.Number)

setInitThreshold

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

This method sets the initial threshold value common to all observed MBeans.

Parameters:

value - The initial threshold value.

Throws:

java.lang.IllegalArgumentException - The specified threshold is null or the threshold value is less than zero.

See Also:

getInitThreshold()

getDifferenceMode

public boolean getDifferenceMode()

This method gets the difference mode flag value.

Returns:

true if the flag is on , false otherwise.

setDifferenceMode

public void setDifferenceMode(boolean value)

This method sets the difference mode flag value.

Parameters:

true - if the difference mode is used, false otherwise.

getModulus

public java.lang.Number getModulus()

This method gets the modulus value.

Returns:

An instance of java.lang.Number giving the modulus value.

setModulus

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

This method sets the modulus value.

Parameters:

value - An instance of java.lang.Number which is the modulus value.

Throws:

java.lang.IllegalArgumentException - - The specified modulus is null or the modulus value is less than zero.

getNotify

public boolean getNotify()

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

Returns:

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

setNotify

public void setNotify(boolean value)

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

Parameters:

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

getOffset

public java.lang.Number getOffset()

This method gets offset value .

Returns:

An instance of java.lang.Number giving the offset value.

See Also:

setOffset(Number)

setOffset

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

This method gets the offset value.

Parameters:

value - The offset value.

Throws:

java.lang.IllegalArgumentException - The specified offset is null or the offset value is less than zero.

See Also:

getOffset()