org.elasticsearch.tasks

Class TaskManager

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.tasks.TaskManager

All Implemented Interfaces:

ClusterStateListener

public class TaskManager
extends AbstractComponent
implements ClusterStateListener

Task Manager service for keeping track of currently running tasks on the nodes

Field Summary

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
TaskManager(Settings settings)

Method Summary

Modifier and Type	Method and Description
Set<String>	cancel(CancellableTask task, String reason, Consumer<Set<String>> listener) Cancels a task
void	clusterChanged(ClusterChangedEvent event) Called when cluster state changes.
int	getBanCount() Returns the number of currently banned tasks.
CancellableTask	getCancellableTask(long id) Returns a cancellable task with given id, or null if the task is not found.
Map<Long,CancellableTask>	getCancellableTasks() Returns the list of currently running tasks on the node that can be cancelled
Task	getTask(long id) Returns a task with given id, or null if the task is not found.
Map<Long,Task>	getTasks() Returns the list of currently running tasks on the node
Task	register(String type, String action, TransportRequest request) Registers a task without parent task
void	registerChildTask(Task task, String node)
void	removeBan(TaskId parentTaskId) Removes the ban for the specified parent task.
void	setBan(TaskId parentTaskId, String reason) Bans all tasks with the specified parent task from execution, cancels all tasks that are currently executing.
Task	unregister(Task task) Unregister the task

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

Constructor Detail

TaskManager

public TaskManager(Settings settings)

Method Detail

register

public Task register(String type,
                     String action,
                     TransportRequest request)

Registers a task without parent task

Returns the task manager tracked task or null if the task doesn't support the task manager

cancel

public Set<String> cancel(CancellableTask task,
                          String reason,
                          Consumer<Set<String>> listener)

Cancels a task

Returns a set of nodes with child tasks where this task should be cancelled if cancellation was successful, null otherwise.

unregister

public Task unregister(Task task)

Unregister the task

getTasks

public Map<Long,Task> getTasks()

Returns the list of currently running tasks on the node

getCancellableTasks

public Map<Long,CancellableTask> getCancellableTasks()

Returns the list of currently running tasks on the node that can be cancelled

getTask

public Task getTask(long id)

Returns a task with given id, or null if the task is not found.

getCancellableTask

public CancellableTask getCancellableTask(long id)

Returns a cancellable task with given id, or null if the task is not found.

getBanCount

public int getBanCount()

Returns the number of currently banned tasks.

Will be used in task manager stats and for debugging.

setBan

public void setBan(TaskId parentTaskId,
                   String reason)

Bans all tasks with the specified parent task from execution, cancels all tasks that are currently executing.

This method is called when a parent task that has children is cancelled.

removeBan

public void removeBan(TaskId parentTaskId)

Removes the ban for the specified parent task.

This method is called when a previously banned task finally cancelled

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

Description copied from interface: ClusterStateListener

Called when cluster state changes.

Specified by:

clusterChanged in interface ClusterStateListener

registerChildTask

public void registerChildTask(Task task,
                              String node)