OpenJDK 1.22 · javax.management.monitor.MonitorNotification

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.

Field Summary

Modifier and Type	Field and Description
private Object	derivedGauge
public static final String	OBSERVED_ATTRIBUTE_ERROR Notification type denoting that the observed attribute is not contained in the observed object.
public static final String	OBSERVED_ATTRIBUTE_TYPE_ERROR Notification type denoting that the type of the observed attribute is not correct.
public static final String	OBSERVED_OBJECT_ERROR Notification type denoting that the observed object is not registered in the MBean server.
private String	observedAttribute
private ObjectName	observedObject
public static final String	RUNTIME_ERROR Notification type denoting that a non-predefined error type has occurred when trying to get the value of the observed attribute.
private static final long	serialVersionUID Hides javax.management.Notification.serialVersionUID.
public static final String	STRING_TO_COMPARE_VALUE_DIFFERED Notification type denoting that the observed attribute has differed from the "string to compare" value.
public static final String	STRING_TO_COMPARE_VALUE_MATCHED Notification type denoting that the observed attribute has matched the "string to compare" value.
public static final String	THRESHOLD_ERROR Notification type denoting that the type of the thresholds, offset or modulus is not correct.
public static final String	THRESHOLD_HIGH_VALUE_EXCEEDED Notification type denoting that the observed attribute has exceeded the threshold high value.
public static final String	THRESHOLD_LOW_VALUE_EXCEEDED Notification type denoting that the observed attribute has exceeded the threshold low value.
public static final String	THRESHOLD_VALUE_EXCEEDED Notification type denoting that the observed attribute has reached the threshold value.
private Object	trigger

Inherited from javax.management.Notification:: source

Access	Constructor and Description
pack-priv	MonitorNotification(String The notification type. type, Object The notification producer. source, long The notification sequence number within the source object. sequenceNumber, long The notification emission date. timeStamp, String The notification message. msg, ObjectName The object observed by the producer of this notification. obsObj, String The attribute observed by the producer of this notification. obsAtt, Object The derived gauge. derGauge, Object The threshold/string (depending on the monitor type) that triggered the notification. trigger) Creates a monitor notification object.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: The derived gauge. getDerivedGauge() Gets the derived gauge of this monitor notification.
public String	Returns: The observed attribute. getObservedAttribute() Gets the observed attribute of this monitor notification.
public ObjectName	Returns: The observed object. getObservedObject() Gets the observed object of this monitor notification.
public Object	Returns: The trigger. getTrigger() Gets the threshold/string (depending on the monitor type) that triggered off this monitor notification.

Inherited from javax.management.Notification:: getMessage getSequenceNumber getTimeStamp getType getUserData setSequenceNumber setSource setTimeStamp setUserData toString

Field Detail

derivedGauge	back to summary
private Object derivedGauge Annotations @SuppressWarnings:serial

OBSERVED_ATTRIBUTE_ERROR	back to summary
public static final 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	back to summary
public static final 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`.

OBSERVED_OBJECT_ERROR	back to summary
public static final 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`.

observedAttribute	back to summary
private String observedAttribute

observedObject	back to summary
private ObjectName observedObject Annotations @SuppressWarnings:serial

RUNTIME_ERROR	back to summary
public static final 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`.

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.management.Notification.serialVersionUID.

STRING_TO_COMPARE_VALUE_DIFFERED	back to summary
public static final 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`.

STRING_TO_COMPARE_VALUE_MATCHED	back to summary
public static final 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`.

THRESHOLD_ERROR	back to summary
public static final 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`.

THRESHOLD_HIGH_VALUE_EXCEEDED	back to summary
public static final 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	back to summary
public static final 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`.

THRESHOLD_VALUE_EXCEEDED	back to summary
public static final 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`.

trigger	back to summary
private Object trigger Annotations @SuppressWarnings:serial

Constructor Detail

MonitorNotification	back to summary
pack-priv MonitorNotification(String type, Object source, long sequenceNumber, long timeStamp, String msg, ObjectName obsObj, String obsAtt, Object derGauge, Object trigger) Creates a monitor notification object. Parameters type:String The notification type. source:Object The notification producer. sequenceNumber:long The notification sequence number within the source object. timeStamp:long The notification emission date. msg:String The notification message. obsObj:ObjectName The object observed by the producer of this notification. obsAtt:String The attribute observed by the producer of this notification. derGauge:Object The derived gauge. trigger:Object The threshold/string (depending on the monitor type) that triggered the notification.

MonitorNotification

back to summary

pack-priv MonitorNotification(String type, Object source, long sequenceNumber, long timeStamp, String msg, ObjectName obsObj, String obsAtt, Object derGauge, Object trigger)

Creates a monitor notification object.

Parameters

type:String: The notification type.
source:Object: The notification producer.
sequenceNumber:long: The notification sequence number within the source object.
timeStamp:long: The notification emission date.
msg:String: The notification message.
obsObj:ObjectName: The object observed by the producer of this notification.
obsAtt:String: The attribute observed by the producer of this notification.
derGauge:Object: The derived gauge.
trigger:Object: The threshold/string (depending on the monitor type) that triggered the notification.

Method Detail

getDerivedGauge	back to summary
public Object getDerivedGauge() Gets the derived gauge of this monitor notification. Returns:Object The derived gauge.

getDerivedGauge

back to summary

public Object getDerivedGauge()

Gets the derived gauge of this monitor notification.

Returns:Object: The derived gauge.

getObservedAttribute	back to summary
public String getObservedAttribute() Gets the observed attribute of this monitor notification. Returns:String The observed attribute.

getObservedAttribute

back to summary

public String getObservedAttribute()

Gets the observed attribute of this monitor notification.

Returns:String: The observed attribute.

getObservedObject	back to summary
public ObjectName getObservedObject() Gets the observed object of this monitor notification. Returns:ObjectName The observed object.

getObservedObject

back to summary

public ObjectName getObservedObject()

Gets the observed object of this monitor notification.

Returns:ObjectName: The observed object.

getTrigger	back to summary
public Object getTrigger() Gets the threshold/string (depending on the monitor type) that triggered off this monitor notification. Returns:Object The trigger.

getTrigger

back to summary

public Object getTrigger()

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

Returns:Object: The trigger.

public Class MonitorNotification

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail