java.lang.Object
- fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
- - fr.gouv.vitam.processing.management.rest.ProcessManagementResource

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

Field Summary
- Fields inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
  STATUS_URL, TENANTS_URL

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`javax.ws.rs.core.Response`	`cancelOperationProcessExecution(java.lang.String id)`	Interrupt the process of an operation identified by Id.
`javax.ws.rs.core.Response`	`executeWorkFlow(javax.ws.rs.core.HttpHeaders headers, java.lang.String id, ProcessingEntry process)`	Execute the process of an operation related to the id.
`javax.ws.rs.core.Response`	`findProcessWorkflow(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(java.lang.String id)`	get the workflow status
`ProcessLifeCycle`	`getProcessLifeCycle()`
`javax.ws.rs.core.Response`	`getWorkflowDefinitions()`
`javax.ws.rs.core.Response`	`getWorkflowDetails(java.lang.String workfowId)`
`javax.ws.rs.core.Response`	`getWorkFlowState(java.lang.String id)`	get the operation status
`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, java.lang.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)

ProcessManagementResource : initiate the ProcessManagementResource resources

Parameters:: configuration - the server configuration to be applied

Method Detail

getProcessLifeCycle

public ProcessLifeCycle getProcessLifeCycle()

getWorkflowDefinitions

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

getWorkflowDetails

@Path("workflows/{workfowId}")
@GET
@Produces("application/json")
public javax.ws.rs.core.Response getWorkflowDetails(@PathParam("workfowId")
                                                    java.lang.String workfowId)

executeWorkFlow

@Path("operations/{id}")
@POST
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response executeWorkFlow(@Context
                                                 javax.ws.rs.core.HttpHeaders headers,
                                                 @PathParam("id")
                                                 java.lang.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("operations/{id}")
@GET
@Produces("application/json")
public javax.ws.rs.core.Response getOperationProcessExecutionDetails(@PathParam("id")
                                                                     java.lang.String id)

get the workflow status

Parameters:: id - operation identifier
Returns:: http response

updateWorkFlowStatus

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

Update the status of an operation.

Parameters:: headers - contain X-Action and X-Context-ID; id - operation identifier

cancelOperationProcessExecution

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

Interrupt the process of an operation identified by Id.

Parameters:: id - operation identifier

getWorkFlowState

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

get the operation status

Parameters:: id - operation identifier
Returns:: http response

findProcessWorkflow

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

get the process workflow

Parameters:: query - the filter query
Returns:: the workflow in response

forcePause
```
@Path("/forcepause")
@POST
@Consumes("application/json")
@Produces("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("/removeforcepause")
@POST
@Consumes("application/json")
@Produces("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:

Class ProcessManagementResource

Field Summary

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