fr.gouv.vitam.worker.server.rest

Class WorkerResource

java.lang.Object

fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

fr.gouv.vitam.worker.server.rest.WorkerResource

All Implemented Interfaces:

VitamResource

@Path(value="/worker/v1")
public class WorkerResource
extends ApplicationStatusResource

Worker Resource implementation

Field Summary

Fields

Modifier and Type	Field and Description
WorkerFactory	WORKER_FACTORY the worker factory

Fields inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

STATUS_URL, TENANTS_URL

Constructor Summary

Constructors

Constructor and Description
WorkerResource(PluginLoader pluginLoader) Constructor

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getStepsList() Get a list of running steps
javax.ws.rs.core.Response	getStepStatus(String idAsync) Get the status of a step
javax.ws.rs.core.Response	modifyStep(String idAsync) Modifying a step (pausing, resuming, prioritizing)
javax.ws.rs.core.Response	submitStep(javax.ws.rs.core.HttpHeaders headers, com.fasterxml.jackson.databind.JsonNode descriptionStepJson) Submit a step to be launched

Methods inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

getServerTenants, status

Methods inherited from class java.lang.Object

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

Field Detail

WORKER_FACTORY

public final WorkerFactory WORKER_FACTORY

the worker factory

Constructor Detail

WorkerResource

public WorkerResource(PluginLoader pluginLoader)

Constructor

Parameters:

pluginLoader - the plugin loader

Method Detail

getStepsList

@Path(value="tasks")
 @GET
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response getStepsList()

Get a list of running steps

Returns:

Response containing the list of steps

submitStep

@Path(value="tasks")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response submitStep(@Context
                                                                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                  com.fasterxml.jackson.databind.JsonNode descriptionStepJson)

Submit a step to be launched

Parameters:

headers - http header

descriptionStepJson - the description of the step as a {fr.gouv.vitam.worker.common.DescriptionStep}

Returns:

Response containing the status of the step

getStepStatus

@Path(value="tasks/{id_async}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getStepStatus(@PathParam(value="id_async")
                                                                                                                          String idAsync)

Get the status of a step

Parameters:

idAsync - the id of the Async

Returns:

Response containing the status of a specific step

modifyStep

@Path(value="tasks/{id_async}")
 @PUT
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response modifyStep(@PathParam(value="id_async")
                                                                                                                                                            String idAsync)

Modifying a step (pausing, resuming, prioritizing)

Parameters:

idAsync - the id of the Async

Returns:

Response containing the status of the step