Java™ Platform
Standard Ed. 6

javax.management.remote
Class JMXConnectionNotification

java.lang.Object
  extended by java.util.EventObject
      extended by javax.management.Notification
          extended by 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 JMXConnectorServer) and by connector clients (instances of 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:

Type Meaning
jmx.remote.connection.opened A new client connection has been opened.
jmx.remote.connection.closed A client connection has been closed.
jmx.remote.connection.failed A client connection has failed unexpectedly.
jmx.remote.connection.notifs.lost A client connection has potentially lost notifications. This notification only appears on the client side.

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

Since:
1.5
See Also:
Serialized Form

Field Summary
static String CLOSED
          Notification type string for a connection-closed notification.
static String FAILED
          Notification type string for a connection-failed notification.
static String NOTIFS_LOST
          Notification type string for a connection that has possibly lost notifications.
static String OPENED
          Notification type string for a connection-opened notification.
 
Fields inherited from class javax.management.Notification
source
 
Constructor Summary
JMXConnectionNotification(String type, Object source, String connectionId, long sequenceNumber, String message, Object userData)
          Constructs a new connection notification.
 
Method Summary
 String getConnectionId()
          The connection ID to which this notification pertains.
 
Methods inherited from class javax.management.Notification
getMessage, getSequenceNumber, getTimeStamp, getType, getUserData, setSequenceNumber, setSource, setTimeStamp, setUserData, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OPENED

public static final String OPENED

Notification type string for a connection-opened notification.

See Also:
Constant Field Values

CLOSED

public static final String CLOSED

Notification type string for a connection-closed notification.

See Also:
Constant Field Values

FAILED

public static final String FAILED

Notification type string for a connection-failed notification.

See Also:
Constant Field Values

NOTIFS_LOST

public static final String NOTIFS_LOST

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

See Also:
Constant Field Values
Constructor Detail

JMXConnectionNotification

public JMXConnectionNotification(String type,
                                 Object source,
                                 String connectionId,
                                 long sequenceNumber,
                                 String message,
                                 Object userData)
Constructs a new connection notification. The source of the notification depends on whether it is being sent by a connector server or a connector client:

Parameters:
type - the type of the notification. This is usually one of the constants OPENED, CLOSED, FAILED, 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.
Throws:
NullPointerException - if type, source, or connectionId is null.
IllegalArgumentException - if sequenceNumber is negative.
Method Detail

getConnectionId

public String getConnectionId()

The connection ID to which this notification pertains.

Returns:
the connection ID.

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Scripting on this page tracks web page traffic, but does not change the content in any way.