org.kie.server.remote.rest.jbpm

Class ProcessResource

java.lang.Object

org.kie.server.remote.rest.jbpm.ProcessResource

@Path(value="server/containers/{id}/processes")
public class ProcessResource
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
ProcessResource()
ProcessResource(ProcessServiceBase processServiceBase, RuntimeDataServiceBase runtimeDataServiceBase, KieServerRegistry context)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	abortProcessInstance(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId)
javax.ws.rs.core.Response	abortProcessInstances(javax.ws.rs.core.HttpHeaders headers, String containerId, List<Long> processInstanceIds)
javax.ws.rs.core.Response	abortWorkItem(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId, Long workItemId)
javax.ws.rs.core.Response	completeWorkItem(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId, Long workItemId, String resultPayload)
javax.ws.rs.core.Response	getAvailableSignals(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId)
javax.ws.rs.core.Response	getProcessesByDeploymentId(javax.ws.rs.core.HttpHeaders headers, String containerId, Integer page, Integer pageSize, String sort, boolean sortOrder)
javax.ws.rs.core.Response	getProcessInstance(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId, boolean withVars)
javax.ws.rs.core.Response	getProcessInstanceHistory(javax.ws.rs.core.HttpHeaders headers, String containerId, long processInstanceId, Boolean active, Boolean completed, Integer page, Integer pageSize)
javax.ws.rs.core.Response	getProcessInstances(javax.ws.rs.core.HttpHeaders headers, String containerId, long parentProcessInstanceId, List<Integer> status, Integer page, Integer pageSize, String sort, boolean sortOrder)
javax.ws.rs.core.Response	getProcessInstancesByDeploymentId(javax.ws.rs.core.HttpHeaders headers, String containerId, List<Integer> status, Integer page, Integer pageSize, String sort, boolean sortOrder)
Object	getProcessInstanceVariable(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId, String varName)
javax.ws.rs.core.Response	getProcessInstanceVariables(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId)
protected static String	getRelativePath(javax.servlet.http.HttpServletRequest httpRequest)
javax.ws.rs.core.Response	getVariableHistory(javax.ws.rs.core.HttpHeaders headers, String containerId, long processInstanceId, String variableName, Integer page, Integer pageSize)
javax.ws.rs.core.Response	getVariablesCurrentState(javax.ws.rs.core.HttpHeaders headers, String containerId, long processInstanceId)
javax.ws.rs.core.Response	getWorkItem(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId, Long workItemId)
javax.ws.rs.core.Response	getWorkItemByProcessInstance(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId)
javax.ws.rs.core.Response	setProcessVariable(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId, String varName, String variablePayload)
javax.ws.rs.core.Response	setProcessVariables(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId, String variablePayload)
javax.ws.rs.core.Response	signalProcessInstance(javax.ws.rs.core.HttpHeaders headers, String containerId, Long processInstanceId, String signalName, String eventPayload)
javax.ws.rs.core.Response	signalProcessInstances(javax.ws.rs.core.HttpHeaders headers, String containerId, List<Long> processInstanceIds, String signalName, String eventPayload)
javax.ws.rs.core.Response	startProcess(javax.ws.rs.core.HttpHeaders headers, String containerId, String processId, String payload)
javax.ws.rs.core.Response	startProcessWithCorrelation(javax.ws.rs.core.HttpHeaders headers, String containerId, String processId, String correlationKey, String payload)

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.slf4j.Logger logger

Constructor Detail

ProcessResource

public ProcessResource()

ProcessResource

public ProcessResource(ProcessServiceBase processServiceBase,
                       RuntimeDataServiceBase runtimeDataServiceBase,
                       KieServerRegistry context)

Method Detail

getRelativePath

protected static String getRelativePath(javax.servlet.http.HttpServletRequest httpRequest)

startProcess

@POST
 @Path(value="{pId}/instances")
 @Consumes(value={"application/xml","application/json"})
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response startProcess(@Context
                                                                                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                      @PathParam(value="id")
                                                                                                                                                                                                      String containerId,
                                                                                                                                                                                                      @PathParam(value="pId")
                                                                                                                                                                                                      String processId,
                                                                                                                                                                                                      @DefaultValue(value="")
                                                                                                                                                                                                      String payload)

