sirius.web.tasks

Interface ManagedTask

public interface ManagedTask

A managed task is essentially a background job or task with some metadata attached.

It can be created by ManagedTasks.createManagedTaskSetup(String) and is used to report potentially long running acitivities to the administrator.

A managed task is created using a ManagedTaskSetup. The acutal runnable being executed uses a ManagedTaskContext to interact with the system. A ManagedTask is the supervisor interface which mainly reports the state of running tasks.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ManagedTask.State Enuemrates possible states of a task.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the execution of the task.
String	getCategory() Returns the category (executor) in which the task was started.
String	getId() Contains the unique ID of the task.
List<TaskLogEntry>	getLastLogs() Returns the latest log entries.
String	getName() Returns a descriptive name of the task.
Instant	getScheduled() Returns the timestamp when the task was scheduled (started in the users eye).
Instant	getStarted() Returns the timestamp when the execution of the task started.
ManagedTask.State	getState() Returns the state of the task.
String	getStateString() Returns a short textual description of what the task is currently doing.
String	getTenantId() Contains the unique ID of the tenant the user who started the task belongs to if present.
Instant	getTerminated() Returns the timestamp when the execution of the task finished.
List<sirius.kernel.commons.Tuple<String,String>>	getTimings() Returns a list of all recorded performance counters.
String	getUserId() Contains the unique ID of the user that started the task.
String	getUsername() Returns the name of the user that started the task.

Method Detail

getId

String getId()

Contains the unique ID of the task.

Returns:

the unique ID of the task

getUserId

@Nullable
String getUserId()

Contains the unique ID of the user that started the task.

Returns:

the id of the user which started the task

getUsername

@Nullable
String getUsername()

Returns the name of the user that started the task.

Returns:

the name of the user that started the task

getTenantId

@Nullable
String getTenantId()

Contains the unique ID of the tenant the user who started the task belongs to if present.

Returns:

the unique ID of the tenant the user who started the task belongs to

getScheduled

Instant getScheduled()

Returns the timestamp when the task was scheduled (started in the users eye).

Returns:

the timestamp when the task was scheduled

getStarted

@Nullable
Instant getStarted()

Returns the timestamp when the execution of the task started.

Returns:

the timestamp when the execution of the task started

getTerminated

@Nullable
Instant getTerminated()

Returns the timestamp when the execution of the task finished.

Returns:

the timestamp when the execution of the task finished

getName

String getName()

Returns a descriptive name of the task.

Returns:

a descriptive name of the task

getCategory

String getCategory()

Returns the category (executor) in which the task was started.

Returns:

the name of the executor which was used to schedule and execute the task

See Also:

Tasks.executor(String)

getState

ManagedTask.State getState()

Returns the state of the task.

Returns:

the state of the task

getStateString

@Nullable
String getStateString()

Returns a short textual description of what the task is currently doing.

Returns:

a shot description of the tasks current state

getLastLogs

List<TaskLogEntry> getLastLogs()

Returns the latest log entries.

The log is limited to a sane number of entries to pevent excessive memory usage.

Returns:

a list containing the last few log entries

getTimings

List<sirius.kernel.commons.Tuple<String,String>> getTimings()

Returns a list of all recorded performance counters.

The first part of the tuple will be the name of the counter. The second will contain the counter value along with the avarage duration (if supplied).

Returns:

a list of tuples which contains all recorded performance counters

cancel

void cancel()

Cancels the execution of the task.