Package com.atlassian.confluence.internal.longrunning

Interface LongRunningTaskManagerInternal

All Superinterfaces:

LongRunningTaskManager

All Known Implementing Classes:

DefaultLongRunningTaskManager

@ParametersAreNonnullByDefault
@ReturnValuesAreNonnullByDefault
public interface LongRunningTaskManagerInternal
extends LongRunningTaskManager

Internal version of the LongRunningTaskManager interface; see the package-info.java for rationale.

Method Summary

Modifier and Type	Method	Description
PageResponse<LongTaskStatus>	getAllTasks(@Nullable ConfluenceUser asUser, LimitedRequest request)	Get all currently-tracked tasks that the specified user can see.
int	getTaskCount()	Return a count of the current queued and running tasks.
LongRunningTaskId	queueLongRunningTask(com.atlassian.core.task.longrunning.LongRunningTask task)	Start tracking a long running task that should be started in a new thread when startIfQueued(com.atlassian.confluence.util.longrunning.LongRunningTaskId) is called.
List<LongTaskStatus>	removeComplete()	Remove completed tasks from the tracker.
void	runToCompletion(@Nullable com.atlassian.user.User user, com.atlassian.core.task.longrunning.LongRunningTask task)	Starts a LongRunningTask and waits for it to complete.
void	startIfQueued(LongRunningTaskId taskId)	Starts the task in a new thread if it has previously been queued.

Methods inherited from interface com.atlassian.confluence.util.longrunning.LongRunningTaskManager

getLongRunningTask, resume, startLongRunningTask, stop, stopTrackingLongRunningTask

Method Detail

queueLongRunningTask

LongRunningTaskId queueLongRunningTask(com.atlassian.core.task.longrunning.LongRunningTask task)

Start tracking a long running task that should be started in a new thread when startIfQueued(com.atlassian.confluence.util.longrunning.LongRunningTaskId) is called.

Parameters:

task - the task to perform

Returns:

an ID that can be used to look up the task

startIfQueued

void startIfQueued(LongRunningTaskId taskId)

Starts the task in a new thread if it has previously been queued.

Parameters:

taskId - the ID of the task

getAllTasks

PageResponse<LongTaskStatus> getAllTasks(@Nullable ConfluenceUser asUser,
                                         LimitedRequest request)

Get all currently-tracked tasks that the specified user can see.

removeComplete

List<LongTaskStatus> removeComplete()

Remove completed tasks from the tracker.

Returns:

details of the removed tasks

runToCompletion

void runToCompletion(@Nullable com.atlassian.user.User user,
                     com.atlassian.core.task.longrunning.LongRunningTask task)

Starts a LongRunningTask and waits for it to complete.

Parameters:

user - the user responsible for the task

task - the task to perform

Throws:

IllegalStateException - if the task manager has been shut down

getTaskCount

int getTaskCount()

Return a count of the current queued and running tasks. The count may include tasks that the current user is not allowed to see.