org.elasticsearch.cluster

Class ClusterStateUpdateTask

java.lang.Object

org.elasticsearch.cluster.ClusterStateTaskExecutor<ClusterStateUpdateTask>

org.elasticsearch.cluster.ClusterStateUpdateTask

All Implemented Interfaces:

ClusterStateTaskConfig, ClusterStateTaskListener

Direct Known Subclasses:

AckedClusterStateUpdateTask, ClusterStateNonMasterUpdateTask

public abstract class ClusterStateUpdateTask
extends ClusterStateTaskExecutor<ClusterStateUpdateTask>
implements ClusterStateTaskConfig, ClusterStateTaskListener

A task that can update the cluster state.

Nested Class Summary

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

ClusterStateTaskExecutor.BatchResult<T>, ClusterStateTaskExecutor.TaskResult

Constructor Summary

Constructors

Constructor and Description
ClusterStateUpdateTask()
ClusterStateUpdateTask(Priority priority)

Method Summary

Modifier and Type	Method and Description
void	clusterStateProcessed(String source, ClusterState oldState, ClusterState newState) Called when the result of the ClusterStateTaskExecutor.execute(ClusterState, List) have been processed properly by all listeners.
abstract ClusterState	execute(ClusterState currentState) Update the cluster state based on the current state.
ClusterStateTaskExecutor.BatchResult<ClusterStateUpdateTask>	execute(ClusterState currentState, List<ClusterStateUpdateTask> tasks) Update the cluster state based on the current state and the given tasks.
abstract void	onFailure(String source, Throwable t) A callback called when execute fails.
void	onNoLongerMaster(String source) called when the task was rejected because the local node is no longer master
Priority	priority() The Priority for this cluster state update task configuration.
TimeValue	timeout() If the cluster state update task wasn't processed by the provided timeout, call onFailure(String, Throwable).

Methods inherited from class org.elasticsearch.cluster.ClusterStateTaskExecutor

clusterStatePublished, runOnlyOnMaster

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterStateUpdateTask

public ClusterStateUpdateTask()

ClusterStateUpdateTask

public ClusterStateUpdateTask(Priority priority)

Method Detail

execute

public final ClusterStateTaskExecutor.BatchResult<ClusterStateUpdateTask> execute(ClusterState currentState,
                                                                                  List<ClusterStateUpdateTask> tasks)
                                                                           throws Exception

Description copied from class: ClusterStateTaskExecutor

Update the cluster state based on the current state and the given tasks. Return the *same instance* if no state should be changed.

Specified by:

execute in class ClusterStateTaskExecutor<ClusterStateUpdateTask>

Throws:

Exception

execute

public abstract ClusterState execute(ClusterState currentState)
                              throws Exception

Update the cluster state based on the current state. Return the *same instance* if no state should be changed.

Throws:

Exception

onFailure

public abstract void onFailure(String source,
                               Throwable t)

A callback called when execute fails.

Specified by:

onFailure in interface ClusterStateTaskListener

onNoLongerMaster

public void onNoLongerMaster(String source)

Description copied from interface: ClusterStateTaskListener

called when the task was rejected because the local node is no longer master

Specified by:

onNoLongerMaster in interface ClusterStateTaskListener

clusterStateProcessed

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

Description copied from interface: ClusterStateTaskListener

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

Specified by:

clusterStateProcessed in interface ClusterStateTaskListener

timeout

@Nullable
public TimeValue timeout()

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

Specified by:

timeout in interface ClusterStateTaskConfig

Returns:

the timeout, or null if one is not set

priority

public Priority priority()

Description copied from interface: ClusterStateTaskConfig

The Priority for this cluster state update task configuration.

Specified by:

priority in interface ClusterStateTaskConfig

Returns:

the priority