Top Description Fields Constructors Methods
javax.management

public Class MBeanServerNotification

extends Notification
Class Inheritance

Represents a notification emitted by the MBean Server through the MBeanServerDelegate MBean. The MBean Server emits the following types of notifications: MBean registration, MBean unregistration.

To receive MBeanServerNotifications, you need to register a listener with the MBeanServerDelegate MBean that represents the MBeanServer. The ObjectName of the MBeanServerDelegate is MBeanServerDelegate#DELEGATE_NAME, which is JMImplementation:type=MBeanServerDelegate.

The following code prints a message every time an MBean is registered or unregistered in the MBean Server mbeanServer:

private static final NotificationListener printListener = new NotificationListener() {
    public void handleNotification(Notification n, Object handback) {
        if (!(n instanceof MBeanServerNotification)) {
            System.out.println("Ignored notification of class " + n.getClass().getName());
            return;
        }
        MBeanServerNotification mbsn = (MBeanServerNotification) n;
        String what;
        if (n.getType().equals(MBeanServerNotification.REGISTRATION_NOTIFICATION))
            what = "MBean registered";
        else if (n.getType().equals(MBeanServerNotification.UNREGISTRATION_NOTIFICATION))
            what = "MBean unregistered";
        else
            what = "Unknown type " + n.getType();
        System.out.println("Received MBean Server notification: " + what + ": " +
                mbsn.getMBeanName());
    }
};

...
    mbeanServer.addNotificationListener(
            MBeanServerDelegate.DELEGATE_NAME, printListener, null, null);

An MBean which is not an MBeanServerDelegate may also emit MBeanServerNotifications. In particular, there is a convention for MBeans to emit an MBeanServerNotification for a group of MBeans.

An MBeanServerNotification emitted to denote the registration or unregistration of a group of MBeans has the following characteristics:

MBeans which emit these group registration/unregistration notifications will declare them in their MBeanNotificationInfo.

Since
1.5

Field Summary

Modifier and TypeField and Description
private final ObjectName
public static final String
REGISTRATION_NOTIFICATION

Notification type denoting that an MBean has been registered.

private static final long
public static final String
UNREGISTRATION_NOTIFICATION

Notification type denoting that an MBean has been unregistered.

Inherited from javax.management.Notification:
source

Constructor Summary

AccessConstructor and Description
public
MBeanServerNotification(String
A string denoting the type of the notification. Set it to one these values: REGISTRATION_NOTIFICATION, UNREGISTRATION_NOTIFICATION.
type
,
Object
The MBeanServerNotification object responsible for forwarding MBean server notification.
source
,
long
A sequence number that can be used to order received notifications.
sequenceNumber
,
ObjectName
The object name of the MBean that caused the notification.
objectName
)

Creates an MBeanServerNotification object specifying object names of the MBeans that caused the notification and the specified notification type.

Method Summary

Modifier and TypeMethod and Description
public ObjectName

Returns:

the object name of the MBean that caused the notification.
getMBeanName
()

Returns the object name of the MBean that caused the notification.

public String
toString()

Overrides javax.management.Notification.toString.

Returns a String representation of this notification.
Inherited from javax.management.Notification:
getMessagegetSequenceNumbergetTimeStampgetTypegetUserDatasetSequenceNumbersetSourcesetTimeStampsetUserData

Field Detail

objectNameback to summary
private final ObjectName objectName
REGISTRATION_NOTIFICATIONback to summary
public static final String REGISTRATION_NOTIFICATION

Notification type denoting that an MBean has been registered. Value is "JMX.mbean.registered".

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.management.Notification.serialVersionUID.

UNREGISTRATION_NOTIFICATIONback to summary
public static final String UNREGISTRATION_NOTIFICATION

Notification type denoting that an MBean has been unregistered. Value is "JMX.mbean.unregistered".

Constructor Detail

MBeanServerNotificationback to summary
public MBeanServerNotification(String type, Object source, long sequenceNumber, ObjectName objectName)

Creates an MBeanServerNotification object specifying object names of the MBeans that caused the notification and the specified notification type.

Parameters
type:String

A string denoting the type of the notification. Set it to one these values: REGISTRATION_NOTIFICATION, UNREGISTRATION_NOTIFICATION.

source:Object

The MBeanServerNotification object responsible for forwarding MBean server notification.

sequenceNumber:long

A sequence number that can be used to order received notifications.

objectName:ObjectName

The object name of the MBean that caused the notification.

Method Detail

getMBeanNameback to summary
public ObjectName getMBeanName()

Returns the object name of the MBean that caused the notification.

Returns:ObjectName

the object name of the MBean that caused the notification.

toStringback to summary
public String toString()

Overrides javax.management.Notification.toString.

Doc from javax.management.Notification.toString.

Returns a String representation of this notification.

Returns:String

A String representation of this notification.

Annotations
@Override