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 Notification

Provides definitions of the notifications sent by monitor MBeans.

The notification source and a set of parameters concerning the monitor MBean's state need to be specified when creating a new object of this class. The list of notifications fired by the monitor MBeans is the following:

• Common to all kind of monitors:
  • The observed object is not registered in the MBean server.
  • The observed attribute is not contained in the observed object.
  • The type of the observed attribute is not correct.
  • Any exception (except the cases described above) occurs when trying to get the value of the observed attribute.
• Common to the counter and the gauge monitors:
  • The threshold high or threshold low are not of the same type as the gauge (gauge monitors).
  • The threshold or the offset or the modulus are not of the same type as the counter (counter monitors).
• Counter monitors only:
  • The observed attribute has reached the threshold value.
• Gauge monitors only:
  • The observed attribute has exceeded the threshold high value.
  • The observed attribute has exceeded the threshold low value.
• String monitors only:
  • The observed attribute has matched the "string to compare" value.
  • The observed attribute has differed from the "string to compare" value.

Author:

Young Yang

See Also:

Serialized Form

Field Summary

static java.lang.String	OBSERVED_ATTRIBUTE_ERROR Notification type denoting that the observed attribute is not contained in the observed object.
static java.lang.String	OBSERVED_ATTRIBUTE_TYPE_ERROR Notification type denoting that the type of the observed attribute is not correct.
static java.lang.String	OBSERVED_OBJECT_ERROR Notification type denoting that the observed object is not registered in the MBean server.
static java.lang.String	RUNTIME_ERROR Notification type denoting that a non-predefined error type has occurred when trying to get the value of the observed attribute.
static java.lang.String	STRING_TO_COMPARE_VALUE_DIFFERED Notification type denoting that the observed attribute has differed from the "string to compare" value.
static java.lang.String	STRING_TO_COMPARE_VALUE_MATCHED Notification type denoting that the observed attribute has matched the "string to compare" value.
static java.lang.String	THRESHOLD_ERROR Notification type denoting that the type of the thresholds, offset or modulus is not correct.
static java.lang.String	THRESHOLD_HIGH_VALUE_EXCEEDED Notification type denoting that the observed attribute has exceeded the threshold high value.
static java.lang.String	THRESHOLD_LOW_VALUE_EXCEEDED Notification type denoting that the observed attribute has exceeded the threshold low value.
static java.lang.String	THRESHOLD_VALUE_EXCEEDED Notification type denoting that the observed attribute has reached the threshold value.

Fields inherited from class javax.management.Notification

source

Method Summary

java.lang.Object	getDerivedGauge() Gets the derived gauge of this monitor notification.
java.lang.String	getObservedAttribute() Gets the observed attribute of this monitor notification.
ObjectName	getObservedObject() Gets the observed object of this monitor notification.
java.lang.Object	getTrigger() Gets the threshold/string (depending on the monitor type) that triggered off this monitor notification.

Methods inherited from class javax.management.Notification

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

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Field Detail

OBSERVED_OBJECT_ERROR

public static final java.lang.String OBSERVED_OBJECT_ERROR

Notification type denoting that the observed object is not registered in the MBean server. This notification is fired by all kinds of monitors.
The value of this notification type is jmx.monitor.error.mbean.

OBSERVED_ATTRIBUTE_ERROR

public static final java.lang.String OBSERVED_ATTRIBUTE_ERROR

Notification type denoting that the observed attribute is not contained in the observed object. This notification is fired by all kinds of monitors.
The value of this notification type is jmx.monitor.error.attribute.

OBSERVED_ATTRIBUTE_TYPE_ERROR

public static final java.lang.String OBSERVED_ATTRIBUTE_TYPE_ERROR

Notification type denoting that the type of the observed attribute is not correct. This notification is fired by all kinds of monitors.
The value of this notification type is jmx.monitor.error.type.

THRESHOLD_ERROR

public static final java.lang.String THRESHOLD_ERROR

Notification type denoting that the type of the thresholds, offset or modulus is not correct. This notification is fired by counter and gauge monitors.
The value of this notification type is jmx.monitor.error.threshold.

RUNTIME_ERROR

public static final java.lang.String RUNTIME_ERROR

Notification type denoting that a non-predefined error type has occurred when trying to get the value of the observed attribute. This notification is fired by all kinds of monitors.
The value of this notification type is jmx.monitor.error.runtime.

THRESHOLD_VALUE_EXCEEDED

public static final java.lang.String THRESHOLD_VALUE_EXCEEDED

Notification type denoting that the observed attribute has reached the threshold value. This notification is only fired by counter monitors.
The value of this notification type is jmx.monitor.counter.threshold.

THRESHOLD_HIGH_VALUE_EXCEEDED

public static final java.lang.String THRESHOLD_HIGH_VALUE_EXCEEDED

Notification type denoting that the observed attribute has exceeded the threshold high value. This notification is only fired by gauge monitors.
The value of this notification type is jmx.monitor.gauge.high.

THRESHOLD_LOW_VALUE_EXCEEDED

public static final java.lang.String THRESHOLD_LOW_VALUE_EXCEEDED

Notification type denoting that the observed attribute has exceeded the threshold low value. This notification is only fired by gauge monitors.
The value of this notification type is jmx.monitor.gauge.low.

STRING_TO_COMPARE_VALUE_MATCHED

public static final java.lang.String STRING_TO_COMPARE_VALUE_MATCHED

Notification type denoting that the observed attribute has matched the "string to compare" value. This notification is only fired by string monitors.
The value of this notification type is jmx.monitor.string.matches.

STRING_TO_COMPARE_VALUE_DIFFERED

public static final java.lang.String STRING_TO_COMPARE_VALUE_DIFFERED

Notification type denoting that the observed attribute has differed from the "string to compare" value. This notification is only fired by string monitors.
The value of this notification type is jmx.monitor.string.differs.

Method Detail

getObservedObject

public ObjectName getObservedObject()

Gets the observed object of this monitor notification.

Returns:

The observed object.

getObservedAttribute

public java.lang.String getObservedAttribute()

Gets the observed attribute of this monitor notification.

Returns:

The observed attribute.

getDerivedGauge

public java.lang.Object getDerivedGauge()

Gets the derived gauge of this monitor notification.

Returns:

The derived gauge.

getTrigger

public java.lang.Object getTrigger()

Gets the threshold/string (depending on the monitor type) that triggered off this monitor notification.

Returns:

The trigger.