Package io.goobi.viewer.api.rest.model.tasks

Class Task

java.lang.Object

io.goobi.viewer.api.rest.model.tasks.Task

public class Task
extends Object

A process triggered by a REST call using POST and may be monitored via the TasksResource. Each task has a unique id of type long given during object construcion. A Task has an Task.Accessibility property defining which calls are allowed to access the task, and a TaskType defining the actual process to use. Parameters of the execution as well as the type itself are determined by a TaskParameter object given at task creation. Also each task has a status property signaling he current state of the task. A task starts out as Task.TaskStatus.CREATED.

Once processing starts (which may be delayed by the limited thread pool if other tasks are running) the status changes to Task.TaskStatus.STARTED. After processing ends the task is set to either Task.TaskStatus.COMPLETE or Task.TaskStatus.ERROR depending on whether an error occurred which may be recorded in the exception property.

Author:

Florian Alpers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Task.Accessibility	Enumerates the access levels that control which callers are permitted to read or monitor a Task.
static enum	Task.TaskStatus	Enumerates the lifecycle states of a Task, from initial creation through active processing to a terminal completed or error state.

Constructor Summary

Constructors

Constructor	Description
Task(TaskParameter params, BiConsumer<HttpServletRequest,Task> work)

Method Summary

Modifier and Type	Method	Description
void	doTask(HttpServletRequest request)
static Task.Accessibility	getAccessibility(ITaskType type)
String	getErrorMessage()
Optional<String>	getException()
long	getId()
TaskParameter	getParams()
Optional<String>	getSessionId()
Task.TaskStatus	getStatus()
LocalDateTime	getTimeCreated()
TaskType	getType()
BiConsumer<HttpServletRequest,Task>	getWork()
void	setError(String error)
void	setException(Optional<String> exception)
void	setSessionId(Optional<String> sessionId)
void	setStatus(Task.TaskStatus status)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Task

public Task(TaskParameter params,
 BiConsumer<HttpServletRequest,Task> work)

Parameters:

params - task parameters including the task type

work - the actual work to execute when task is run

Method Details

doTask

public void doTask(HttpServletRequest request)

Parameters:

request - HTTP servlet request used to execute the task

setError

public void setError(String error)

Parameters:

error - error message describing the task failure

getAccessibility

public static Task.Accessibility getAccessibility(ITaskType type)

Parameters:

type - the task type to determine accessibility for

Returns:

Task.Accessibility

getId

public long getId()

getType

public TaskType getType()

getException

public Optional<String> getException()

setException

public void setException(Optional<String> exception)

getSessionId

public Optional<String> getSessionId()

setSessionId

public void setSessionId(Optional<String> sessionId)

getTimeCreated

public LocalDateTime getTimeCreated()

getWork

public BiConsumer<HttpServletRequest,Task> getWork()

getParams

public TaskParameter getParams()

setStatus

public void setStatus(Task.TaskStatus status)

getStatus

public Task.TaskStatus getStatus()

getErrorMessage

public String getErrorMessage()

toString

public String toString()

Overrides:

toString in class Object