com.sun.jdmk.comm
Class HeartBeatNotification

java.lang.Object
  java.util.EventObject
      javax.management.Notification
          com.sun.jdmk.comm.HeartBeatNotification

All Implemented Interfaces:

Serializable

public class HeartBeatNotification
extends Notification

This notification will be sent by a connector client when the connector client itself connects to or disconnects from the connector server or when the connector server associated to this connector client dies or is temporarily unreachable and after several retries have been carried out unsuccessfully.

See Also:

Serialized Form

Field Summary

static String	CONNECTION_ESTABLISHED Notification type denoting that the connector client specified as the source object has been connected to its corresponding connector server.
static String	CONNECTION_LOST Notification type denoting that the connector server associated to the connector client specified as the source object in this notification has died.
static String	CONNECTION_REESTABLISHED Notification type denoting that the connector server associated to the connector client specified as the source object in this notification was temporarily unreachable but connection has been reestablished successfully.
static String	CONNECTION_RETRYING Notification type denoting that the connector server associated to the connector client specified as the source object in this notification is temporarily unreachable but the connector client is trying to reestablish the connection.
static String	CONNECTION_TERMINATED Notification type denoting that the connector client specified as the source object has been disconnected from its corresponding connector server.

Fields inherited from class javax.management.Notification

source

Constructor Summary

HeartBeatNotification(String type, Object source, long sequenceNumber, long timeStamp, String msg, ConnectorAddress connAddr)
Constructs a heartbeat notification object.

Method Summary

ConnectorAddress

getConnectorAddress() Gets the connector address of this heartbeat notification.

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

CONNECTION_ESTABLISHED

public static final String CONNECTION_ESTABLISHED

Notification type denoting that the connector client specified as the source object has been connected to its corresponding connector server.

The value of this notification type is jdmk.connector.heartbeat.connection.established.

See Also:

Constant Field Values

CONNECTION_RETRYING

public static final String CONNECTION_RETRYING

Notification type denoting that the connector server associated to the connector client specified as the source object in this notification is temporarily unreachable but the connector client is trying to reestablish the connection.

The value of this notification type is jdmk.connector.heartbeat.connection.retrying.

See Also:

Constant Field Values

CONNECTION_LOST

public static final String CONNECTION_LOST

Notification type denoting that the connector server associated to the connector client specified as the source object in this notification has died.

The value of this notification type is jdmk.connector.heartbeat.connection.lost.

See Also:

Constant Field Values

CONNECTION_REESTABLISHED

public static final String CONNECTION_REESTABLISHED

Notification type denoting that the connector server associated to the connector client specified as the source object in this notification was temporarily unreachable but connection has been reestablished successfully.

The value of this notification type is jdmk.connector.heartbeat.connection.reestablished.

See Also:

Constant Field Values

CONNECTION_TERMINATED

public static final String CONNECTION_TERMINATED

Notification type denoting that the connector client specified as the source object has been disconnected from its corresponding connector server.

The value of this notification type is jdmk.connector.heartbeat.connection.terminated.

See Also:

Constant Field Values

Constructor Detail

HeartBeatNotification

public HeartBeatNotification(String type,
                             Object source,
                             long sequenceNumber,
                             long timeStamp,
                             String msg,
                             ConnectorAddress connAddr)

Constructs a heartbeat notification object. In addition to the information common to all the notifications, the caller must supply the connector address identifying the connector server to which the connector client sending this notification is connected to.

Parameters:

type - The notification type.

source - The notification producer, i.e. the connector client.

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.

connAddr - A ConnectorAddress object describing the connector server.

Method Detail

getConnectorAddress

public ConnectorAddress getConnectorAddress()

Gets the connector address of this heartbeat notification.

Returns:

The connector address of the connector server.