Class AdminPipelineWebService

java.lang.Object

ubic.gemma.rest.AdminPipelineWebService

@Service
@Path("/admin/pipeline")
public class AdminPipelineWebService
extends Object

Admin REST surface for curator-driven pipeline batch submissions.

All endpoints require GROUP_ADMIN; pipeline dispatch is a privileged operation. See PipelineJobBatchService for semantics.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdminPipelineWebService.SubmitBatchRequest

Constructor Summary

Constructors

Constructor	Description
AdminPipelineWebService()

Method Summary

Modifier and Type	Method	Description
ResponseDataObject<PipelineJobBatch>	cancelBatch(Long batchId)
ResponseDataObject<Boolean>	cancelJob(Long batchId, Long jobId)
ResponseDataObject<PipelineJobBatch>	getBatch(Long batchId)
ResponseDataObject<List<PipelineJobEvent>>	jobEvents(Long batchId, Long jobId, Long sinceMillis, Integer limit)
ResponseDataObject<List<PipelineJobBatch>>	listMyBatches(PipelineJobBatch.BatchState state, Integer limit)
ResponseDataObject<List<String>>	pipelineRegistry()
ResponseDataObject<PipelineJobBatch>	submitBatch(AdminPipelineWebService.SubmitBatchRequest req)

Methods inherited from class Object

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

Constructor Details

AdminPipelineWebService

public AdminPipelineWebService()

Method Details

pipelineRegistry

@GET
@Path("/registry")
@Produces("application/json")
@PreAuthorize("hasAuthority('GROUP_ADMIN')")
public ResponseDataObject<List<String>> pipelineRegistry()

submitBatch

@POST
@Path("/batches")
@Produces("application/json")
@PreAuthorize("hasAuthority('GROUP_ADMIN')")
public ResponseDataObject<PipelineJobBatch> submitBatch(AdminPipelineWebService.SubmitBatchRequest req)

listMyBatches

@GET
@Path("/batches")
@Produces("application/json")
@PreAuthorize("hasAuthority('GROUP_ADMIN')")
public ResponseDataObject<List<PipelineJobBatch>> listMyBatches(@QueryParam("state")
 PipelineJobBatch.BatchState state,
 @QueryParam("limit")
 Integer limit)

getBatch

@GET
@Path("/batches/{batchId}")
@Produces("application/json")
@PreAuthorize("hasAuthority('GROUP_ADMIN')")
public ResponseDataObject<PipelineJobBatch> getBatch(@PathParam("batchId")
 Long batchId)

cancelBatch

@POST
@Path("/batches/{batchId}/cancel")
@Produces("application/json")
@PreAuthorize("hasAuthority('GROUP_ADMIN')")
public ResponseDataObject<PipelineJobBatch> cancelBatch(@PathParam("batchId")
 Long batchId)

jobEvents

@GET
@Path("/batches/{batchId}/jobs/{jobId}/events")
@Produces("application/json")
@PreAuthorize("hasAuthority('GROUP_ADMIN')")
public ResponseDataObject<List<PipelineJobEvent>> jobEvents(@PathParam("batchId")
 Long batchId,
 @PathParam("jobId")
 Long jobId,
 @QueryParam("sinceMillis")
 Long sinceMillis,
 @QueryParam("limit")
 Integer limit)

cancelJob

@POST
@Path("/batches/{batchId}/jobs/{jobId}/cancel")
@Produces("application/json")
@PreAuthorize("hasAuthority('GROUP_ADMIN')")
public ResponseDataObject<Boolean> cancelJob(@PathParam("batchId")
 Long batchId,
 @PathParam("jobId")
 Long jobId)