MonitorNotification

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> javax >> management >> [ monitor overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of javax.management.monitor.MonitorNotification

SOURCE |

Download javax.management.monitor.MonitorNotification

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management.monitor
Class MonitorNotification

java.lang.Object
  java.util.EventObject
      javax.management.Notification
          javax.management.monitor.MonitorNotification

All Implemented Interfaces:: java.io.Serializable

public class MonitorNotification
extends javax.management.Notification
implements java.io.Serializable

A notification from one of the monitor services.

The notification occurs only when the state is first entered.

All monitor services produce the following notifications.

OBSERVED_OBJECT_ERROR 55 when the MBean is not registered.
OBSERVED_ATTRIBUTE_ERROR 55 when the MBean's attribute does not exist.
OBSERVED_ATTRIBUTE_TYPE_ERROR 55 when the MBean's attribute is not of the correct type for the monitor or the derived gauge value.
RUNTIME_ERROR 55 for any other error.

The counter monitor produces the following notifications.

THRESHOLD_ERROR 55 when one of the monitors threshold vaues is of an incorrect type.
THRESHOLD_VALUE_EXCEEDED 55 when the counter exceeds the threshold.

The gauge monitor produces the following notifications.

THRESHOLD_ERROR 55 when one of the monitors threshold vaues is of an incorrect type.
THRESHOLD_HIGH_VALUE_EXCEEDED 55 when the attribute exceeds the high threshold value.
THRESHOLD_LOW_VALUE_EXCEEDED 55 when the attribute exceeds the low threshold value.

The string monitor produces the following notifications.

STRING_TO_COMPARE_VALUE_DIFFERED 55 when the attribute no longer matches the specified value.
STRING_TO_COMPARE_VALUE_DIFFERED 55 when the attribute matches the specified value.

Version:

$Revision: 1.1.8.1 $

Revisions:

20020816 Adrian Brock:

Serialization

Field Summary

private java.lang.Object derivedGauge
          The derived gauge.

static java.lang.String OBSERVED_ATTRIBUTE_ERROR
          Notification type when an MBean doesn't contain the specified attribute.

static java.lang.String OBSERVED_ATTRIBUTE_TYPE_ERROR
          Notification type when an attribute is null or the attribute has an incorrect type for the monitor service.

static java.lang.String OBSERVED_OBJECT_ERROR
          Notification type when an MBean is not registered.

private java.lang.String observedAttribute
          The observed attribute.

private javax.management.ObjectName observedObject
          The observed object.

static java.lang.String RUNTIME_ERROR
          Notification type for any other error.

private static long serialVersionUID


static java.lang.String STRING_TO_COMPARE_VALUE_DIFFERED
          Notification type when an attribute no longer matches the specified value of a StringMonitor.

static java.lang.String STRING_TO_COMPARE_VALUE_MATCHED
          Notification type when an attribute changes to match the specified value of a StringMonitor.

static java.lang.String THRESHOLD_ERROR
          Notification type when an attribute's threshold parameters (threshold, low threshold, high threshold, offset or modules) are not of the correct type.

static java.lang.String THRESHOLD_HIGH_VALUE_EXCEEDED
          Notification type when a guage attribute changes to exceed the specified threshold high value.

static java.lang.String THRESHOLD_LOW_VALUE_EXCEEDED
          Notification type when a gauge attribute changes to exceed the specified threshold low value.

static java.lang.String THRESHOLD_VALUE_EXCEEDED
          Notification type when a counter attribute changes to exceed the specified threshold value.

private java.lang.Object trigger
          The trigger of the notification.

Fields inherited from class javax.management.Notification

Fields inherited from class java.util.EventObject

source

Constructor Summary

(package private) MonitorNotification(java.lang.String type, java.lang.Object source, long sequenceNumber, long timeStamp, java.lang.String message, java.lang.Object derivedGauge, java.lang.String observedAttribute, javax.management.ObjectName observedObject, java.lang.Object trigger)
          Construct a new monitor notification.

Method Summary

java.lang.Object getDerivedGauge()
          Retrieves the derived gauge.

java.lang.String getObservedAttribute()
          Retrieves the name of the attribute monitored.

javax.management.ObjectName getObservedObject()
          Retrieves the name of the MBean monitored.

java.lang.Object getTrigger()
          Retrieves the trigger value of the notification.

java.lang.String toString()
          Converts the event to a String.

Methods inherited from class javax.management.Notification

getMessage, getSequenceNumber, getSource, getTimeStamp, getType, getUserData, setSequenceNumber, setSource, setTimeStamp, setUserData

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:: Constant Field Values

OBSERVED_ATTRIBUTE_ERROR

public static final java.lang.String OBSERVED_ATTRIBUTE_ERROR

Notification type when an MBean doesn't contain the specified attribute. The observed object name and observed attribute name are sent in the notification.

See Also:: Constant Field Values

OBSERVED_ATTRIBUTE_TYPE_ERROR

public static final java.lang.String OBSERVED_ATTRIBUTE_TYPE_ERROR

Notification type when an attribute is null or the attribute has an incorrect type for the monitor service. The observed object name and observed attribute name are sent in the notification.

See Also:: Constant Field Values

OBSERVED_OBJECT_ERROR

public static final java.lang.String OBSERVED_OBJECT_ERROR

Notification type when an MBean is not registered. The observed object name is sent in the notification.

See Also:: Constant Field Values

RUNTIME_ERROR

public static final java.lang.String RUNTIME_ERROR

Notification type for any other error.

See Also:: Constant Field Values

STRING_TO_COMPARE_VALUE_DIFFERED

public static final java.lang.String STRING_TO_COMPARE_VALUE_DIFFERED

Notification type when an attribute no longer matches the specified value of a StringMonitor. The observed object name, observed attribute name, derived gauge (actual value) and trigger (monitor value) are sent in the notification. REVIEW: Verify this.

See Also:: Constant Field Values

STRING_TO_COMPARE_VALUE_MATCHED

public static final java.lang.String STRING_TO_COMPARE_VALUE_MATCHED

Notification type when an attribute changes to match the specified value of a StringMonitor. The observed object name, observed attribute name, derived gauge (actual value) and trigger (monitor value) are sent in the notification. REVIEW: Verify this.

See Also:: Constant Field Values

THRESHOLD_ERROR

public static final java.lang.String THRESHOLD_ERROR

Notification type when an attribute's threshold parameters (threshold, low threshold, high threshold, offset or modules) are not of the correct type. The observed object name and observed attribute are sent in the notification. REVIEW: Verify this.

See Also:: Constant Field Values

THRESHOLD_VALUE_EXCEEDED

public static final java.lang.String THRESHOLD_VALUE_EXCEEDED

Notification type when a counter attribute changes to exceed the specified threshold value. The observed object name, observed attribute name, derived gauge (actual value) and trigger (threshold value) are sent in the notification. REVIEW: Verify this.

See Also:: Constant Field Values

THRESHOLD_HIGH_VALUE_EXCEEDED

public static final java.lang.String THRESHOLD_HIGH_VALUE_EXCEEDED

Notification type when a guage attribute changes to exceed the specified threshold high value. The observed object name, observed attribute name, derived gauge (actual value) and trigger (threshold value) are sent in the notification. REVIEW: Verify this.

See Also:: Constant Field Values

THRESHOLD_LOW_VALUE_EXCEEDED

public static final java.lang.String THRESHOLD_LOW_VALUE_EXCEEDED

Notification type when a gauge attribute changes to exceed the specified threshold low value. The observed object name, observed attribute name, derived gauge (actual value) and trigger (threshold value) are sent in the notification. REVIEW: Verify this.

See Also:: Constant Field Values

derivedGauge

private java.lang.Object derivedGauge

The derived gauge.

observedAttribute

private java.lang.String observedAttribute

The observed attribute.

observedObject

private javax.management.ObjectName observedObject

The observed object.

trigger

private java.lang.Object trigger

The trigger of the notification.

Constructor Detail