org.elasticsearch.cluster.service

Class InternalClusterService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent<ClusterService>

org.elasticsearch.cluster.service.InternalClusterService

All Implemented Interfaces:

AutoCloseable, ClusterService, LifecycleComponent<ClusterService>, Releasable

public class InternalClusterService
extends AbstractLifecycleComponent<ClusterService>
implements ClusterService

Field Summary

Fields

Modifier and Type	Field and Description
static String	SETTING_CLUSTER_SERVICE_RECONNECT_INTERVAL
static String	SETTING_CLUSTER_SERVICE_SLOW_TASK_LOGGING_THRESHOLD
static String	UPDATE_THREAD_NAME

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
InternalClusterService(Settings settings, DiscoveryService discoveryService, OperationRouting operationRouting, TransportService transportService, NodeSettingsService nodeSettingsService, ThreadPool threadPool, ClusterName clusterName, DiscoveryNodeService discoveryNodeService, Version version)

Method Summary

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.
boolean	assertClusterStateThread() asserts that the current thread is the cluster state update thread
protected void	doClose()
protected void	doStart()
protected void	doStop()
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.
NodeSettingsService	settingsService()
ClusterState	state() The current state.
void	submitStateUpdateTask(String source, ClusterStateUpdateTask updateTask) Submits a cluster state update task; unlike ClusterService.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 class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

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

addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

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

close

Field Detail

SETTING_CLUSTER_SERVICE_SLOW_TASK_LOGGING_THRESHOLD

public static final String SETTING_CLUSTER_SERVICE_SLOW_TASK_LOGGING_THRESHOLD

See Also:

Constant Field Values

SETTING_CLUSTER_SERVICE_RECONNECT_INTERVAL

public static final String SETTING_CLUSTER_SERVICE_RECONNECT_INTERVAL

See Also:

Constant Field Values

UPDATE_THREAD_NAME

public static final String UPDATE_THREAD_NAME

See Also:

Constant Field Values

Constructor Detail

InternalClusterService

@Inject
public InternalClusterService(Settings settings,
                                      DiscoveryService discoveryService,
                                      OperationRouting operationRouting,
                                      TransportService transportService,
                                      NodeSettingsService nodeSettingsService,
                                      ThreadPool threadPool,
                                      ClusterName clusterName,
                                      DiscoveryNodeService discoveryNodeService,
                                      Version version)

Method Detail

settingsService

public NodeSettingsService settingsService()

addInitialStateBlock

public void addInitialStateBlock(ClusterBlock block)
                          throws IllegalStateException

Description copied from interface: ClusterService

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

Specified by:

addInitialStateBlock in interface ClusterService

Throws:

IllegalStateException

removeInitialStateBlock

public void removeInitialStateBlock(ClusterBlock block)
                             throws IllegalStateException

Description copied from interface: ClusterService

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

Specified by:

removeInitialStateBlock in interface ClusterService

Throws:

IllegalStateException

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent<ClusterService>

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent<ClusterService>

doClose

protected void doClose()

Specified by:

doClose in class AbstractLifecycleComponent<ClusterService>

localNode

public DiscoveryNode localNode()

Description copied from interface: ClusterService

The local node.

Specified by:

localNode in interface ClusterService

operationRouting

public OperationRouting operationRouting()

Description copied from interface: ClusterService

The operation routing.

Specified by:

operationRouting in interface ClusterService

state

public ClusterState state()

Description copied from interface: ClusterService

The current state.

Specified by:

state in interface ClusterService

addFirst

public void addFirst(ClusterStateListener listener)

Description copied from interface: ClusterService

Adds a priority listener for updated cluster states.

Specified by:

addFirst in interface ClusterService

addLast

public void addLast(ClusterStateListener listener)

Description copied from interface: ClusterService

Adds last listener.

Specified by:

addLast in interface ClusterService

add

public void add(ClusterStateListener listener)

Description copied from interface: ClusterService

Adds a listener for updated cluster states.

Specified by:

add in interface ClusterService

remove

public void remove(ClusterStateListener listener)

Description copied from interface: ClusterService

Removes a listener for updated cluster states.

Specified by:

remove in interface ClusterService

add

public void add(LocalNodeMasterListener listener)

Description copied from interface: ClusterService

Add a listener for on/off local node master events

Specified by:

add in interface ClusterService

remove

public void remove(LocalNodeMasterListener listener)

Description copied from interface: ClusterService

Remove the given listener for on/off local master events

Specified by:

remove in interface ClusterService

add

public void add(@Nullable
                TimeValue timeout,
                TimeoutClusterStateListener listener)

Description copied from interface: ClusterService

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

Specified by:

add in interface ClusterService

submitStateUpdateTask

public void submitStateUpdateTask(String source,
                                  ClusterStateUpdateTask updateTask)

Description copied from interface: ClusterService

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

Specified by:

submitStateUpdateTask in interface ClusterService

Parameters:

source - the source of the cluster state update task

updateTask - the full context for the cluster state update task

submitStateUpdateTask

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

Description copied from interface: ClusterService

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

Specified by:

submitStateUpdateTask in interface ClusterService

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

pendingTasks

public List<PendingClusterTask> pendingTasks()

Description copied from interface: ClusterService

Returns the tasks that are pending.

Specified by:

pendingTasks in interface ClusterService

numberOfPendingTasks

public int numberOfPendingTasks()

Description copied from interface: ClusterService

Returns the number of currently pending tasks.

Specified by:

numberOfPendingTasks in interface ClusterService

getMaxTaskWaitTime

public TimeValue getMaxTaskWaitTime()

Description copied from interface: ClusterService

Returns the maximum wait time for tasks in the queue

Specified by:

getMaxTaskWaitTime in interface ClusterService

Returns:

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

getTaskManager

public TaskManager getTaskManager()

Description copied from interface: ClusterService

Returns task manager created in the cluster service

Specified by:

getTaskManager in interface ClusterService

assertClusterStateThread

public boolean assertClusterStateThread()

asserts that the current thread is the cluster state update thread