Class MonitorNotification

java.lang.Object
java.util.EventObject
javax.management.Notification
javax.management.monitor.MonitorNotification
All Implemented Interfaces:
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.
Since:
1.5
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    OBSERVED_ATTRIBUTE_ERROR
    Notification type denoting that the observed attribute is not contained in the observed object.
    static final String
    OBSERVED_ATTRIBUTE_TYPE_ERROR
    Notification type denoting that the type of the observed attribute is not correct.
    static final String
    OBSERVED_OBJECT_ERROR
    Notification type denoting that the observed object is not registered in the MBean server.
    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.
    static final String
    STRING_TO_COMPARE_VALUE_DIFFERED
    Notification type denoting that the observed attribute has differed from the "string to compare" value.
    static final String
    STRING_TO_COMPARE_VALUE_MATCHED
    Notification type denoting that the observed attribute has matched the "string to compare" value.
    static final String
    THRESHOLD_ERROR
    Notification type denoting that the type of the thresholds, offset or modulus is not correct.
    static final String
    THRESHOLD_HIGH_VALUE_EXCEEDED
    Notification type denoting that the observed attribute has exceeded the threshold high value.
    static final String
    THRESHOLD_LOW_VALUE_EXCEEDED
    Notification type denoting that the observed attribute has exceeded the threshold low value.
    static final String
    THRESHOLD_VALUE_EXCEEDED
    Notification type denoting that the observed attribute has reached the threshold value.

    Fields declared in class Notification

    source
    Modifier and Type
    Field
    Description
    protected Object
    source
    This field hides the EventObject.source field in the parent class to make it non-transient and therefore part of the serialized form.

  • Method Summary

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

    Methods declared in class Notification

    getMessage, getSequenceNumber, getTimeStamp, getType, getUserData, setSequenceNumber, setSource, setTimeStamp, setUserData, toString
    Modifier and Type
    Method
    Description
    String
    getMessage()
    Get the notification message.
    long
    getSequenceNumber()
    Get the notification sequence number.
    long
    getTimeStamp()
    Get the notification timestamp.
    String
    getType()
    Get the notification type.
    Object
    getUserData()
    Get the user data.
    void
    setSequenceNumber(long sequenceNumber)
    Set the notification sequence number.
    void
    setSource(Object source)
    Sets the source.
    void
    setTimeStamp(long timeStamp)
    Set the notification timestamp.
    void
    setUserData(Object userData)
    Set the user data.
    String
    toString()
    Returns a String representation of this notification.

    Methods declared in class EventObject

    getSource
    Modifier and Type
    Method
    Description
    Object
    getSource()
    The object on which the Event initially occurred.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Field Details

    • OBSERVED_OBJECT_ERROR

      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.
      See Also:

    • OBSERVED_ATTRIBUTE_ERROR

      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.
      See Also:

    • OBSERVED_ATTRIBUTE_TYPE_ERROR

      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.
      See Also:

    • THRESHOLD_ERROR

      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.
      See Also:

    • RUNTIME_ERROR

      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.
      See Also:

    • THRESHOLD_VALUE_EXCEEDED

      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.
      See Also:

    • THRESHOLD_HIGH_VALUE_EXCEEDED

      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.
      See Also:

    • THRESHOLD_LOW_VALUE_EXCEEDED

      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.
      See Also:

    • STRING_TO_COMPARE_VALUE_MATCHED

      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.
      See Also:

    • STRING_TO_COMPARE_VALUE_DIFFERED

      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.
      See Also:

  • Method Details

    • getObservedObject

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

    • getObservedAttribute

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

    • getDerivedGauge

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

    • getTrigger

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