sirius.web.tasks

Class ManagedTasks

java.lang.Object

sirius.web.tasks.ManagedTasks

public class ManagedTasks
extends Object

Executes background tasks which can be monitored via the user interface.

See Also:

ManagedTask

Field Summary

Fields

Modifier and Type	Field and Description
static sirius.kernel.health.Log	LOG Contains the log being used by this framework
static String	PERMISSION_ALL_TASKS This permission needed to view all running tasks.

Constructor Summary

Constructors

Constructor and Description
ManagedTasks()

Method Summary

Modifier and Type	Method and Description
ManagedTaskSetup	createManagedTaskSetup(String name) Creates a new setup which is used to start a new task.
protected void	execute(sirius.web.tasks.ManagedTaskExecution exec)
ManagedTask	findTask(String taskId) Tries to find a managed task with the given id.
List<ManagedTask>	getActiveTasks() Returns a list of all managed tasks visible to the current user.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final sirius.kernel.health.Log LOG

Contains the log being used by this framework

PERMISSION_ALL_TASKS

public static final String PERMISSION_ALL_TASKS

This permission needed to view all running tasks. A user (being logged-in) can always see his or her own tasks.

See Also:

Constant Field Values

Constructor Detail

ManagedTasks

public ManagedTasks()

Method Detail

createManagedTaskSetup

public ManagedTaskSetup createManagedTaskSetup(String name)

Creates a new setup which is used to start a new task.

Parameters:

name - the name of the task being started.

Returns:

a setup used to start a new managed task

execute

protected void execute(sirius.web.tasks.ManagedTaskExecution exec)

findTask

@Nullable
public ManagedTask findTask(String taskId)

Tries to find a managed task with the given id.

Parameters:

taskId - the id of the task

Returns:

the task with the given ID or null if either the task does not exist anymore or the user has no permission to access this task

getActiveTasks

public List<ManagedTask> getActiveTasks()

Returns a list of all managed tasks visible to the current user.

Returns:

a list of all tasks visible to the user. These are eitehr the ones started by the user or all tasks, if the permission PERMISSION_ALL_TASKS is present