fr.gouv.vitam.processing.management.rest

Class ProcessManagementResource

java.lang.Object

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

fr.gouv.vitam.processing.management.rest.ProcessManagementResource

All Implemented Interfaces:

VitamResource

@Path(value="/processing/v1")
 @ApplicationPath(value="webresources")
public class ProcessManagementResource
extends ApplicationStatusResource

This class is resource provider of ProcessManagement

Field Summary

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

STATUS_URL, TENANTS_URL

Constructor Summary

Constructors

Constructor and Description
ProcessManagementResource(ServerConfiguration configuration, ProcessDistributor processDistributor) ProcessManagementResource : initiate the ProcessManagementResource resources

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	executeWorkFlow(javax.ws.rs.core.HttpHeaders headers, String id, ProcessingEntry process) Execute the process of an operation related to the id.
javax.ws.rs.core.Response	findProcessWorkflows(ProcessQuery query) get the process workflow
javax.ws.rs.core.Response	forcePause(ProcessPause info) Pause the processes specified by ProcessPause info
javax.ws.rs.core.Response	getOperationProcessExecutionDetails(String id) get the workflow status
ProcessLifeCycle	getProcessLifeCycle()
javax.ws.rs.core.Response	getWorkflowDefinitions()
javax.ws.rs.core.Response	getWorkFlowState(String id) get the operation status
javax.ws.rs.core.Response	interruptWorkFlowExecution(String id) Interrupt the process of an operation identified by Id.
javax.ws.rs.core.Response	removeForcePause(ProcessPause info) Remove the pause for the processes specified by ProcessPause info
javax.ws.rs.core.Response	updateWorkFlowStatus(javax.ws.rs.core.HttpHeaders headers, String id) Update the status of an operation.

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

Constructor Detail

ProcessManagementResource

public ProcessManagementResource(ServerConfiguration configuration,
                                 ProcessDistributor processDistributor)
                          throws ProcessingStorageWorkspaceException

ProcessManagementResource : initiate the ProcessManagementResource resources

Parameters:

configuration - the server configuration to be applied

Throws:

ProcessingStorageWorkspaceException

Method Detail

getProcessLifeCycle

public ProcessLifeCycle getProcessLifeCycle()

getWorkflowDefinitions

@Path(value="workflows")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getWorkflowDefinitions()

executeWorkFlow

@Path(value="operations/{id}")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response executeWorkFlow(@Context
                                                                                                                                                                 javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                 @PathParam(value="id")
                                                                                                                                                                 String id,
                                                                                                                                                                 ProcessingEntry process)

Execute the process of an operation related to the id.

Parameters:

headers - contain X-Action and X-Context-ID

process - as Json of type ProcessingEntry, indicate the container and workflowId

id - operation identifier

Throws:

ProcessingException - if error in start a workflow

getOperationProcessExecutionDetails

@Path(value="operations/{id}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getOperationProcessExecutionDetails(@PathParam(value="id")
                                                                                                                                               String id)

get the workflow status

Parameters:

id - operation identifier

Returns:

http response

updateWorkFlowStatus

@Path(value="operations/{id}")
 @PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateWorkFlowStatus(@Context
                                                                                                                                                                     javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                     @PathParam(value="id")
                                                                                                                                                                     String id)
                                                                                                                                                              throws InvalidGuidOperationException

Update the status of an operation.

Parameters:

headers - contain X-Action and X-Context-ID

id - operation identifier

Throws:

InvalidGuidOperationException

interruptWorkFlowExecution

@Path(value="operations/{id}")
 @DELETE
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response interruptWorkFlowExecution(@PathParam(value="id")
                                                                                                                                                                              String id)

Interrupt the process of an operation identified by Id.

Parameters:

id - operation identifier

getWorkFlowState

@Path(value="operations/{id}")
 @HEAD
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getWorkFlowState(@PathParam(value="id")
                                                                                                                                                                  String id)

get the operation status

Parameters:

id - operation identifier

Returns:

http response

findProcessWorkflows

@GET
 @Path(value="/operations")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response findProcessWorkflows(ProcessQuery query)

get the process workflow

Parameters:

query - the filter query

Returns:

the workflow in response

forcePause

@Path(value="/forcepause")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response forcePause(ProcessPause info)

Pause the processes specified by ProcessPause info

Parameters:

info - a ProcessPause object indicating the tenant and/or the type of process to pause

Returns:

removeForcePause

@Path(value="/removeforcepause")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response removeForcePause(ProcessPause info)

Remove the pause for the processes specified by ProcessPause info

Parameters:

info - a ProcessPause object indicating the tenant and/or the type of process to pause

Returns: