CounterMonitor

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management.monitor
Class CounterMonitor

java.lang.Object
  |
  +--javax.management.NotificationBroadcasterSupport
        |
        +--javax.management.monitor.Monitor
              |
              +--javax.management.monitor.CounterMonitor

All Implemented Interfaces:: CounterMonitorMBean, MBeanRegistration, MonitorMBean, NotificationBroadcaster

public class CounterMonitor
extends Monitor
implements MonitorMBean, CounterMonitorMBean

Defines a monitor MBean designed to observe the values of a counter attribute.

A counter monitor sends a threshold notification when the value of the counter reaches or exceeds a threshold known as the comparison level. The notify flag must be set to true.
In addition, an offset mechanism enables particular counting intervals to be detected.

If the offset value is not zero, whenever the threshold is triggered by the counter value reaching a comparison level, that comparison level is incremented by the offset value. This is regarded as taking place instantaneously, that is before the count is incremented. Thus, for each level, the threshold triggers an event notification every time the count increases by an interval equal to the offset value.

If the counter can wrap around its maximum value, the modulus needs to be specified. The modulus is the value at which the counter is reset to zero.

If the counter difference mode is used, the value of the derived gauge is calculated as the difference between the observed counter values for two successive observations. If this difference is negative, the value of the derived gauge is incremented by the value of the modulus.
The derived gauge value (V[t]) is calculated using the following method:

if (counter[t] - counter[t-GP]) is positive then V[t] = counter[t] - counter[t-GP]
if (counter[t] - counter[t-GP]) is negative then V[t] = counter[t] - counter[t-GP] + MODULUS

This implementation of the counter monitor requires the observed attribute to be of the type integer (Byte, Integer, Short, Long).

Author:: Young Yang

Constructor Summary

CounterMonitor()


Method Summary

protected void doMonitor(java.lang.Object value)


java.lang.Number getDerivedGauge()
          Gets the derived gauge.

long getDerivedGaugeTimeStamp()
          Gets the derived gauge timestamp.

boolean getDifferenceMode()
          Gets the difference mode flag value.

java.lang.Number getModulus()
          Gets the modulus value.

MBeanNotificationInfo[] getNotificationInfo()
          Returns a NotificationInfo object contaning the name of the Java class of the notification and the notification types sent.

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

java.lang.Number getOffset()
          Gets the offset value.

java.lang.Number getThreshold()
          Gets the threshold value.

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

void setModulus(java.lang.Number value)
          Sets the modulus value.

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

void setOffset(java.lang.Number value)
          Sets the offset value.

void setThreshold(java.lang.Number value)
          Sets the threshold value.

void start()


void stop()


Methods inherited from class javax.management.monitor.Monitor

_start, _stop, getGranularityPeriod, getObservedAttribute, getObservedObject, isActive, postDeregister, postRegister, preDeregister, preRegister, sendNotification, setGranularityPeriod, setObservedAttribute, setObservedObject

Methods inherited from class javax.management.NotificationBroadcasterSupport

addNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.management.monitor.MonitorMBean

getGranularityPeriod, getObservedAttribute, getObservedObject, isActive, setGranularityPeriod, setObservedAttribute, setObservedObject

Constructor Detail

CounterMonitor

public CounterMonitor()

Method Detail

start

public void start()

Specified by:: start in class Monitor

stop

public void stop()

Specified by:: stop in class Monitor