Package org.opensearch.cluster.service

Class ClusterService

java.lang.Object

org.opensearch.common.component.AbstractLifecycleComponent

org.opensearch.cluster.service.ClusterService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable

public class ClusterService
extends AbstractLifecycleComponent

Field Summary

Fields

Modifier and Type	Field	Description
static Setting.AffixSetting<java.lang.String>	USER_DEFINED_METADATA

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

lifecycle

Constructor Summary

Constructors

Constructor	Description
ClusterService(Settings settings, ClusterSettings clusterSettings, MasterService masterService, ClusterApplierService clusterApplierService)
ClusterService(Settings settings, ClusterSettings clusterSettings, ThreadPool threadPool)

Method Summary

Modifier and Type	Method	Description
void	addHighPriorityApplier(ClusterStateApplier applier)	Adds a high priority applier of updated cluster states.
void	addListener(ClusterStateListener listener)	Add a listener for updated cluster states
void	addLocalNodeMasterListener(LocalNodeMasterListener listener)	Add a listener for on/off local node master events
void	addLowPriorityApplier(ClusterStateApplier applier)	Adds an applier which will be called after all high priority and normal appliers have been called.
void	addStateApplier(ClusterStateApplier applier)	Adds a applier of updated cluster states.
static boolean	assertClusterOrMasterStateThread()
protected void	doClose()
protected void	doStart()
protected void	doStop()
ClusterApplierService	getClusterApplierService()
ClusterName	getClusterName()
ClusterSettings	getClusterSettings()
IndexingPressureService	getIndexingPressureService()
MasterService	getMasterService()
java.lang.String	getNodeName()	The name of this node.
RerouteService	getRerouteService()
Settings	getSettings()	The node's settings.
DiscoveryNode	localNode()	The local node.
OperationRouting	operationRouting()
void	removeApplier(ClusterStateApplier applier)	Removes an applier of updated cluster states.
void	removeListener(ClusterStateListener listener)	Removes a listener for updated cluster states.
void	setIndexingPressureService(IndexingPressureService indexingPressureService)	Getter and Setter for IndexingPressureService, This method exposes IndexingPressureService stats to other plugins for usage.
void	setNodeConnectionsService(NodeConnectionsService nodeConnectionsService)
void	setRerouteService(RerouteService rerouteService)
ClusterState	state()	The currently applied cluster state.
<T extends ClusterStateTaskConfig & ClusterStateTaskExecutor<T> & ClusterStateTaskListener> void	submitStateUpdateTask(java.lang.String source, T updateTask)	Submits a cluster state update task; unlike submitStateUpdateTask(String, Object, ClusterStateTaskConfig, ClusterStateTaskExecutor, ClusterStateTaskListener), submitted updates will not be batched.
<T> void	submitStateUpdateTask(java.lang.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.
<T> void	submitStateUpdateTasks(java.lang.String source, java.util.Map<T,ClusterStateTaskListener> tasks, ClusterStateTaskConfig config, ClusterStateTaskExecutor<T> executor)	Submits a batch of cluster state update tasks; submitted updates are guaranteed to be processed together, potentially with more tasks of the same executor.

Methods inherited from class org.opensearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class java.lang.Object

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

Field Details

USER_DEFINED_METADATA

public static final Setting.AffixSetting<java.lang.String> USER_DEFINED_METADATA

Constructor Details

ClusterService

public ClusterService(Settings settings, ClusterSettings clusterSettings, ThreadPool threadPool)

ClusterService

public ClusterService(Settings settings, ClusterSettings clusterSettings, MasterService masterService, ClusterApplierService clusterApplierService)

Method Details

setNodeConnectionsService

public void setNodeConnectionsService(NodeConnectionsService nodeConnectionsService)

setRerouteService

public void setRerouteService(RerouteService rerouteService)

getRerouteService

public RerouteService getRerouteService()

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent

doClose

protected void doClose()

Specified by:

doClose in class AbstractLifecycleComponent

localNode

public DiscoveryNode localNode()

The local node.

operationRouting

public OperationRouting operationRouting()

state

public ClusterState state()

The currently applied cluster state. TODO: Should be renamed to appliedState / appliedClusterState

addHighPriorityApplier

public void addHighPriorityApplier(ClusterStateApplier applier)

Adds a high priority applier of updated cluster states.

addLowPriorityApplier

public void addLowPriorityApplier(ClusterStateApplier applier)

Adds an applier which will be called after all high priority and normal appliers have been called.

addStateApplier

public void addStateApplier(ClusterStateApplier applier)

Adds a applier of updated cluster states.

removeApplier

public void removeApplier(ClusterStateApplier applier)

Removes an applier of updated cluster states.

addListener

public void addListener(ClusterStateListener listener)

Add a listener for updated cluster states

removeListener

public void removeListener(ClusterStateListener listener)

Removes a listener for updated cluster states.

addLocalNodeMasterListener

public void addLocalNodeMasterListener(LocalNodeMasterListener listener)

Add a listener for on/off local node master events

getMasterService

public MasterService getMasterService()

setIndexingPressureService

public void setIndexingPressureService(IndexingPressureService indexingPressureService)

Getter and Setter for IndexingPressureService, This method exposes IndexingPressureService stats to other plugins for usage. Although Indexing Pressure instances can be accessed via Node and NodeService class but none of them are present in the createComponents signature of Plugin interface currently. Plugin.createComponents(org.opensearch.client.Client, org.opensearch.cluster.service.ClusterService, org.opensearch.threadpool.ThreadPool, org.opensearch.watcher.ResourceWatcherService, org.opensearch.script.ScriptService, org.opensearch.common.xcontent.NamedXContentRegistry, org.opensearch.env.Environment, org.opensearch.env.NodeEnvironment, org.opensearch.common.io.stream.NamedWriteableRegistry, org.opensearch.cluster.metadata.IndexNameExpressionResolver, java.util.function.Supplier<org.opensearch.repositories.RepositoriesService>) Going forward, IndexingPressureService will have required constructs for exposing listeners/interfaces for plugin development.(#478)

getIndexingPressureService

public IndexingPressureService getIndexingPressureService()

getClusterApplierService

public ClusterApplierService getClusterApplierService()

assertClusterOrMasterStateThread

public static boolean assertClusterOrMasterStateThread()

getClusterName

public ClusterName getClusterName()

getClusterSettings

public ClusterSettings getClusterSettings()

getSettings

public Settings getSettings()

The node's settings.

getNodeName

public final java.lang.String getNodeName()

The name of this node.

submitStateUpdateTask

public <T extends ClusterStateTaskConfig & ClusterStateTaskExecutor<T> & ClusterStateTaskListener> void submitStateUpdateTask(java.lang.String source, T 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

submitStateUpdateTask

public <T> void submitStateUpdateTask(java.lang.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

submitStateUpdateTasks

public <T> void submitStateUpdateTasks(java.lang.String source, java.util.Map<T,ClusterStateTaskListener> tasks, ClusterStateTaskConfig config, ClusterStateTaskExecutor<T> executor)

Submits a batch of cluster state update tasks; submitted updates are guaranteed to be processed together, potentially with more tasks of the same executor.

Type Parameters:

T - the type of the cluster state update task state

Parameters:

source - the source of the cluster state update task

tasks - a map of update tasks and their corresponding listeners

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