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:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_CHANGE	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	source	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
String	getAttributeName()	Gets the name of the attribute which has changed.
String	getAttributeType()	Gets the type of the attribute which has changed.
Object	getNewValue()	Gets the new value of the attribute which has changed.
Object	getOldValue()	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
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

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:

• Constant Field Values

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.