org.apache.nifi.cluster.coordination.heartbeat

Interface HeartbeatMonitor

public interface HeartbeatMonitor

A HeartbeatMonitor is responsible for monitoring some remote resource for heartbeats from each node in a cluster and reacting to those heartbeats (or lack thereof).

Method Summary

Modifier and Type	Method and Description
String	getHeartbeatAddress()
NodeHeartbeat	getLatestHeartbeat(NodeIdentifier nodeId) Returns the latest heartbeat that has been obtained for the node with the given id
void	purgeHeartbeats() Clears all heartbeats that have been received
void	removeHeartbeat(NodeIdentifier nodeId) Removes the heartbeat for the given node from the monitor and the remote location where heartbeats are sent
void	start() Begin monitoring for heartbeats
void	stop() Stop monitoring heartbeats

Method Detail

start

void start()

Begin monitoring for heartbeats

stop

void stop()

Stop monitoring heartbeats

getLatestHeartbeat

NodeHeartbeat getLatestHeartbeat(NodeIdentifier nodeId)

Returns the latest heartbeat that has been obtained for the node with the given id

Parameters:

nodeId - the id of the node whose heartbeat should be retrieved

Returns:

the latest heartbeat that has been obtained for the node with the given id, or null if no heartbeat has been obtained

removeHeartbeat

void removeHeartbeat(NodeIdentifier nodeId)

Removes the heartbeat for the given node from the monitor and the remote location where heartbeats are sent

Parameters:

nodeId - the id of the node whose heartbeat should be removed

purgeHeartbeats

void purgeHeartbeats()

Clears all heartbeats that have been received

getHeartbeatAddress

String getHeartbeatAddress()

Returns:

the address that heartbeats should be sent to when this node is elected coordinator.