File Doc Category Size Date Package
MonitorNotification.java API Doc Java SE 5 API 8885 Fri Aug 26 14:57:36 BST 2005 javax.management.monitor

MonitorNotification

java.lang.Object
- java.util.EventObject
  - javax.management.Notification

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.

version: 4.22 12/19/03
author: Sun Microsystems, Inc
since: 1.5

Fields 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
private static final long
serialVersionUID
private ObjectName
observedObject
private String
observedAttribute
private Object
derivedGauge
private Object
trigger
Constructors Summary
MonitorNotification(String type, Object source, long sequenceNumber, long timeStamp, String msg, ObjectName obsObj, String obsAtt, Object derGauge, Object trigger)
Creates a monitor notification object.
param
type The notification type.
param
source The notification producer.
param
sequenceNumber The notification sequence number within the source object.
param
timeStamp The notification emission date.
param
msg The notification message.
param
obsObj The object observed by the producer of this notification.
param
obsAtt The attribute observed by the producer of this notification.
param
derGauge The derived gauge.
param
trigger The threshold/string (depending on the monitor type) that triggered the notification.
/* * ------------------------------------------ * CONSTRUCTORS * ------------------------------------------ */ super(type, source, sequenceNumber, timeStamp, msg); this.observedObject = obsObj; this.observedAttribute = obsAtt; this.derivedGauge = derGauge; this.trigger = trigger;
Methods Summary
public java.lang.Object getDerivedGauge()
Gets the derived gauge of this monitor notification.
return
The derived gauge.
return derivedGauge;
public java.lang.String getObservedAttribute()
Gets the observed attribute of this monitor notification.
return
The observed attribute.
return observedAttribute;
public javax.management.ObjectName getObservedObject()
Gets the observed object of this monitor notification.
return
The observed object.
return observedObject;
public java.lang.Object getTrigger()
Gets the threshold/string (depending on the monitor type) that triggered off this monitor notification.
return
The trigger.
return trigger;