startProcessWithCorrelation

@POST
 @Path(value="{pId}/instances/correlation/{correlationKey}")
 @Consumes(value={"application/xml","application/json"})
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response startProcessWithCorrelation(@Context
                                                                                                                                                                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                                                  @PathParam(value="id")
                                                                                                                                                                                                                                                  String containerId,
                                                                                                                                                                                                                                                  @PathParam(value="pId")
                                                                                                                                                                                                                                                  String processId,
                                                                                                                                                                                                                                                  @PathParam(value="correlationKey")
                                                                                                                                                                                                                                                  String correlationKey,
                                                                                                                                                                                                                                                  @DefaultValue(value="")
                                                                                                                                                                                                                                                  String payload)

abortProcessInstance

@DELETE
 @Path(value="instances/{pInstanceId}")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response abortProcessInstance(@Context
                                                                                                                                                               javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                               @PathParam(value="id")
                                                                                                                                                               String containerId,
                                                                                                                                                               @PathParam(value="pInstanceId")
                                                                                                                                                               Long processInstanceId)

abortProcessInstances

@DELETE
 @Path(value="instances")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response abortProcessInstances(@Context
                                                                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                  @PathParam(value="id")
                                                                                                                                                  String containerId,
                                                                                                                                                  @QueryParam(value="instanceId")
                                                                                                                                                  List<Long> processInstanceIds)

signalProcessInstance

@POST
 @Path(value="instances/{pInstanceId}/signal/{sName}")
 @Consumes(value={"application/xml","application/json"})
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response signalProcessInstance(@Context
                                                                                                                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                                      @PathParam(value="id")
                                                                                                                                                                                                                                      String containerId,
                                                                                                                                                                                                                                      @PathParam(value="pInstanceId")
                                                                                                                                                                                                                                      Long processInstanceId,
                                                                                                                                                                                                                                      @PathParam(value="sName")
                                                                                                                                                                                                                                      String signalName,
                                                                                                                                                                                                                                      String eventPayload)

signalProcessInstances

@POST
 @Path(value="instances/signal/{sName}")
 @Consumes(value={"application/xml","application/json"})
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response signalProcessInstances(@Context
                                                                                                                                                                                                                         javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                         @PathParam(value="id")
                                                                                                                                                                                                                         String containerId,
                                                                                                                                                                                                                         @QueryParam(value="instanceId")
                                                                                                                                                                                                                         List<Long> processInstanceIds,
                                                                                                                                                                                                                         @PathParam(value="sName")
                                                                                                                                                                                                                         String signalName,
                                                                                                                                                                                                                         String eventPayload)

getProcessInstance

@GET
 @Path(value="instances/{pInstanceId}")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response getProcessInstance(@Context
                                                                                                                                                          javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                          @PathParam(value="id")
                                                                                                                                                          String containerId,
                                                                                                                                                          @PathParam(value="pInstanceId")
                                                                                                                                                          Long processInstanceId,
                                                                                                                                                          @QueryParam(value="withVars")
                                                                                                                                                          boolean withVars)

setProcessVariable

@PUT
 @Path(value="instances/{pInstanceId}/variable/{varName}")
 @Consumes(value={"application/xml","application/json"})
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response setProcessVariable(@Context
                                                                                                                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                                      @PathParam(value="id")
                                                                                                                                                                                                                                      String containerId,
                                                                                                                                                                                                                                      @PathParam(value="pInstanceId")
                                                                                                                                                                                                                                      Long processInstanceId,
                                                                                                                                                                                                                                      @PathParam(value="varName")
                                                                                                                                                                                                                                      String varName,
                                                                                                                                                                                                                                      String variablePayload)

setProcessVariables

@POST
 @Path(value="instances/{pInstanceId}/variables")
 @Consumes(value={"application/xml","application/json"})
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response setProcessVariables(@Context
                                                                                                                                                                                                                               javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                               @PathParam(value="id")
                                                                                                                                                                                                                               String containerId,
                                                                                                                                                                                                                               @PathParam(value="pInstanceId")
                                                                                                                                                                                                                               Long processInstanceId,
                                                                                                                                                                                                                               String variablePayload)

