javax.management
Class Notification

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

Direct Known Subclasses:

AttributeChangeNotification, MBeanServerNotification, MonitorNotification, RelationNotification, TimerNotification

public class Notification

extends java.util.EventObject

The Notification class represents a notification emitted by an MBean. It contains a reference to the source MBean: if the notification has been forwarded through the MBean server, this is the object name of the MBean. If the listener has registered directly with the MBean, this is a direct reference to the MBean.

Version:

1.17

Author:

Attilio Mattiocco, Chiara Montecchio, Raimondo Castino

See Also:

Serialized Form

Field Summary

protected java.lang.Object

source The object on which the notification initially occurred.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Notification(java.lang.String type, java.lang.Object source, long sequenceNumber)
Creates a Notification object.

Notification(java.lang.String type, java.lang.Object source, long sequenceNumber, long timeStamp)
Creates a Notification object.

Notification(java.lang.String type, java.lang.Object source, long sequenceNumber, long timeStamp, java.lang.String message)
Creates a Notification object.

Notification(java.lang.String type, java.lang.Object source, long sequenceNumber, java.lang.String message)
Creates a Notification object.

Method Summary

java.lang.String	getMessage() Get the notification message
long	getSequenceNumber() Get the notification sequence number.
java.lang.Object	getSource() Get the source object name
long	getTimeStamp() Get the notification time stamp
java.lang.String	getType() Get the notification type.
java.lang.Object	getUserData() Get the notification user data
void	setSequenceNumber(long sequenceNumber) Set the notification sequence number
void	setSource(java.lang.Object source) Set the source object name
void	setTimeStamp(long timeStamp) Set the notification time stamp
void	setUserData(java.lang.Object userData) Set the notification user data

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

source

protected java.lang.Object source

The object on which the notification initially occurred.

Constructor Detail

Notification

public Notification(java.lang.String type,
                    java.lang.Object source,
                    long sequenceNumber)

Creates a Notification object. The notification timeStamp is set to the current date.

Parameters:

type - The notification type.

source - The notification source.

sequenceNumber - The notification sequence number within the source object.

Notification

public Notification(java.lang.String type,
                    java.lang.Object source,
                    long sequenceNumber,
                    long timeStamp)

Creates a Notification object.

Parameters:

type - The notification type.

source - The notification source.

sequenceNumber - The notification sequence number within the source object.

timeStamp - The notification emission date.

Notification

public Notification(java.lang.String type,
                    java.lang.Object source,
                    long sequenceNumber,
                    long timeStamp,
                    java.lang.String message)

Creates a Notification object.

Parameters:

type - The notification type.

source - The notification source.

sequenceNumber - The notification sequence number within the source object.

timeStamp - The notification emission date.

message - The detailed message

Notification

public Notification(java.lang.String type,
                    java.lang.Object source,
                    long sequenceNumber,
                    java.lang.String message)

Creates a Notification object. The notification timeStamp is set to the curent date.

Parameters:

type - The notification type.

source - The notification source.

sequenceNumber - The notification sequence number within the source object.

message - The detailed message

Method Detail

getType

public java.lang.String getType()

Get the notification type.

Returns:

The notification type. It's a string expressed in a dot notation similar to Java properties. An example of a notification type is network.alarm.router .

getSource

public java.lang.Object getSource()

Get the source object name

Overrides:

getSource in class java.util.EventObject

Returns:

The MBean object name on which the notification initially occurred.

getSequenceNumber

public long getSequenceNumber()

Get the notification sequence number.

Returns:

The notification sequence number within the source object. It's a serial number identifying a particular instance of notification in the context of the notification source. The notification model does not assume that notifications will be received in the same order that they are sent. The sequence number helps listeners to sort received notifications.

getTimeStamp

public long getTimeStamp()

Get the notification time stamp

Returns:

the notification time stamp

getMessage

public java.lang.String getMessage()

Get the notification message

Returns:

The message string of this notification object. It contains in a string, which could be the explanation of the notification for displaying to a user

getUserData

public java.lang.Object getUserData()

Get the notification user data

Returns:

The user data object. It is used for whatever data the notification source wishes to communicate to its consumers.

setSequenceNumber

public void setSequenceNumber(long sequenceNumber)

Set the notification sequence number

Parameters:

sequenceNumber - The notification sequence number within the source object. It is a serial number identifying a particular instance of notification in the context of the notification source.

setTimeStamp

public void setTimeStamp(long timeStamp)

Set the notification time stamp

Parameters:

timeStamp - the notification time stamp. It indicates when the notification was generated.

setUserData

public void setUserData(java.lang.Object userData)

Set the notification user data

Parameters:

userData - The user data object. It is used for whatever data the notification source wishes to communicate to its consumers.

setSource

public void setSource(java.lang.Object source)
               throws java.lang.IllegalArgumentException

Set the source object name

Parameters:

source - the notification source

Throws:

java.lang.IllegalArgumentException - The source is not an ObjectName