org.apache.nifi.cluster.node

Class Node

java.lang.Object

org.apache.nifi.cluster.node.Node

All Implemented Interfaces:

Cloneable, Comparable<Node>

public class Node
extends Object
implements Cloneable, Comparable<Node>

Represents a connected flow controller. Nodes always have an immutable identifier and a status. The status may be changed, but never null. A Node may be cloned, but the cloning is a shallow copy of the instance. This class overrides hashCode and equals and considers two instances to be equal if they have the equal NodeIdentifiers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Node.Status The semantics of a Node status are as follows: CONNECTED -- a flow controller that is connected to the cluster.

Field Summary

Fields

Modifier and Type	Field and Description
private AtomicLong	connectionRequestedTimestamp the last time the connection for this node was requested
private boolean	heartbeatDisconnection a flag to indicate this node was disconnected because of a lack of heartbeat
private Heartbeat	lastHeartbeat the last heartbeat received by from the node
private HeartbeatPayload	lastHeartbeatPayload the payload of the last heartbeat received from the node
private static org.slf4j.Logger	lockLogger
private NodeIdentifier	nodeId the node's unique identifier
private Node.Status	status the node statue

Constructor Summary

Constructors

Constructor and Description
Node(NodeIdentifier id, Node.Status status)

Method Summary

Methods

Modifier and Type	Method and Description
Node	clone()
int	compareTo(Node o)
boolean	equals(Object obj)
long	getConnectionRequestedTimestamp() Returns the time of the last received connection request for this node.
Heartbeat	getHeartbeat() Returns the last received heartbeat or null if no heartbeat has been set.
HeartbeatPayload	getHeartbeatPayload()
NodeIdentifier	getNodeId()
Node.Status	getStatus()
int	hashCode()
boolean	isHeartbeatDisconnection() Returns true if the node was disconnected due to lack of heartbeat; false otherwise.
void	setConnectionRequestedTimestamp(long connectionRequestedTimestamp) Sets the time when the connection request for this node was last received.
void	setHeartbeat(Heartbeat heartbeat) Sets the last heartbeat received.
void	setHeartbeatDisconnection() Sets the status to disconnected and flags the node as being disconnected by lack of heartbeat.
void	setStatus(Node.Status status)
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

lockLogger

private static final org.slf4j.Logger lockLogger

nodeId

private final NodeIdentifier nodeId

the node's unique identifier

status

private Node.Status status

the node statue

lastHeartbeat

private Heartbeat lastHeartbeat

the last heartbeat received by from the node

lastHeartbeatPayload

private HeartbeatPayload lastHeartbeatPayload

the payload of the last heartbeat received from the node

connectionRequestedTimestamp

private AtomicLong connectionRequestedTimestamp

the last time the connection for this node was requested

heartbeatDisconnection

private boolean heartbeatDisconnection

a flag to indicate this node was disconnected because of a lack of heartbeat

Constructor Detail

Node

public Node(NodeIdentifier id,
    Node.Status status)

Method Detail

getNodeId

public NodeIdentifier getNodeId()

getHeartbeat

public Heartbeat getHeartbeat()

Returns the last received heartbeat or null if no heartbeat has been set.

Returns:

a heartbeat or null

getHeartbeatPayload

public HeartbeatPayload getHeartbeatPayload()

setHeartbeat

public void setHeartbeat(Heartbeat heartbeat)
                  throws ProtocolException

Sets the last heartbeat received.

Parameters:

heartbeat - a heartbeat

Throws:

ProtocolException - if the heartbeat's payload failed unmarshalling

getConnectionRequestedTimestamp

public long getConnectionRequestedTimestamp()

Returns the time of the last received connection request for this node.

Returns:

the time when the connection request for this node was received.

setConnectionRequestedTimestamp

public void setConnectionRequestedTimestamp(long connectionRequestedTimestamp)

Sets the time when the connection request for this node was last received. This method is thread-safe and may be called without obtaining any lock.

Parameters:

connectionRequestedTimestamp - timestamp

isHeartbeatDisconnection

public boolean isHeartbeatDisconnection()

Returns true if the node was disconnected due to lack of heartbeat; false otherwise.

Returns:

true if the node was disconnected due to lack of heartbeat; false otherwise.

setHeartbeatDisconnection

public void setHeartbeatDisconnection()

Sets the status to disconnected and flags the node as being disconnected by lack of heartbeat.

getStatus

public Node.Status getStatus()

Returns:

the status

setStatus

public void setStatus(Node.Status status)

Parameters:

status - a status

clone

public Node clone()

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Node o)

Specified by:

compareTo in interface Comparable<Node>