Package org.apache.nifi.cluster.protocol

Interface NodeProtocolSender

All Known Implementing Classes:

AbstractNodeProtocolSender, LeaderElectionNodeProtocolSender, NodeProtocolSenderListener

public interface NodeProtocolSender

An interface for sending protocol messages from a node to the cluster manager.

Method Summary

Modifier and Type	Method	Description
ClusterWorkloadResponseMessage	clusterWorkload(ClusterWorkloadRequestMessage msg)	Sends a "cluster workflow request" message to the Cluster Coordinator.
HeartbeatResponseMessage	heartbeat(HeartbeatMessage msg, String address)	Sends a heartbeat to the address given
NodeStatusesResponseMessage	nodeStatuses(NodeStatusesRequestMessage msg)	Sends a "node statuses" request message to the Cluster Coordinator.
ConnectionResponseMessage	requestConnection(ConnectionRequestMessage msg, boolean allowConnectionToSelf)	Sends a "connection request" message to the cluster manager.

Method Details

requestConnection

ConnectionResponseMessage requestConnection(ConnectionRequestMessage msg,
 boolean allowConnectionToSelf)
                                     throws ProtocolException,
UnknownServiceAddressException

Sends a "connection request" message to the cluster manager.

Parameters:

msg - a message

allowConnectionToSelf - whether or not the node should be allowed to connect to the cluster if the Cluster Coordinator is this node

Returns:

the response

Throws:

UnknownServiceAddressException - if the cluster manager's address is not known

ProtocolException - if communication failed

heartbeat

HeartbeatResponseMessage heartbeat(HeartbeatMessage msg,
 String address)
                            throws ProtocolException

Sends a heartbeat to the address given

Parameters:

msg - the heartbeat message to send

address - the address of the Cluster Coordinator in <hostname>:<port> format

Returns:

the response from the Cluster Coordinator

Throws:

ProtocolException - if unable to send the heartbeat

clusterWorkload

ClusterWorkloadResponseMessage clusterWorkload(ClusterWorkloadRequestMessage msg)
                                        throws ProtocolException

Sends a "cluster workflow request" message to the Cluster Coordinator.

Parameters:

msg - a request message

Returns:

the response from the Cluster Coordinator

Throws:

ProtocolException - if communication failed

nodeStatuses

NodeStatusesResponseMessage nodeStatuses(NodeStatusesRequestMessage msg)
                                  throws ProtocolException

Sends a "node statuses" request message to the Cluster Coordinator.

Parameters:

msg - a request message

Returns:

the response from the Cluster Coordinator containing the statuses of all nodes in the cluster

Throws:

ProtocolException - if communication failed