org.elasticsearch.cluster

Class AckedClusterStateUpdateTask<Response>

java.lang.Object

org.elasticsearch.cluster.ClusterStateUpdateTask

org.elasticsearch.cluster.ProcessedClusterStateUpdateTask

org.elasticsearch.cluster.TimeoutClusterStateUpdateTask

org.elasticsearch.cluster.AckedClusterStateUpdateTask<Response>

public abstract class AckedClusterStateUpdateTask<Response>
extends TimeoutClusterStateUpdateTask

An extension interface to ClusterStateUpdateTask that allows to be notified when all the nodes have acknowledged a cluster state update request

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AckedClusterStateUpdateTask(AckedRequest request, ActionListener<Response> listener)

Method Summary

Modifier and Type	Method and Description
TimeValue	ackTimeout() Acknowledgement timeout, maximum time interval to wait for acknowledgements
void	clusterStateProcessed(String source, ClusterState oldState, ClusterState newState) Called when the result of the ClusterStateUpdateTask.execute(ClusterState) have been processed properly by all listeners.
boolean	mustAck(DiscoveryNode discoveryNode) Called to determine which nodes the acknowledgement is expected from
protected abstract Response	newResponse(boolean acknowledged)
void	onAckTimeout() Called once the acknowledgement timeout defined by ackTimeout() has expired
void	onAllNodesAcked(Throwable t) Called once all the nodes have acknowledged the cluster state update request.
void	onFailure(String source, Throwable t) A callback called when execute fails.
TimeValue	timeout() If the cluster state update task wasn't processed by the provided timeout, call ClusterStateUpdateTask.onFailure(String, Throwable)

Methods inherited from class org.elasticsearch.cluster.ClusterStateUpdateTask

execute, onNoLongerMaster, runOnlyOnMaster

Methods inherited from class java.lang.Object

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

Constructor Detail

AckedClusterStateUpdateTask

protected AckedClusterStateUpdateTask(AckedRequest request,
                                      ActionListener<Response> listener)

Method Detail

mustAck

public boolean mustAck(DiscoveryNode discoveryNode)

Called to determine which nodes the acknowledgement is expected from

Parameters:

discoveryNode - a node

Returns:

true if the node is expected to send ack back, false otherwise

onAllNodesAcked

public void onAllNodesAcked(@Nullable
                            Throwable t)

Called once all the nodes have acknowledged the cluster state update request. Must be very lightweight execution, since it gets executed on the cluster service thread.

Parameters:

t - optional error that might have been thrown

newResponse

protected abstract Response newResponse(boolean acknowledged)

onAckTimeout

public void onAckTimeout()

Called once the acknowledgement timeout defined by ackTimeout() has expired

onFailure

public void onFailure(String source,
                      Throwable t)

Description copied from class: ClusterStateUpdateTask

A callback called when execute fails.

Specified by:

onFailure in class ClusterStateUpdateTask

clusterStateProcessed

public void clusterStateProcessed(String source,
                                  ClusterState oldState,
                                  ClusterState newState)

Description copied from class: ProcessedClusterStateUpdateTask

Called when the result of the ClusterStateUpdateTask.execute(ClusterState) have been processed properly by all listeners.

Specified by:

clusterStateProcessed in class ProcessedClusterStateUpdateTask

ackTimeout

public TimeValue ackTimeout()

Acknowledgement timeout, maximum time interval to wait for acknowledgements

timeout

public TimeValue timeout()

Description copied from class: TimeoutClusterStateUpdateTask

If the cluster state update task wasn't processed by the provided timeout, call ClusterStateUpdateTask.onFailure(String, Throwable)

Specified by:

timeout in class TimeoutClusterStateUpdateTask