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(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

TasksResource

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

Method Details

addTask

@POST
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response addTask(TaskParameter desc)
                                    throws jakarta.ws.rs.WebApplicationException

Throws:

jakarta.ws.rs.WebApplicationException

getTask

@GET
@Path("/{id}")
@Produces("application/json")
public jakarta.ws.rs.core.Response getTask(@PathParam("id")
 String 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(TaskType type,
 Optional<String> jobSessionId,
 jakarta.servlet.http.HttpServletRequest request)