org.elasticsearch.cluster

Interface ClusterService

All Superinterfaces:

AutoCloseable, LifecycleComponent<ClusterService>, Releasable

All Known Implementing Classes:

InternalClusterService

public interface ClusterService
extends LifecycleComponent<ClusterService>

The cluster service allowing to both register for cluster state events (ClusterStateListener) and submit state update tasks (ClusterStateUpdateTask.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ClusterStateListener listener) Adds a listener for updated cluster states.
void	add(LocalNodeMasterListener listener) Add a listener for on/off local node master events
void	add(TimeValue timeout, TimeoutClusterStateListener listener) Adds a cluster state listener that will timeout after the provided timeout, and is executed after the clusterstate has been successfully applied ie.
void	addFirst(ClusterStateListener listener) Adds a priority listener for updated cluster states.
void	addInitialStateBlock(ClusterBlock block) Adds an initial block to be set on the first cluster state created.
void	addLast(ClusterStateListener listener) Adds last listener.
TimeValue	getMaxTaskWaitTime() Returns the maximum wait time for tasks in the queue
TaskManager	getTaskManager() Returns task manager created in the cluster service
DiscoveryNode	localNode() The local node.
int	numberOfPendingTasks() Returns the number of currently pending tasks.
OperationRouting	operationRouting() The operation routing.
List<PendingClusterTask>	pendingTasks() Returns the tasks that are pending.
void	remove(ClusterStateListener listener) Removes a listener for updated cluster states.
void	remove(LocalNodeMasterListener listener) Remove the given listener for on/off local master events
void	removeInitialStateBlock(ClusterBlock block) Remove an initial block to be set on the first cluster state created.
ClusterState	state() The current state.
void	submitStateUpdateTask(String source, ClusterStateUpdateTask updateTask) Submits a cluster state update task; unlike submitStateUpdateTask(String, Object, ClusterStateTaskConfig, ClusterStateTaskExecutor, ClusterStateTaskListener), submitted updates will not be batched.
<T> void	submitStateUpdateTask(String source, T task, ClusterStateTaskConfig config, ClusterStateTaskExecutor<T> executor, ClusterStateTaskListener listener) Submits a cluster state update task; submitted updates will be batched across the same instance of executor.

Methods inherited from interface org.elasticsearch.common.component.LifecycleComponent

addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from interface org.elasticsearch.common.lease.Releasable

close

Method Detail

localNode

DiscoveryNode localNode()

The local node.

state

ClusterState state()

The current state.

addInitialStateBlock

void addInitialStateBlock(ClusterBlock block)
                          throws IllegalStateException

Adds an initial block to be set on the first cluster state created.

Throws:

IllegalStateException

removeInitialStateBlock

void removeInitialStateBlock(ClusterBlock block)
                             throws IllegalStateException

Remove an initial block to be set on the first cluster state created.

Throws:

IllegalStateException

operationRouting

OperationRouting operationRouting()

The operation routing.

addFirst

void addFirst(ClusterStateListener listener)

Adds a priority listener for updated cluster states.

addLast

void addLast(ClusterStateListener listener)

Adds last listener.

add

void add(ClusterStateListener listener)

Adds a listener for updated cluster states.

remove

void remove(ClusterStateListener listener)

Removes a listener for updated cluster states.

add

void add(LocalNodeMasterListener listener)

Add a listener for on/off local node master events

remove

void remove(LocalNodeMasterListener listener)

Remove the given listener for on/off local master events

add

void add(@Nullable
       TimeValue timeout,
       TimeoutClusterStateListener listener)

Adds a cluster state listener that will timeout after the provided timeout, and is executed after the clusterstate has been successfully applied ie. is in state ClusterState.ClusterStateStatus.APPLIED NOTE: a null timeout means that the listener will never be removed automatically

submitStateUpdateTask

<T> void submitStateUpdateTask(String source,
                             T task,
                             ClusterStateTaskConfig config,
                             ClusterStateTaskExecutor<T> executor,
                             ClusterStateTaskListener listener)

Submits a cluster state update task; submitted updates will be batched across the same instance of executor. The exact batching semantics depend on the underlying implementation but a rough guideline is that if the update task is submitted while there are pending update tasks for the same executor, these update tasks will all be executed on the executor in a single batch

Type Parameters:

T - the type of the cluster state update task state

Parameters:

source - the source of the cluster state update task

task - the state needed for the cluster state update task

config - the cluster state update task configuration

executor - the cluster state update task executor; tasks that share the same executor will be executed batches on this executor

listener - callback after the cluster state update task completes

submitStateUpdateTask

void submitStateUpdateTask(String source,
                         ClusterStateUpdateTask updateTask)

Submits a cluster state update task; unlike submitStateUpdateTask(String, Object, ClusterStateTaskConfig, ClusterStateTaskExecutor, ClusterStateTaskListener), submitted updates will not be batched.

Parameters:

source - the source of the cluster state update task

updateTask - the full context for the cluster state update task

pendingTasks

List<PendingClusterTask> pendingTasks()

Returns the tasks that are pending.

numberOfPendingTasks

int numberOfPendingTasks()

Returns the number of currently pending tasks.

getMaxTaskWaitTime

TimeValue getMaxTaskWaitTime()

Returns the maximum wait time for tasks in the queue

Returns:

A zero time value if the queue is empty, otherwise the time value oldest task waiting in the queue

getTaskManager

TaskManager getTaskManager()

Returns task manager created in the cluster service