Class TasksWebService

java.lang.Object

ubic.gemma.rest.TasksWebService

@Service
@Path("/tasks")
public class TasksWebService
extends Object

RESTful interface for polling background pipeline tasks submitted via the dispatch endpoints on DatasetsWebService (preprocess, diagnostics, batch info fetch, differential analysis run/redo/remove).

Tasks are kept in memory only and evicted ~10 minutes after completion; once evicted the endpoint returns 404.

Constructor Summary

Constructors

Constructor	Description
TasksWebService()

Method Summary

Modifier and Type	Method	Description
ResponseDataObject<TaskStatusValueObject>	cancelTask(String taskId)	Cooperative task cancellation.
ResponseDataObject<TaskStatusValueObject>	getTaskStatus(String taskId)

Methods inherited from class Object

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

Constructor Details

TasksWebService

public TasksWebService()

Method Details

getTaskStatus

@GET
@Path("/{taskId}")
@Produces("application/json")
@PreAuthorize("hasAuthority('GROUP_CURATOR')")
public ResponseDataObject<TaskStatusValueObject> getTaskStatus(@PathParam("taskId")
 String taskId)

cancelTask

@DELETE
@Path("/{taskId}")
@Produces("application/json")
@PreAuthorize("hasAuthority('GROUP_CURATOR')")
public ResponseDataObject<TaskStatusValueObject> cancelTask(@PathParam("taskId")
 String taskId)

Cooperative task cancellation. Delegates to SubmittedTask.requestCancellation(): the running task checks for the cancellation flag at its own preemption points; this endpoint does NOT force-kill anything. Returns the (post-request) task status snapshot.