org.apache.nifi.cluster.coordination.http.replication

Class ThreadPoolRequestReplicator

java.lang.Object

org.apache.nifi.cluster.coordination.http.replication.ThreadPoolRequestReplicator

All Implemented Interfaces:

RequestReplicator

public class ThreadPoolRequestReplicator
extends java.lang.Object
implements RequestReplicator

Field Summary

Fields inherited from interface org.apache.nifi.cluster.coordination.http.replication.RequestReplicator

CLUSTER_ID_GENERATION_SEED_HEADER, NODE_CONTINUE, NODE_CONTINUE_STATUS_CODE, REPLICATION_INDICATOR_HEADER, REPLICATION_TARGET_NODE_UUID_HEADER, REQUEST_EXECUTION_HTTP_HEADER, REQUEST_TRANSACTION_CANCELATION_HTTP_HEADER, REQUEST_TRANSACTION_ID_HEADER, REQUEST_VALIDATION_HTTP_HEADER

Constructor Summary

Constructors

Constructor and Description
ThreadPoolRequestReplicator(int corePoolSize, int maxPoolSize, int maxConcurrentRequests, com.sun.jersey.api.client.Client client, ClusterCoordinator clusterCoordinator, RequestCompletionCallback callback, EventReporter eventReporter, NiFiProperties nifiProperties) Creates an instance using a connection timeout and read timeout of 3 seconds
ThreadPoolRequestReplicator(int corePoolSize, int maxPoolSize, int maxConcurrentRequests, com.sun.jersey.api.client.Client client, ClusterCoordinator clusterCoordinator, java.lang.String connectionTimeout, java.lang.String readTimeout, RequestCompletionCallback callback, EventReporter eventReporter, NiFiProperties nifiProperties) Creates an instance.

Method Summary

Modifier and Type	Method and Description
AsyncClusterResponse	forwardToCoordinator(NodeIdentifier coordinatorNodeId, java.lang.String method, java.net.URI uri, java.lang.Object entity, java.util.Map<java.lang.String,java.lang.String> headers) Forwards a request to the Cluster Coordinator so that it is able to replicate the request to all nodes in the cluster.
AsyncClusterResponse	getClusterResponse(java.lang.String identifier) Returns an AsyncClusterResponse that provides the most up-to-date status of the request with the given identifier.
AsyncClusterResponse	replicate(java.util.Set<NodeIdentifier> nodeIds, java.lang.String method, java.net.URI uri, java.lang.Object entity, java.util.Map<java.lang.String,java.lang.String> headers, boolean indicateReplicated, boolean performVerification) Requests are sent to each node in the given set of Node Identifiers.
AsyncClusterResponse	replicate(java.lang.String method, java.net.URI uri, java.lang.Object entity, java.util.Map<java.lang.String,java.lang.String> headers) Replicates a request to each node in the cluster.
protected NodeResponse	replicateRequest(com.sun.jersey.api.client.WebResource.Builder resourceBuilder, NodeIdentifier nodeId, java.lang.String method, java.net.URI uri, java.lang.String requestId, java.util.Map<java.lang.String,java.lang.String> headers, StandardAsyncClusterResponse clusterResponse)
void	shutdown() Stops the instance from replicating requests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThreadPoolRequestReplicator

public ThreadPoolRequestReplicator(int corePoolSize,
                                   int maxPoolSize,
                                   int maxConcurrentRequests,
                                   com.sun.jersey.api.client.Client client,
                                   ClusterCoordinator clusterCoordinator,
                                   RequestCompletionCallback callback,
                                   EventReporter eventReporter,
                                   NiFiProperties nifiProperties)

Creates an instance using a connection timeout and read timeout of 3 seconds

Parameters:

corePoolSize - core size of the thread pool

maxPoolSize - the max number of threads in the thread pool

maxConcurrentRequests - maximum number of concurrent requests

client - a client for making requests

clusterCoordinator - the cluster coordinator to use for interacting with node statuses

callback - a callback that will be called whenever all of the responses have been gathered for a request. May be null.

eventReporter - an EventReporter that can be used to notify users of interesting events. May be null.

nifiProperties - properties

ThreadPoolRequestReplicator

public ThreadPoolRequestReplicator(int corePoolSize,
                                   int maxPoolSize,
                                   int maxConcurrentRequests,
                                   com.sun.jersey.api.client.Client client,
                                   ClusterCoordinator clusterCoordinator,
                                   java.lang.String connectionTimeout,
                                   java.lang.String readTimeout,
                                   RequestCompletionCallback callback,
                                   EventReporter eventReporter,
                                   NiFiProperties nifiProperties)

