Module org.elasticsearch.server

Package org.elasticsearch.persistent

Class PersistentTaskLifecycleManager

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.persistent.PersistentTaskLifecycleManager

All Implemented Interfaces:

Closeable, AutoCloseable, ClusterStateListener, LifecycleComponent, Releasable

public final class PersistentTaskLifecycleManager
extends AbstractLifecycleComponent
implements ClusterStateListener

Field Summary

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

lifecycle

Constructor Summary

Constructors

Constructor	Description
PersistentTaskLifecycleManager(PersistentTasksService persistentTasksService, ClusterService clusterService)

Method Summary

Modifier and Type	Method	Description
void	clusterChanged(ClusterChangedEvent event)	Called when cluster state changes.
protected void	doClose()	Close this component.
protected void	doStart()	Start this component.
protected void	doStop()	Stop this component.
void	registerClusterTask(String taskName, Setting<Boolean> enabledSetting, Supplier<? extends PersistentTaskParams> paramsSupplier)
void	registerProjectTask(String taskName, Function<ProjectId,String> taskIdFn, Setting<Boolean> enabledSetting, Supplier<? extends PersistentTaskParams> paramsSupplier)
void	registerProjectTask(String taskName, Function<ProjectId,String> taskIdFn, Setting<Boolean> enabledSetting, Supplier<? extends PersistentTaskParams> paramsSupplier, Consumer<ProjectId> onRemove)

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

addLifecycleListener, close, lifecycleState, start, stop

Methods inherited from class java.lang.Object

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

Constructor Details

PersistentTaskLifecycleManager

public PersistentTaskLifecycleManager(PersistentTasksService persistentTasksService,
 ClusterService clusterService)

Method Details

doStart

protected void doStart()

Description copied from class: AbstractLifecycleComponent

Start this component. Typically that means doing things like launching background processes and registering listeners on other components. Other components have been initialized by this point, but may not yet be started.

If this method throws an exception then the startup process will fail, but this component will not be stopped before it is closed.

This method is called while synchronized on AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, although it may not be called at all if the startup process encountered some kind of fatal error, such as the failure of some other component to initialize or start.

Specified by:

doStart in class AbstractLifecycleComponent

doStop

protected void doStop()

Description copied from class: AbstractLifecycleComponent

Stop this component. Typically that means doing the reverse of whatever AbstractLifecycleComponent.doStart() does.

This method is called while synchronized on AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, after calling AbstractLifecycleComponent.doStart(), although it will not be called at all if this component did not successfully start.

Specified by:

doStop in class AbstractLifecycleComponent

doClose

protected void doClose()

Description copied from class: AbstractLifecycleComponent

Close this component. Typically that means doing the reverse of whatever happened during initialization, such as releasing resources acquired there.

This method is called while synchronized on AbstractLifecycleComponent.lifecycle. It is called once in the lifetime of a component. If the component was started then it will be stopped before it is closed, and once it is closed it will not be started or stopped.

Specified by:

doClose in class AbstractLifecycleComponent

registerClusterTask

public void registerClusterTask(String taskName,
 Setting<Boolean> enabledSetting,
 Supplier<? extends PersistentTaskParams> paramsSupplier)

registerProjectTask

public void registerProjectTask(String taskName,
 Function<ProjectId,String> taskIdFn,
 Setting<Boolean> enabledSetting,
 Supplier<? extends PersistentTaskParams> paramsSupplier)

registerProjectTask

public void registerProjectTask(String taskName,
 Function<ProjectId,String> taskIdFn,
 Setting<Boolean> enabledSetting,
 Supplier<? extends PersistentTaskParams> paramsSupplier,
 Consumer<ProjectId> onRemove)

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

Description copied from interface: ClusterStateListener

Called when cluster state changes.

Cluster states are applied one-by-one which means they can be a performance bottleneck. Implementations of this method should therefore be fast, so please consider forking work into the background rather than doing everything inline.

Specified by:

clusterChanged in interface ClusterStateListener