org.apache.nifi.cluster.manager

Interface HttpRequestReplicator

All Known Implementing Classes:

HttpRequestReplicatorImpl

public interface HttpRequestReplicator

A service for managing the replication of requests to nodes. It is up to the implementing class to decide if requests are sent concurrently or serially. Clients must call start() and stop() to initialize and shutdown the instance. The instance must be started before issuing any replication requests.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isRunning()
Set<NodeResponse>	replicate(Set<NodeIdentifier> nodeIds, String method, URI uri, Map<String,List<String>> parameters, Map<String,String> headers) Requests are sent to each node in the cluster.
Set<NodeResponse>	replicate(Set<NodeIdentifier> nodeIds, String method, URI uri, Object entity, Map<String,String> headers) Requests are sent to each node in the cluster.
void	start() Starts the instance for replicating requests.
void	stop() Stops the instance from replicating requests.

Method Detail

start

void start()

Starts the instance for replicating requests. Start may only be called if the instance is not running.

stop

void stop()

Stops the instance from replicating requests. Stop may only be called if the instance is running.

isRunning

boolean isRunning()

Returns:

true if the instance is started; false otherwise.

replicate

Set<NodeResponse> replicate(Set<NodeIdentifier> nodeIds,
                          String method,
                          URI uri,
                          Map<String,List<String>> parameters,
                          Map<String,String> headers)
                            throws UriConstructionException

Requests are sent to each node in the cluster. If the request results in an exception, then the NodeResourceResponse will contain the exception. HTTP DELETE and OPTIONS methods must supply an empty parameters map or else and IllegalArgumentException is thrown.

Parameters:

nodeIds - the node identifiers

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

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

parameters - any request parameters

headers - any HTTP headers

Returns:

the set of node responses

Throws:

UriConstructionException - if a request for a node failed to be constructed from the given prototype URI. If thrown, it is guaranteed that no request was sent.

replicate

Set<NodeResponse> replicate(Set<NodeIdentifier> nodeIds,
                          String method,
                          URI uri,
                          Object entity,
                          Map<String,String> headers)
                            throws UriConstructionException

Requests are sent to each node in the cluster. If the request results in an exception, then the NodeResourceResponse will contain the exception. HTTP DELETE, GET, HEAD, and OPTIONS methods will throw an IllegalArgumentException if used.

Parameters:

nodeIds - the node identifiers

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

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

entity - an entity

headers - any HTTP headers

Returns:

the set of node responses

Throws:

UriConstructionException - if a request for a node failed to be constructed from the given prototype URI. If thrown, it is guaranteed that no request was sent.