Class AttributeChangeNotification

java.lang.Object
java.util.EventObject
javax.management.Notification
javax.management.AttributeChangeNotification
All Implemented Interfaces:
Serializable

public class AttributeChangeNotification extends Notification
Provides definitions of the attribute change notifications sent by MBeans.

It's up to the MBean owning the attribute of interest to create and send attribute change notifications when the attribute change occurs. So the NotificationBroadcaster interface has to be implemented by any MBean for which an attribute change is of interest.

Example: If an MBean called myMbean needs to notify registered listeners when its attribute:

String myString
is modified, myMbean creates and emits the following notification:
new AttributeChangeNotification(myMbean, sequenceNumber, timeStamp, msg, "myString", "String", oldValue, newValue);
Since:
1.5
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Notification type which indicates that the observed MBean attribute value has changed.

    Fields declared in class Notification

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

    Constructors
    Constructor
    Description
    AttributeChangeNotification(Object source, long sequenceNumber, long timeStamp, String msg, String attributeName, String attributeType, Object oldValue, Object newValue)
    Constructs an attribute change notification object.
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the name of the attribute which has changed.
    Gets the type of the attribute which has changed.
    Gets the new value of the attribute which has changed.
    Gets the old value of the attribute which has changed.

    Methods declared in class Notification

    getMessage, getSequenceNumber, getTimeStamp, getType, getUserData, setSequenceNumber, setSource, setTimeStamp, setUserData, toString
    Modifier and Type
    Method
    Description
    Get the notification message.
    long
    Get the notification sequence number.
    long
    Get the notification timestamp.
    Get the notification type.
    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.
    Returns a String representation of this notification.

    Methods declared in class EventObject

    getSource
    Modifier and Type
    Method
    Description
    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
    Creates and returns a copy of this object.
    boolean
    Indicates whether some other object is "equal to" this one.
    protected void
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    Returns the runtime class of this Object.
    int
    Returns a hash code value for this object.
    final void
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    Wakes up all threads that are waiting on this object's monitor.
    final void
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
  • Field Details

    • ATTRIBUTE_CHANGE

      public static final String ATTRIBUTE_CHANGE
      Notification type which indicates that the observed MBean attribute value has changed.
      The value of this type string is jmx.attribute.change.
      See Also:
  • Constructor Details

    • AttributeChangeNotification

      public AttributeChangeNotification(Object source, long sequenceNumber, long timeStamp, String msg, String attributeName, String attributeType, Object oldValue, Object newValue)
      Constructs an attribute change notification object. In addition to the information common to all notification, the caller must supply the name and type of the attribute, as well as its old and new values.
      Parameters:
      source - The notification producer, that is, the MBean the attribute belongs to.
      sequenceNumber - The notification sequence number within the source object.
      timeStamp - The date at which the notification is being sent.
      msg - A String containing the message of the notification.
      attributeName - A String giving the name of the attribute.
      attributeType - A String containing the type of the attribute.
      oldValue - An object representing value of the attribute before the change.
      newValue - An object representing value of the attribute after the change.
  • Method Details

    • getAttributeName

      public String getAttributeName()
      Gets the name of the attribute which has changed.
      Returns:
      A String containing the name of the attribute.
    • getAttributeType

      public String getAttributeType()
      Gets the type of the attribute which has changed.
      Returns:
      A String containing the type of the attribute.
    • getOldValue

      public Object getOldValue()
      Gets the old value of the attribute which has changed.
      Returns:
      An Object containing the old value of the attribute.
    • getNewValue

      public Object getNewValue()
      Gets the new value of the attribute which has changed.
      Returns:
      An Object containing the new value of the attribute.