Summary: Methods | [Expand All]
public interface

TaskManager

com.atlassian.jira.task.TaskManager
Known Indirect Subclasses

Class Overview

The TaskManager contains a collection of tasks that are long running. It schedules them to run at its discretion, but it does try to run them as soon as possible, assuming there is sufficient resources available.

Tasks are described operationally by TaskDescriptor.

NOTE: All task descriptors returned are a snapshot of the task state when the method returns. So while the task may finish, the TaskDescriptor will not be updated to reflect that. You must always re-ask the TaskManager for a new TaskDescriptor to find out if a task has finished or not.

Summary

Public Methods
boolean awaitUntilActiveTasksComplete(long seconds)
Waits on the TaskManager until all current active tasks are completed.
void cancelTask(Long taskId)
Cancel a running task.
void cancelTaskIfRunningLocally(Long taskId)
Cancel a running task if it is running on this cluster node.
TaskDescriptor<?> findFirstTask(TaskMatcher matcher)
Find the first task that "matches" according to the passed matcher.
Collection<TaskDescriptor<?>> findTasks(TaskMatcher matcher)
Find all the tasks that "match" according to the passed matcher.
Collection<TaskDescriptor<?>> getAllTasks()
Return a collection of TaskDescriptors currently within the manager.
<V extends Serializable> TaskDescriptor<V> getLiveTask(TaskContext taskContext)
Return the live task associated with the passed context, if one exists.
Collection<TaskDescriptor<?>> getLiveTasks()
Return a collection of sumitted or running TaskDescriptors in the manager.
<V extends Serializable> TaskDescriptor<V> getTask(Long taskId)
Returns the TaskDescriptor of the task that is identified by the passed id.
boolean hasLiveTaskWithContext(TaskContext taskContext)
Returns true if the there are live tasks (running or submitted) that have a task context that is EQUAL to the passed in taskContext.
boolean hasTaskWithContext(TaskContext taskContext)
Returns true if the there are any tasks (submitted, running or finished) that have a task context that is EQUAL to the passed in taskContext.
boolean isCancellable(Long taskId)
Returns true if the task can be cancelled.
boolean isCancelled(Long taskId)
Return true if this task has been cancelled.
void removeTask(Long taskId)
Remove a task from the manager.
boolean shutdownAndWait(long waitSeconds)
Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
void shutdownNow()
Attempts to aggressively stop all actively executing tasks, halts the processing of waiting tasks.
void start()
Start the task manager.
<V extends Serializable> TaskDescriptor<V> submitTask(Callable<V> callable, String taskDescription, TaskContext taskContext)
This submits a Callable task to the manager which can then be started at the managers discretion, but hopefully very soon.
<V extends Serializable> TaskDescriptor<V> submitTask(Callable<V> callable, String taskDescription, TaskContext taskContext, boolean cancellable)
This submits a Callable task to the manager which can then be started at the managers discretion, but hopefully very soon.
void waitUntilTaskCompletes(Long taskId)
Wait for a specific task to complete.

Public Methods

public boolean awaitUntilActiveTasksComplete (long seconds)

Waits on the TaskManager until all current active tasks are completed. Calling this method does not stop tasks being added.

Parameters
seconds the number of seconds to wait.
Returns
  • true if all the active tasks are completed before the timeout, false otherwise.

public void cancelTask (Long taskId)

Cancel a running task. If the task is not running this message is a no-op.

Parameters
taskId the task identifier.
Throws
IllegalStateException if the task is not cancellable

public void cancelTaskIfRunningLocally (Long taskId)

Cancel a running task if it is running on this cluster node.

Parameters
taskId the task identifier.

public TaskDescriptor<?> findFirstTask (TaskMatcher matcher)

Find the first task that "matches" according to the passed matcher.

Parameters
matcher the condition used to find the task.
Returns
  • the first task that "matches" according to the passed matcher. The descriptor returned is a snapshot of the task state when the method returns will not reflect any future changes. null will be returned when no matching task can be found.

public Collection<TaskDescriptor<?>> findTasks (TaskMatcher matcher)

Find all the tasks that "match" according to the passed matcher.

Parameters
matcher the condition used to find the task.
Returns
  • the tasks that "match" according to the passed matcher. The descriptors returned are a snapshot of the task state when the method returns will not reflect any future changes. An empty collection is returned when no tasks are matched.

public Collection<TaskDescriptor<?>> getAllTasks ()

Return a collection of TaskDescriptors currently within the manager. This will include tasks that are yet to start, tasks that are running and completed tasks.

The returned collection is sorted by task id, which should be in addition order.

