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

Class TasksResource

java.lang.Object

io.goobi.viewer.api.rest.v1.tasks.TasksResource

@Path("/tasks")
public class TasksResource
extends Object

Create and monitor (possibly time consuming) tasks within the viewer. These tasks are managed by the TaskManager

Author:

florian

Constructor Summary

Constructors

Constructor	Description
TasksResource(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Method Summary

Modifier and Type	Method	Description
Task	addTask(TaskParameter desc)
Task	getTask(Long id)
List<Task>	getTasks()
boolean	isAuthorized(Task.TaskType type, Optional<String> jobSessionId, javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Constructor Detail

TasksResource

public TasksResource(@Context
                     javax.servlet.http.HttpServletRequest request,
                     @Context
                     javax.servlet.http.HttpServletResponse response)

Method Detail

addTask

@POST
@Consumes("application/json")
@Produces("application/json")
public Task addTask(TaskParameter desc)
             throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException

getTask

@GET
@Path("/{id}")
@Produces("application/json")
public Task getTask(@PathParam("id")
                    Long id)
             throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

getTasks

@GET
@Produces("application/json")
public List<Task> getTasks()

isAuthorized

public boolean isAuthorized(Task.TaskType type,
                            Optional<String> jobSessionId,
                            javax.servlet.http.HttpServletRequest request)