Creates an instance.

Parameters:

corePoolSize - core size of the thread pool

maxPoolSize - the max number of threads in the thread pool

maxConcurrentRequests - maximum number of concurrent requests

client - a client for making requests

clusterCoordinator - the cluster coordinator to use for interacting with node statuses

connectionTimeout - the connection timeout specified in milliseconds

readTimeout - the read timeout specified in milliseconds

callback - a callback that will be called whenever all of the responses have been gathered for a request. May be null.

eventReporter - an EventReporter that can be used to notify users of interesting events. May be null.

nifiProperties - properties

Method Detail

shutdown

public void shutdown()

Description copied from interface: RequestReplicator

Stops the instance from replicating requests. Calling this method on a stopped instance has no effect.

Specified by:

shutdown in interface RequestReplicator

replicate

public AsyncClusterResponse replicate(java.lang.String method,
                                      java.net.URI uri,
                                      java.lang.Object entity,
                                      java.util.Map<java.lang.String,java.lang.String> headers)

Description copied from interface: RequestReplicator

Replicates a request to each node in the cluster. If the request attempts to modify the flow and there is a node that is not currently connected, an Exception will be thrown. Otherwise, the returned AsyncClusterResponse object will contain the results that are immediately available, as well as an identifier for obtaining an updated result later. NOTE: This method will ALWAYS indicate that the request has been replicated.

Specified by:

replicate in interface RequestReplicator

Parameters:

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:

an AsyncClusterResponse that indicates the current status of the request and provides an identifier for obtaining an updated response later

replicate

public AsyncClusterResponse replicate(java.util.Set<NodeIdentifier> nodeIds,
                                      java.lang.String method,
                                      java.net.URI uri,
                                      java.lang.Object entity,
                                      java.util.Map<java.lang.String,java.lang.String> headers,
                                      boolean indicateReplicated,
                                      boolean performVerification)

Description copied from interface: RequestReplicator

Requests are sent to each node in the given set of Node Identifiers. The returned AsyncClusterResponse object will contain the results that are immediately available, as well as an identifier for obtaining an updated result later.

HTTP DELETE, GET, HEAD, and OPTIONS methods will throw an IllegalArgumentException if used.

Specified by:

replicate in interface RequestReplicator

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

indicateReplicated - if true, will add a header indicating to the receiving nodes that the request has already been replicated, so the receiving node will not replicate the request itself.

performVerification - if true, and the request is mutable, will verify that all nodes are connected before making the request and that all nodes are able to perform the request before acutally attempting to perform the task. If false, will perform no such verification

Returns:

an AsyncClusterResponse that indicates the current status of the request and provides an identifier for obtaining an updated response later

forwardToCoordinator

public AsyncClusterResponse forwardToCoordinator(NodeIdentifier coordinatorNodeId,
                                                 java.lang.String method,
                                                 java.net.URI uri,
                                                 java.lang.Object entity,
                                                 java.util.Map<java.lang.String,java.lang.String> headers)

Description copied from interface: RequestReplicator

Forwards a request to the Cluster Coordinator so that it is able to replicate the request to all nodes in the cluster.

Specified by:

forwardToCoordinator in interface RequestReplicator

Parameters:

coordinatorNodeId - the node identifier of the Cluster Coordinator

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:

an AsyncClusterResponse that indicates the current status of the request and provides an identifier for obtaining an updated response later

getClusterResponse

public AsyncClusterResponse getClusterResponse(java.lang.String identifier)

Description copied from interface: RequestReplicator

Returns an AsyncClusterResponse that provides the most up-to-date status of the request with the given identifier. If the request is finished, meaning that all nodes in the cluster have reported back their status or have timed out, then the response will be removed and any subsequent calls to obtain the response with the same identifier will return null. If the response is not complete, the method may be called again at some point in the future in order to check again if the request has completed.

Specified by:

getClusterResponse in interface RequestReplicator

Parameters:

identifier - the identifier of the request to obtain a response for

Returns:

an AsyncClusterResponse that provides the most up-to-date status of the request with the given identifier, or null if no request exists with the given identifier

replicateRequest

protected NodeResponse replicateRequest(com.sun.jersey.api.client.WebResource.Builder resourceBuilder,
                                        NodeIdentifier nodeId,
                                        java.lang.String method,
                                        java.net.URI uri,
                                        java.lang.String requestId,
                                        java.util.Map<java.lang.String,java.lang.String> headers,
                                        StandardAsyncClusterResponse clusterResponse)