getProcessInstanceVariable

@GET
 @Path(value="instances/{pInstanceId}/variable/{varName}")
 @Produces(value={"application/xml","application/json"})
public Object getProcessInstanceVariable(@Context
                                                                                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                  @PathParam(value="id")
                                                                                                                                                                  String containerId,
                                                                                                                                                                  @PathParam(value="pInstanceId")
                                                                                                                                                                  Long processInstanceId,
                                                                                                                                                                  @PathParam(value="varName")
                                                                                                                                                                  String varName)

getProcessInstanceVariables

@GET
 @Path(value="instances/{pInstanceId}/variables")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response getProcessInstanceVariables(@Context
                                                                                                                                                                             javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                             @PathParam(value="id")
                                                                                                                                                                             String containerId,
                                                                                                                                                                             @PathParam(value="pInstanceId")
                                                                                                                                                                             Long processInstanceId)

getAvailableSignals

@GET
 @Path(value="instances/{pInstanceId}/signals")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response getAvailableSignals(@Context
                                                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                   @PathParam(value="id")
                                                                                                                                                                   String containerId,
                                                                                                                                                                   @PathParam(value="pInstanceId")
                                                                                                                                                                   Long processInstanceId)

completeWorkItem

@PUT
 @Path(value="instances/{pInstanceId}/workitems/{workItemId}/completed")
 @Consumes(value={"application/xml","application/json"})
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response completeWorkItem(@Context
                                                                                                                                                                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                                                  @PathParam(value="id")
                                                                                                                                                                                                                                                  String containerId,
                                                                                                                                                                                                                                                  @PathParam(value="pInstanceId")
                                                                                                                                                                                                                                                  Long processInstanceId,
                                                                                                                                                                                                                                                  @PathParam(value="workItemId")
                                                                                                                                                                                                                                                  Long workItemId,
                                                                                                                                                                                                                                                  String resultPayload)

abortWorkItem

@PUT
 @Path(value="instances/{pInstanceId}/workitems/{workItemId}/aborted")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response abortWorkItem(@Context
                                                                                                                                                                                    javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                    @PathParam(value="id")
                                                                                                                                                                                    String containerId,
                                                                                                                                                                                    @PathParam(value="pInstanceId")
                                                                                                                                                                                    Long processInstanceId,
                                                                                                                                                                                    @PathParam(value="workItemId")
                                                                                                                                                                                    Long workItemId)

getWorkItem

@GET
 @Path(value="instances/{pInstanceId}/workitems/{workItemId}")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response getWorkItem(@Context
                                                                                                                                                                          javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                          @PathParam(value="id")
                                                                                                                                                                          String containerId,
                                                                                                                                                                          @PathParam(value="pInstanceId")
                                                                                                                                                                          Long processInstanceId,
                                                                                                                                                                          @PathParam(value="workItemId")
                                                                                                                                                                          Long workItemId)

getWorkItemByProcessInstance

@GET
 @Path(value="instances/{pInstanceId}/workitems")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response getWorkItemByProcessInstance(@Context
                                                                                                                                                                              javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                              @PathParam(value="id")
                                                                                                                                                                              String containerId,
                                                                                                                                                                              @PathParam(value="pInstanceId")
                                                                                                                                                                              Long processInstanceId)

getProcessInstancesByDeploymentId

@GET
 @Path(value="processes/instances")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response getProcessInstancesByDeploymentId(@Context
                                                                                                                                                                     javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                     @PathParam(value="id")
                                                                                                                                                                     String containerId,
                                                                                                                                                                     @QueryParam(value="status")
                                                                                                                                                                     List<Integer> status,
                                                                                                                                                                     @QueryParam(value="page") @DefaultValue(value="0")
                                                                                                                                                                     Integer page,
                                                                                                                                                                     @QueryParam(value="pageSize") @DefaultValue(value="10")
                                                                                                                                                                     Integer pageSize,
                                                                                                                                                                     @QueryParam(value="sort")
                                                                                                                                                                     String sort,
                                                                                                                                                                     @QueryParam(value="sortOrder") @DefaultValue(value="true")
                                                                                                                                                                     boolean sortOrder)

