org.elasticsearch.cluster

Class ClusterStateTaskExecutor<T>

java.lang.Object

org.elasticsearch.cluster.ClusterStateTaskExecutor<T>

Direct Known Subclasses:

ClusterStateUpdateTask

public abstract class ClusterStateTaskExecutor<T>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterStateTaskExecutor.BatchResult<T> Represents the result of a batched execution of cluster state update tasks
static class	ClusterStateTaskExecutor.TaskResult

Constructor Summary

Constructors

Constructor and Description
ClusterStateTaskExecutor()

Method Summary

Methods

Modifier and Type	Method and Description
void	clusterStatePublished(ClusterState newClusterState) Callback invoked after new cluster state is published.
abstract ClusterStateTaskExecutor.BatchResult<T>	execute(ClusterState currentState, List<T> tasks) Update the cluster state based on the current state and the given tasks.
boolean	runOnlyOnMaster() indicates whether this task should only run if current node is master

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterStateTaskExecutor

public ClusterStateTaskExecutor()

Method Detail

execute

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

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

Throws:

Exception

runOnlyOnMaster

public boolean runOnlyOnMaster()

indicates whether this task should only run if current node is master

clusterStatePublished

public void clusterStatePublished(ClusterState newClusterState)

Callback invoked after new cluster state is published. Note that this method is not invoked if the cluster state was not updated.