org.elasticsearch.cluster

Class AckedClusterStateUpdateTask<Response>

java.lang.Object

org.elasticsearch.cluster.ClusterStateUpdateTask

org.elasticsearch.cluster.AckedClusterStateUpdateTask<Response>

All Implemented Interfaces:

AckedClusterStateTaskListener, ClusterStateTaskConfig, ClusterStateTaskExecutor<ClusterStateUpdateTask>, ClusterStateTaskListener

public abstract class AckedClusterStateUpdateTask<Response>
extends ClusterStateUpdateTask
implements AckedClusterStateTaskListener

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.ClusterStateTaskConfig

ClusterStateTaskConfig.Basic

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.ClusterStateTaskExecutor

ClusterStateTaskExecutor.ClusterTasksResult<T>, ClusterStateTaskExecutor.TaskResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
TimeValue	ackTimeout() Acknowledgement timeout, maximum time interval to wait for acknowledgements
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(java.lang.Exception e) Called once all the nodes have acknowledged the cluster state update request.
void	onFailure(java.lang.String source, java.lang.Exception e) A callback called when execute fails.
TimeValue	timeout() If the cluster state update task wasn't processed by the provided timeout, call ClusterStateTaskListener.onFailure(String, Exception).

Methods inherited from class org.elasticsearch.cluster.ClusterStateUpdateTask

describeTasks, execute, execute, priority, runOnlyOnMaster

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.ClusterStateTaskListener

clusterStateProcessed, onNoLongerMaster

Methods inherited from interface org.elasticsearch.cluster.ClusterStateTaskConfig

build, build

Methods inherited from interface org.elasticsearch.cluster.ClusterStateTaskExecutor

clusterStatePublished

Constructor Detail

AckedClusterStateUpdateTask

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

AckedClusterStateUpdateTask

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

Method Detail

mustAck

public boolean mustAck(DiscoveryNode discoveryNode)

Called to determine which nodes the acknowledgement is expected from

Specified by:

mustAck in interface AckedClusterStateTaskListener

Parameters:

discoveryNode - a node

Returns:

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

onAllNodesAcked

public void onAllNodesAcked(@Nullable
                            java.lang.Exception e)

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.

Specified by:

onAllNodesAcked in interface AckedClusterStateTaskListener

Parameters:

e - 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

Specified by:

onAckTimeout in interface AckedClusterStateTaskListener

onFailure

public void onFailure(java.lang.String source,
                      java.lang.Exception e)

Description copied from class: ClusterStateUpdateTask

A callback called when execute fails.

Specified by:

onFailure in interface ClusterStateTaskListener

Specified by:

onFailure in class ClusterStateUpdateTask

ackTimeout

public TimeValue ackTimeout()

Acknowledgement timeout, maximum time interval to wait for acknowledgements

Specified by:

ackTimeout in interface AckedClusterStateTaskListener

timeout

public TimeValue timeout()

Description copied from class: ClusterStateUpdateTask

If the cluster state update task wasn't processed by the provided timeout, call ClusterStateTaskListener.onFailure(String, Exception). May return null to indicate no timeout is needed (default).

Specified by:

timeout in interface ClusterStateTaskConfig

Overrides:

timeout in class ClusterStateUpdateTask

Returns:

the timeout, or null if one is not set