org.apache.nifi.cluster.manager

Interface HttpClusterManager

All Superinterfaces:

ClusterManager, NodeInformant

All Known Implementing Classes:

WebClusterManager

public interface HttpClusterManager
extends ClusterManager

Extends the ClusterManager interface to define how requests issued to the cluster manager are federated to the nodes. Specifically, the HTTP protocol is used for communicating requests to the cluster manager and to the nodes.

Method Summary

Modifier and Type	Method and Description
NodeResponse	applyRequest(String method, URI uri, Map<String,List<String>> parameters, Map<String,String> headers) Federates the HTTP request to all connected nodes in the cluster.
NodeResponse	applyRequest(String method, URI uri, Map<String,List<String>> parameters, Map<String,String> headers, Set<NodeIdentifier> nodeIdentifiers) Federates the HTTP request to the nodes specified.
NodeResponse	applyRequest(String method, URI uri, Object entity, Map<String,String> headers) Federates the HTTP request to all connected nodes in the cluster.
NodeResponse	applyRequest(String method, URI uri, Object entity, Map<String,String> headers, Set<NodeIdentifier> nodeIdentifiers) Federates the HTTP request to the nodes specified.

Methods inherited from interface org.apache.nifi.cluster.manager.ClusterManager

deleteNode, getBulletinRepository, getHeartbeatMonitoringIntervalSeconds, getMaxHeartbeatGapSeconds, getNode, getNodeEvents, getNodeIds, getNodes, getPrimaryNode, getProcessGroupStatus, getSystemDiagnostics, handleHeartbeat, requestConnection, requestDisconnection, requestReconnection, setPrimaryNode

Methods inherited from interface org.apache.nifi.remote.cluster.NodeInformant

getNodeInformation

Method Detail

applyRequest

NodeResponse applyRequest(String method,
                          URI uri,
                          Map<String,List<String>> parameters,
                          Map<String,String> headers)
                   throws NoConnectedNodesException,
                          NoResponseFromNodesException,
                          UriConstructionException,
                          ConnectingNodeMutableRequestException,
                          DisconnectedNodeMutableRequestException,
                          SafeModeMutableRequestException

Federates the HTTP request to all connected nodes in the cluster. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are guaranteed to be constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued.

Parameters:

method - the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD)

uri - the base request URI (up to, but not including, the query string)

parameters - the request parameters

headers - the request headers

Returns:

the client response

Throws:

NoConnectedNodesException - if no nodes are connected as results of the request

NoResponseFromNodesException - if no response could be obtained

UriConstructionException - if there was an issue constructing the URIs tailored for each individual node

ConnectingNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is connecting to the cluster

DisconnectedNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is disconnected from the cluster

SafeModeMutableRequestException - if the request was a PUT, POST, DELETE and a the cluster is in safe mode

applyRequest

NodeResponse applyRequest(String method,
                          URI uri,
                          Map<String,List<String>> parameters,
                          Map<String,String> headers,
                          Set<NodeIdentifier> nodeIdentifiers)
                   throws NoConnectedNodesException,
                          NoResponseFromNodesException,
                          UriConstructionException,
                          ConnectingNodeMutableRequestException,
                          DisconnectedNodeMutableRequestException,
                          SafeModeMutableRequestException

Federates the HTTP request to the nodes specified. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are guaranteed to be constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued.

Parameters:

method - the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD)

uri - the base request URI (up to, but not including, the query string)

parameters - the request parameters

headers - the request headers

nodeIdentifiers - the NodeIdentifier for each node that the request should be replaced to

Returns:

the client response

Throws:

NoConnectedNodesException - if no nodes are connected as results of the request

NoResponseFromNodesException - if no response could be obtained

UriConstructionException - if there was an issue constructing the URIs tailored for each individual node

ConnectingNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is connecting to the cluster

DisconnectedNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is disconnected from the cluster

SafeModeMutableRequestException - if the request was a PUT, POST, DELETE and a the cluster is in safe mode

applyRequest

NodeResponse applyRequest(String method,
                          URI uri,
                          Object entity,
                          Map<String,String> headers)
                   throws NoConnectedNodesException,
                          NoResponseFromNodesException,
                          UriConstructionException,
                          ConnectingNodeMutableRequestException,
                          DisconnectedNodeMutableRequestException,
                          SafeModeMutableRequestException

Federates the HTTP request to all connected nodes in the cluster. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are guaranteed to be constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued.

Parameters:

method - the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD)

uri - the base request URI (up to, but not including, the query string)

entity - the HTTP request entity

headers - the request headers

Returns:

the client response

Throws:

NoConnectedNodesException - if no nodes are connected as results of the request

NoResponseFromNodesException - if no response could be obtained

UriConstructionException - if there was an issue constructing the URIs tailored for each individual node

ConnectingNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is connecting to the cluster

DisconnectedNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is disconnected from the cluster

SafeModeMutableRequestException - if the request was a PUT, POST, DELETE and a the cluster is in safe mode

applyRequest

NodeResponse applyRequest(String method,
                          URI uri,
                          Object entity,
                          Map<String,String> headers,
                          Set<NodeIdentifier> nodeIdentifiers)
                   throws NoConnectedNodesException,
                          NoResponseFromNodesException,
                          UriConstructionException,
                          ConnectingNodeMutableRequestException,
                          DisconnectedNodeMutableRequestException,
                          SafeModeMutableRequestException

Federates the HTTP request to the nodes specified. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are guaranteed to be constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued.

Parameters:

method - the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD)

uri - the base request URI (up to, but not including, the query string)

entity - the HTTP request entity

headers - the request headers

nodeIdentifiers - the NodeIdentifier for each node that the request should be replaced to

Returns:

the client response

Throws:

NoConnectedNodesException - if no nodes are connected as results of the request

NoResponseFromNodesException - if no response could be obtained

UriConstructionException - if there was an issue constructing the URIs tailored for each individual node

ConnectingNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is connecting to the cluster

DisconnectedNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is disconnected from the cluster

SafeModeMutableRequestException - if the request was a PUT, POST, DELETE and a the cluster is in safe mode