Returns
  • a collection of TaskDescriptors. The descriptors returned are a snapshot of each task state when the method returns will not reflect any future changes. An empty collection is returned when there are no current tasks.

public TaskDescriptor<V> getLiveTask (TaskContext taskContext)

Return the live task associated with the passed context, if one exists.

Parameters
taskContext the context to search for.
Returns
  • currently live task associated with the passed context. The descriptor returned is a snapshot of the task state when the method returns will not reflect any future changes. null will be returned when no matching task can be found.

public Collection<TaskDescriptor<?>> getLiveTasks ()

Return a collection of sumitted or running TaskDescriptors in the manager.

The returned collection is sorted by task id, which should be in addition order.

Returns
  • a collection of running TaskDescriptors. The descriptors returned are a snapshot of each task state when the method returns and will not reflect any future changes. An empty collection is returned when there are no descriptors to return.

public TaskDescriptor<V> getTask (Long taskId)

Returns the TaskDescriptor of the task that is identified by the passed id.

Parameters
taskId the id of the task to retrieve, if null then null will be returned
Returns
  • a TaskDescriptor or null if the manager has not such task. The descriptor returned is a snapshot of the task state when the method returns will not reflect any future changes. null will be returned when no matching task can be found.

public boolean hasLiveTaskWithContext (TaskContext taskContext)

Returns true if the there are live tasks (running or submitted) that have a task context that is EQUAL to the passed in taskContext.

Parameters
taskContext the specific task context (which implements equals() propertly)
Returns
  • true if there are any tasks with an equal task context

public boolean hasTaskWithContext (TaskContext taskContext)

Returns true if the there are any tasks (submitted, running or finished) that have a task context that is EQUAL to the passed in taskContext.

Parameters
taskContext the specific task context (which implements equals() propertly)
Returns
  • true if there are any tasks with an equal task context

public boolean isCancellable (Long taskId)

Returns true if the task can be cancelled. This does not take into account if the task is actually running or not.

Parameters
taskId the task identifier.
Returns
  • true if the task can be cancelled.

public boolean isCancelled (Long taskId)

Return true if this task has been cancelled.

Parameters
taskId the task identifier.
Returns
  • true if this task has been cancelled

public void removeTask (Long taskId)

Remove a task from the manager. The task will still continue to execute if it has not already completed.

Parameters
taskId the task identifier.

public boolean shutdownAndWait (long waitSeconds)

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. It will wait for at most waitSeconds and then return true if the underlying execution threads are terminated completely.

Parameters
waitSeconds the numder of seconds to wait for graceful shutdown.
Returns
  • true if the underlying execution threads have terminated completely.

public void shutdownNow ()

Attempts to aggressively stop all actively executing tasks, halts the processing of waiting tasks.

public void start ()

Start the task manager. Normally the task manager starts on construction, but if it is shutdown, you may need to restart it. If the task manager is not shutdown, does nothing.

public TaskDescriptor<V> submitTask (Callable<V> callable, String taskDescription, TaskContext taskContext)

This submits a Callable task to the manager which can then be started at the managers discretion, but hopefully very soon. The TaskDescriptor returned is a snapshot of the task's state when the method returns and will not change to reflect the task's future state changes. The task's ID can be found in the returned TaskDescriptor. The task is not cancellable.

Parameters
callable the long running task
taskDescription the description of the task
taskContext some stateful context that the task knows about
Returns
  • a TaskDescriptor for the new long running task. The returned descriptor is a snapshot of the task state when the method returns and will not reflect any future changes.
Throws
RejectedExecutionException if the task manager is being shutdown and cannot accept new tasks.
AlreadyExecutingException if a task with an equal TaskContext is already running in the task manager.

public TaskDescriptor<V> submitTask (Callable<V> callable, String taskDescription, TaskContext taskContext, boolean cancellable)

This submits a Callable task to the manager which can then be started at the managers discretion, but hopefully very soon. The TaskDescriptor returned is a snapshot of the task's state when the method returns and will not change to reflect the task's future state changes. The task's ID can be found in the returned TaskDescriptor.

Parameters
callable the long running task
taskDescription the description of the task
taskContext some stateful context that the task knows about
cancellable If set to true indicates that this potentially long running task supports being cancelled.
Returns
  • a TaskDescriptor for the new long running task. The returned descriptor is a snapshot of the task state when the method returns and will not reflect any future changes.
Throws
RejectedExecutionException if the task manager is being shutdown and cannot accept new tasks.
AlreadyExecutingException if a task with an equal TaskContext is already running in the task manager.

public void waitUntilTaskCompletes (Long taskId)

Wait for a specific task to complete.

Parameters
taskId Id of task to wait for
Throws
ExecutionException
InterruptedException