javax.management.monitor
Interface CounterMonitorMBean

All Superinterfaces:
MonitorMBean sample code for javax.management.monitor.MonitorMBean definition code for javax.management.monitor.MonitorMBean
All Known Implementing Classes:
CounterMonitor sample code for javax.management.monitor.CounterMonitor definition code for javax.management.monitor.CounterMonitor

public interface CounterMonitorMBean
extends MonitorMBean sample code for javax.management.monitor.MonitorMBean definition code for javax.management.monitor.MonitorMBean

Exposes the remote management interface of the counter monitor MBean.

Since:
1.5

Method Summary
 Number sample code for java.lang.Number definition code for java.lang.Number getDerivedGauge sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge() definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge() ()
          Deprecated. As of JMX 1.2, replaced by getDerivedGauge(ObjectName) sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge(javax.management.ObjectName)
 Number sample code for java.lang.Number definition code for java.lang.Number getDerivedGauge sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge(javax.management.ObjectName) (ObjectName sample code for javax.management.ObjectName definition code for javax.management.ObjectName  object)
          Gets the derived gauge for the specified MBean.
 long getDerivedGaugeTimeStamp sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp() definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp() ()
          Deprecated. As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName) sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp(javax.management.ObjectName)
 long getDerivedGaugeTimeStamp sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp(javax.management.ObjectName) (ObjectName sample code for javax.management.ObjectName definition code for javax.management.ObjectName  object)
          Gets the derived gauge timestamp for the specified MBean.
 boolean getDifferenceMode sample code for javax.management.monitor.CounterMonitorMBean.getDifferenceMode() definition code for javax.management.monitor.CounterMonitorMBean.getDifferenceMode() ()
          Gets the difference mode flag value.
 Number sample code for java.lang.Number definition code for java.lang.Number getInitThreshold sample code for javax.management.monitor.CounterMonitorMBean.getInitThreshold() definition code for javax.management.monitor.CounterMonitorMBean.getInitThreshold() ()
          Gets the initial threshold value common to all observed objects.
 Number sample code for java.lang.Number definition code for java.lang.Number getModulus sample code for javax.management.monitor.CounterMonitorMBean.getModulus() definition code for javax.management.monitor.CounterMonitorMBean.getModulus() ()
          Gets the modulus value.
 boolean getNotify sample code for javax.management.monitor.CounterMonitorMBean.getNotify() definition code for javax.management.monitor.CounterMonitorMBean.getNotify() ()
          Gets the notification's on/off switch value.
 Number sample code for java.lang.Number definition code for java.lang.Number getOffset sample code for javax.management.monitor.CounterMonitorMBean.getOffset() definition code for javax.management.monitor.CounterMonitorMBean.getOffset() ()
          Gets the offset value.
 Number sample code for java.lang.Number definition code for java.lang.Number getThreshold sample code for javax.management.monitor.CounterMonitorMBean.getThreshold() definition code for javax.management.monitor.CounterMonitorMBean.getThreshold() ()
          Deprecated. As of JMX 1.2, replaced by getThreshold(ObjectName) sample code for javax.management.monitor.CounterMonitorMBean.getThreshold(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getThreshold(javax.management.ObjectName)
 Number sample code for java.lang.Number definition code for java.lang.Number getThreshold sample code for javax.management.monitor.CounterMonitorMBean.getThreshold(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getThreshold(javax.management.ObjectName) (ObjectName sample code for javax.management.ObjectName definition code for javax.management.ObjectName  object)
          Gets the threshold value for the specified MBean.
 void setDifferenceMode sample code for javax.management.monitor.CounterMonitorMBean.setDifferenceMode(boolean) definition code for javax.management.monitor.CounterMonitorMBean.setDifferenceMode(boolean) (boolean value)
          Sets the difference mode flag value.
 void setInitThreshold sample code for javax.management.monitor.CounterMonitorMBean.setInitThreshold(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setInitThreshold(java.lang.Number) (Number sample code for java.lang.Number definition code for java.lang.Number  value)
          Sets the initial threshold value common to all observed MBeans.
 void setModulus sample code for javax.management.monitor.CounterMonitorMBean.setModulus(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setModulus(java.lang.Number) (Number sample code for java.lang.Number definition code for java.lang.Number  value)
          Sets the modulus value.
 void setNotify sample code for javax.management.monitor.CounterMonitorMBean.setNotify(boolean) definition code for javax.management.monitor.CounterMonitorMBean.setNotify(boolean) (boolean value)
          Sets the notification's on/off switch value.
 void setOffset sample code for javax.management.monitor.CounterMonitorMBean.setOffset(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setOffset(java.lang.Number) (Number sample code for java.lang.Number definition code for java.lang.Number  value)
          Sets the offset value.
 void setThreshold sample code for javax.management.monitor.CounterMonitorMBean.setThreshold(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setThreshold(java.lang.Number) (Number sample code for java.lang.Number definition code for java.lang.Number  value)
          Deprecated. As of JMX 1.2, replaced by setInitThreshold(java.lang.Number) sample code for javax.management.monitor.CounterMonitorMBean.setInitThreshold(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setInitThreshold(java.lang.Number)
 
Methods inherited from interface javax.management.monitor.MonitorMBean sample code for javax.management.monitor.MonitorMBean definition code for javax.management.monitor.MonitorMBean
addObservedObject sample code for javax.management.monitor.MonitorMBean.addObservedObject(javax.management.ObjectName) definition code for javax.management.monitor.MonitorMBean.addObservedObject(javax.management.ObjectName) , containsObservedObject sample code for javax.management.monitor.MonitorMBean.containsObservedObject(javax.management.ObjectName) definition code for javax.management.monitor.MonitorMBean.containsObservedObject(javax.management.ObjectName) , getGranularityPeriod sample code for javax.management.monitor.MonitorMBean.getGranularityPeriod() definition code for javax.management.monitor.MonitorMBean.getGranularityPeriod() , getObservedAttribute sample code for javax.management.monitor.MonitorMBean.getObservedAttribute() definition code for javax.management.monitor.MonitorMBean.getObservedAttribute() , getObservedObject sample code for javax.management.monitor.MonitorMBean.getObservedObject() definition code for javax.management.monitor.MonitorMBean.getObservedObject() , getObservedObjects sample code for javax.management.monitor.MonitorMBean.getObservedObjects() definition code for javax.management.monitor.MonitorMBean.getObservedObjects() , isActive sample code for javax.management.monitor.MonitorMBean.isActive() definition code for javax.management.monitor.MonitorMBean.isActive() , removeObservedObject sample code for javax.management.monitor.MonitorMBean.removeObservedObject(javax.management.ObjectName) definition code for javax.management.monitor.MonitorMBean.removeObservedObject(javax.management.ObjectName) , setGranularityPeriod sample code for javax.management.monitor.MonitorMBean.setGranularityPeriod(long) definition code for javax.management.monitor.MonitorMBean.setGranularityPeriod(long) , setObservedAttribute sample code for javax.management.monitor.MonitorMBean.setObservedAttribute(java.lang.String) definition code for javax.management.monitor.MonitorMBean.setObservedAttribute(java.lang.String) , setObservedObject sample code for javax.management.monitor.MonitorMBean.setObservedObject(javax.management.ObjectName) definition code for javax.management.monitor.MonitorMBean.setObservedObject(javax.management.ObjectName) , start sample code for javax.management.monitor.MonitorMBean.start() definition code for javax.management.monitor.MonitorMBean.start() , stop sample code for javax.management.monitor.MonitorMBean.stop() definition code for javax.management.monitor.MonitorMBean.stop()
 

Method Detail

getDerivedGauge sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge() definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge()

@Deprecated
Number sample code for java.lang.Number definition code for java.lang.Number  getDerivedGauge()
Deprecated. As of JMX 1.2, replaced by getDerivedGauge(ObjectName) sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge(javax.management.ObjectName)

Gets the derived gauge.

Returns:
The derived gauge.

getDerivedGaugeTimeStamp sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp() definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp()

@Deprecated
long getDerivedGaugeTimeStamp()
Deprecated. As of JMX 1.2, replaced by getDerivedGaugeTimeStamp(ObjectName) sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp(javax.management.ObjectName)

Gets the derived gauge timestamp.

Returns:
The derived gauge timestamp.

getThreshold sample code for javax.management.monitor.CounterMonitorMBean.getThreshold() definition code for javax.management.monitor.CounterMonitorMBean.getThreshold()

@Deprecated
Number sample code for java.lang.Number definition code for java.lang.Number  getThreshold()
Deprecated. As of JMX 1.2, replaced by getThreshold(ObjectName) sample code for javax.management.monitor.CounterMonitorMBean.getThreshold(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getThreshold(javax.management.ObjectName)

Gets the threshold value.

Returns:
The threshold value.
See Also:
setThreshold(Number) sample code for javax.management.monitor.CounterMonitorMBean.setThreshold(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setThreshold(java.lang.Number)

setThreshold sample code for javax.management.monitor.CounterMonitorMBean.setThreshold(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setThreshold(java.lang.Number)

@Deprecated
void setThreshold(Number sample code for java.lang.Number definition code for java.lang.Number  value)
                  throws IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException 
Deprecated. As of JMX 1.2, replaced by setInitThreshold(java.lang.Number) sample code for javax.management.monitor.CounterMonitorMBean.setInitThreshold(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setInitThreshold(java.lang.Number)

Sets the threshold value.

Parameters:
value - The threshold value.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - The specified threshold is null or the threshold value is less than zero.
See Also:
getThreshold() sample code for javax.management.monitor.CounterMonitorMBean.getThreshold() definition code for javax.management.monitor.CounterMonitorMBean.getThreshold()

getDerivedGauge sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGauge(javax.management.ObjectName)

Number sample code for java.lang.Number definition code for java.lang.Number  getDerivedGauge(ObjectName sample code for javax.management.ObjectName definition code for javax.management.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 sample code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getDerivedGaugeTimeStamp(javax.management.ObjectName)

long getDerivedGaugeTimeStamp(ObjectName sample code for javax.management.ObjectName definition code for javax.management.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.

getThreshold sample code for javax.management.monitor.CounterMonitorMBean.getThreshold(javax.management.ObjectName) definition code for javax.management.monitor.CounterMonitorMBean.getThreshold(javax.management.ObjectName)

Number sample code for java.lang.Number definition code for java.lang.Number  getThreshold(ObjectName sample code for javax.management.ObjectName definition code for javax.management.ObjectName  object)
Gets the threshold value for the specified MBean.

Parameters:
object - the MBean for which the threshold 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) sample code for javax.management.monitor.CounterMonitorMBean.setThreshold(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setThreshold(java.lang.Number)

getInitThreshold sample code for javax.management.monitor.CounterMonitorMBean.getInitThreshold() definition code for javax.management.monitor.CounterMonitorMBean.getInitThreshold()

Number sample code for java.lang.Number definition code for java.lang.Number  getInitThreshold()
Gets the initial threshold value common to all observed objects.

Returns:
The initial threshold value.
See Also:
setInitThreshold(java.lang.Number) sample code for javax.management.monitor.CounterMonitorMBean.setInitThreshold(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setInitThreshold(java.lang.Number)

setInitThreshold sample code for javax.management.monitor.CounterMonitorMBean.setInitThreshold(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setInitThreshold(java.lang.Number)

void setInitThreshold(Number sample code for java.lang.Number definition code for java.lang.Number  value)
                      throws IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException 
Sets the initial threshold value common to all observed MBeans.

Parameters:
value - The initial threshold value.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - The specified threshold is null or the threshold value is less than zero.
See Also:
getInitThreshold() sample code for javax.management.monitor.CounterMonitorMBean.getInitThreshold() definition code for javax.management.monitor.CounterMonitorMBean.getInitThreshold()

getOffset sample code for javax.management.monitor.CounterMonitorMBean.getOffset() definition code for javax.management.monitor.CounterMonitorMBean.getOffset()

Number sample code for java.lang.Number definition code for java.lang.Number  getOffset()
Gets the offset value.

Returns:
The offset value.
See Also:
setOffset(Number) sample code for javax.management.monitor.CounterMonitorMBean.setOffset(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setOffset(java.lang.Number)

setOffset sample code for javax.management.monitor.CounterMonitorMBean.setOffset(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setOffset(java.lang.Number)

void setOffset(Number sample code for java.lang.Number definition code for java.lang.Number  value)
               throws IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException 
Sets the offset value.

Parameters:
value - The offset value.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - The specified offset is null or the offset value is less than zero.
See Also:
getOffset() sample code for javax.management.monitor.CounterMonitorMBean.getOffset() definition code for javax.management.monitor.CounterMonitorMBean.getOffset()

getModulus sample code for javax.management.monitor.CounterMonitorMBean.getModulus() definition code for javax.management.monitor.CounterMonitorMBean.getModulus()

Number sample code for java.lang.Number definition code for java.lang.Number  getModulus()
Gets the modulus value.

Returns:
The modulus value.
See Also:
setModulus(java.lang.Number) sample code for javax.management.monitor.CounterMonitorMBean.setModulus(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setModulus(java.lang.Number)

setModulus sample code for javax.management.monitor.CounterMonitorMBean.setModulus(java.lang.Number) definition code for javax.management.monitor.CounterMonitorMBean.setModulus(java.lang.Number)

void setModulus(Number sample code for java.lang.Number definition code for java.lang.Number  value)
                throws IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException 
Sets the modulus value.

Parameters:
value - The modulus value.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - The specified modulus is null or the modulus value is less than zero.
See Also:
getModulus() sample code for javax.management.monitor.CounterMonitorMBean.getModulus() definition code for javax.management.monitor.CounterMonitorMBean.getModulus()

getNotify sample code for javax.management.monitor.CounterMonitorMBean.getNotify() definition code for javax.management.monitor.CounterMonitorMBean.getNotify()

boolean getNotify()
Gets the notification's on/off switch value.

Returns:
true if the counter monitor notifies when exceeding the threshold, false otherwise.
See Also:
setNotify(boolean) sample code for javax.management.monitor.CounterMonitorMBean.setNotify(boolean) definition code for javax.management.monitor.CounterMonitorMBean.setNotify(boolean)

setNotify sample code for javax.management.monitor.CounterMonitorMBean.setNotify(boolean) definition code for javax.management.monitor.CounterMonitorMBean.setNotify(boolean)

void setNotify(boolean value)
Sets the notification's on/off switch value.

Parameters:
value - The notification's on/off switch value.
See Also:
getNotify() sample code for javax.management.monitor.CounterMonitorMBean.getNotify() definition code for javax.management.monitor.CounterMonitorMBean.getNotify()

getDifferenceMode sample code for javax.management.monitor.CounterMonitorMBean.getDifferenceMode() definition code for javax.management.monitor.CounterMonitorMBean.getDifferenceMode()

boolean getDifferenceMode()
Gets the difference mode flag value.

Returns:
true if the difference mode is used, false otherwise.
See Also:
setDifferenceMode(boolean) sample code for javax.management.monitor.CounterMonitorMBean.setDifferenceMode(boolean) definition code for javax.management.monitor.CounterMonitorMBean.setDifferenceMode(boolean)

setDifferenceMode sample code for javax.management.monitor.CounterMonitorMBean.setDifferenceMode(boolean) definition code for javax.management.monitor.CounterMonitorMBean.setDifferenceMode(boolean)

void setDifferenceMode(boolean value)
Sets the difference mode flag value.

Parameters:
value - The difference mode flag value.
See Also:
getDifferenceMode() sample code for javax.management.monitor.CounterMonitorMBean.getDifferenceMode() definition code for javax.management.monitor.CounterMonitorMBean.getDifferenceMode()