javax.management.remote
class JMXConnectionNotification

java.lang.Object java.util.EventObject javax.management.Notification javax.management.remote.JMXConnectionNotification

All Implemented Interfaces:

Serializable

public class JMXConnectionNotification
extends Notification

Notification emitted when a client connection is opened or closed or when notifications are lost. These notifications are sent by connector servers (instances of {@link JMXConnectorServer}) and by connector clients (instances of {@link JMXConnector}). For certain connectors, a session can consist of a sequence of connections. Connection-opened and connection-closed notifications will be sent for each one.

The notification type is one of the following:

The timeStamp of the notification is a time value (consistent with {@link System#currentTimeMillis()}) indicating when the notification was constructed.

CLOSED

public static final String CLOSED

Notification type string for a connection-closed notification.

FAILED

public static final String FAILED

Notification type string for a connection-failed notification.

NOTIFS_LOST

public static final String NOTIFS_LOST

Notification type string for a connection that has possibly lost notifications.

OPENED

public static final String OPENED

Notification type string for a connection-opened notification.

JMXConnectionNotification

public JMXConnectionNotification(String type,
                                 Object source,
                                 String connectionId,
                                 long sequenceNumber,
                                 String message,
                                 Object userData)

Constructs a new connection notification. The {@link #getSource() source} of the notification depends on whether it is being sent by a connector server or a connector client:

• For a connector server, if it is registered in an MBean server, the source is the {@link ObjectName} under which it is registered. Otherwise, it is a reference to the connector server object itself, an instance of a subclass of {@link JMXConnectorServer}.
• For a connector client, the source is a reference to the connector client object, an instance of a class implementing {@link JMXConnector}.

Parameters:

type - the type of the notification. This is usually one of the constants {@link #OPENED}, {@link #CLOSED}, {@link #FAILED}, {@link #NOTIFS_LOST}. It is not an error for it to be a different string.

source - the connector server or client emitting the notification.

connectionId - the ID of the connection within its connector server.

sequenceNumber - a non-negative integer. It is expected but not required that this number will be greater than any previous sequenceNumber in a notification from this source.

message - an unspecified text message, typically containing a human-readable description of the event. Can be null.

userData - an object whose type and meaning is defined by the connector server. Can be null.

getConnectionId

public String getConnectionId()

The connection ID to which this notification pertains.

Returns:

the connection ID.