getProcessesByDeploymentId

@GET
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response getProcessesByDeploymentId(@Context
                                                                                                                          javax.ws.rs.core.HttpHeaders headers,
                                                                                                                          @PathParam(value="id")
                                                                                                                          String containerId,
                                                                                                                          @QueryParam(value="page") @DefaultValue(value="0")
                                                                                                                          Integer page,
                                                                                                                          @QueryParam(value="pageSize") @DefaultValue(value="10")
                                                                                                                          Integer pageSize,
                                                                                                                          @QueryParam(value="sort")
                                                                                                                          String sort,
                                                                                                                          @QueryParam(value="sortOrder") @DefaultValue(value="true")
                                                                                                                          boolean sortOrder)

getProcessInstanceHistory

@GET
 @Path(value="processes/instances/{pInstanceId}/nodes/instances")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response getProcessInstanceHistory(@Context
                                                                                                                                                                                           javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                           @PathParam(value="id")
                                                                                                                                                                                           String containerId,
                                                                                                                                                                                           @PathParam(value="pInstanceId")
                                                                                                                                                                                           long processInstanceId,
                                                                                                                                                                                           @QueryParam(value="activeOnly")
                                                                                                                                                                                           Boolean active,
                                                                                                                                                                                           @QueryParam(value="completedOnly")
                                                                                                                                                                                           Boolean completed,
                                                                                                                                                                                           @QueryParam(value="page") @DefaultValue(value="0")
                                                                                                                                                                                           Integer page,
                                                                                                                                                                                           @QueryParam(value="pageSize") @DefaultValue(value="10")
                                                                                                                                                                                           Integer pageSize)

getVariablesCurrentState

@GET
 @Path(value="processes/instances/{pInstanceId}/variables/instances")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response getVariablesCurrentState(@Context
                                                                                                                                                                                              javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                              @PathParam(value="id")
                                                                                                                                                                                              String containerId,
                                                                                                                                                                                              @PathParam(value="pInstanceId")
                                                                                                                                                                                              long processInstanceId)

getVariableHistory

@GET
 @Path(value="processes/instances/{pInstanceId}/variables/instances/{varName}")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response getVariableHistory(@Context
                                                                                                                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                  @PathParam(value="id")
                                                                                                                                                                                                  String containerId,
                                                                                                                                                                                                  @PathParam(value="pInstanceId")
                                                                                                                                                                                                  long processInstanceId,
                                                                                                                                                                                                  @PathParam(value="varName")
                                                                                                                                                                                                  String variableName,
                                                                                                                                                                                                  @QueryParam(value="page") @DefaultValue(value="0")
                                                                                                                                                                                                  Integer page,
                                                                                                                                                                                                  @QueryParam(value="pageSize") @DefaultValue(value="10")
                                                                                                                                                                                                  Integer pageSize)

getProcessInstances

@GET
 @Path(value="instances/{pInstanceId}/processes")
 @Produces(value={"application/xml","application/json"})
public javax.ws.rs.core.Response getProcessInstances(@Context
                                                                                                                                                                     javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                     @PathParam(value="id")
                                                                                                                                                                     String containerId,
                                                                                                                                                                     @PathParam(value="pInstanceId")
                                                                                                                                                                     long parentProcessInstanceId,
                                                                                                                                                                     @QueryParam(value="status")
                                                                                                                                                                     List<Integer> status,
                                                                                                                                                                     @QueryParam(value="page") @DefaultValue(value="0")
                                                                                                                                                                     Integer page,
                                                                                                                                                                     @QueryParam(value="pageSize") @DefaultValue(value="10")
                                                                                                                                                                     Integer pageSize,
                                                                                                                                                                     @QueryParam(value="sort")
                                                                                                                                                                     String sort,
                                                                                                                                                                     @QueryParam(value="sortOrder") @DefaultValue(value="true")
                                                                                                                                                                     boolean sortOrder)