Package org.opensearch.cluster.service

Class ClusterApplierService

java.lang.Object

org.opensearch.common.component.AbstractLifecycleComponent

org.opensearch.cluster.service.ClusterApplierService

All Implemented Interfaces:

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

public class ClusterApplierService
extends AbstractLifecycleComponent
implements ClusterApplier

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.cluster.service.ClusterApplier

ClusterApplier.ClusterApplyListener

Field Summary

Fields

Modifier and Type	Field	Description
static Setting<org.opensearch.common.unit.TimeValue>	CLUSTER_SERVICE_SLOW_TASK_LOGGING_THRESHOLD_SETTING
static java.lang.String	CLUSTER_UPDATE_THREAD_NAME
protected ThreadPool	threadPool

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

lifecycle

Constructor Summary

Constructors

Constructor	Description
ClusterApplierService(java.lang.String nodeName, 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.
void	addTimeoutListener(org.opensearch.common.unit.TimeValue timeout, TimeoutClusterStateListener listener)	Adds a cluster state listener that is expected to be removed during a short period of time.
protected boolean	applicationMayFail()
static boolean	assertNotClusterStateUpdateThread(java.lang.String reason)	asserts that the current thread is NOT the cluster state update thread
protected void	connectToNodesAndWait(ClusterState newClusterState)
protected PrioritizedOpenSearchThreadPoolExecutor	createThreadPoolExecutor()
protected long	currentTimeInMillis()
protected void	doClose()
protected void	doStart()
protected void	doStop()
boolean	isInitialClusterStateSet()	Returns true if the appliedClusterState is not null
void	onNewClusterState(java.lang.String source, java.util.function.Supplier<ClusterState> clusterStateSupplier, ClusterApplier.ClusterApplyListener listener)	Method to invoke when a new cluster state is available to be applied
void	removeApplier(ClusterStateApplier applier)	Removes an applier of updated cluster states.
void	removeListener(ClusterStateListener listener)	Removes a listener for updated cluster states.
void	removeTimeoutListener(TimeoutClusterStateListener listener)	Removes a timeout listener for updated cluster states.
void	runOnApplierThread(java.lang.String source, java.util.function.Consumer<ClusterState> clusterStateConsumer, ClusterApplier.ClusterApplyListener listener)
void	runOnApplierThread(java.lang.String source, java.util.function.Consumer<ClusterState> clusterStateConsumer, ClusterApplier.ClusterApplyListener listener, Priority priority)
void	setInitialState(ClusterState initialState)	Sets the initial state for this applier.
void	setNodeConnectionsService(NodeConnectionsService nodeConnectionsService)
ClusterState	state()	The current cluster state.
ThreadPool	threadPool()

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

CLUSTER_SERVICE_SLOW_TASK_LOGGING_THRESHOLD_SETTING

public static final Setting<org.opensearch.common.unit.TimeValue> CLUSTER_SERVICE_SLOW_TASK_LOGGING_THRESHOLD_SETTING

CLUSTER_UPDATE_THREAD_NAME

public static final java.lang.String CLUSTER_UPDATE_THREAD_NAME

See Also:

Constant Field Values

threadPool

protected final ThreadPool threadPool

Constructor Details

ClusterApplierService

public ClusterApplierService(java.lang.String nodeName, Settings settings, ClusterSettings clusterSettings, ThreadPool threadPool)

Method Details

setNodeConnectionsService

public void setNodeConnectionsService(NodeConnectionsService nodeConnectionsService)

setInitialState

public void setInitialState(ClusterState initialState)

Description copied from interface: ClusterApplier

Sets the initial state for this applier. Should only be called once.

Specified by:

setInitialState in interface ClusterApplier

Parameters:

initialState - the initial state to set

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent

createThreadPoolExecutor

protected PrioritizedOpenSearchThreadPoolExecutor createThreadPoolExecutor()

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent

doClose

protected void doClose()

Specified by:

doClose in class AbstractLifecycleComponent

state

public ClusterState state()

The current cluster state. Should be renamed to appliedClusterState

isInitialClusterStateSet

public boolean isInitialClusterStateSet()

Returns true if the appliedClusterState is not null

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.

removeTimeoutListener

public void removeTimeoutListener(TimeoutClusterStateListener listener)

Removes a timeout listener for updated cluster states.

addLocalNodeMasterListener

public void addLocalNodeMasterListener(LocalNodeMasterListener listener)

Add a listener for on/off local node master events

addTimeoutListener

public void addTimeoutListener(@Nullable org.opensearch.common.unit.TimeValue timeout, TimeoutClusterStateListener listener)

Adds a cluster state listener that is expected to be removed during a short period of time. If provided, the listener will be notified once a specific time has elapsed. NOTE: the listener is not removed on timeout. This is the responsibility of the caller.

runOnApplierThread

public void runOnApplierThread(java.lang.String source, java.util.function.Consumer<ClusterState> clusterStateConsumer, ClusterApplier.ClusterApplyListener listener, Priority priority)

runOnApplierThread

public void runOnApplierThread(java.lang.String source, java.util.function.Consumer<ClusterState> clusterStateConsumer, ClusterApplier.ClusterApplyListener listener)

threadPool

public ThreadPool threadPool()

onNewClusterState

public void onNewClusterState(java.lang.String source, java.util.function.Supplier<ClusterState> clusterStateSupplier, ClusterApplier.ClusterApplyListener listener)

Description copied from interface: ClusterApplier

Method to invoke when a new cluster state is available to be applied

Specified by:

onNewClusterState in interface ClusterApplier

Parameters:

source - information where the cluster state came from

clusterStateSupplier - the cluster state supplier which provides the latest cluster state to apply

listener - callback that is invoked after cluster state is applied

assertNotClusterStateUpdateThread

public static boolean assertNotClusterStateUpdateThread(java.lang.String reason)

asserts that the current thread is NOT the cluster state update thread

connectToNodesAndWait

protected void connectToNodesAndWait(ClusterState newClusterState)

currentTimeInMillis

protected long currentTimeInMillis()

applicationMayFail

protected boolean applicationMayFail()