Package io.automatiko.engine.addons.process.management

Class ProcessInstanceManagementResource

java.lang.Object

io.automatiko.engine.addons.process.management.BaseProcessInstanceManagementResource<javax.ws.rs.core.Response>

io.automatiko.engine.addons.process.management.ProcessInstanceManagementResource

All Implemented Interfaces:

ProcessInstanceManagement<javax.ws.rs.core.Response>

@Path("/management/processes")
public class ProcessInstanceManagementResource
extends BaseProcessInstanceManagementResource<javax.ws.rs.core.Response>

Field Summary

Fields inherited from class io.automatiko.engine.addons.process.management.BaseProcessInstanceManagementResource

application, processData

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceManagementResource()
ProcessInstanceManagementResource(io.automatiko.engine.api.Application application, javax.enterprise.inject.Instance<io.automatiko.engine.api.workflow.Process<?>> availableProcesses, io.automatiko.engine.api.auth.IdentitySupplier identitySupplier)
ProcessInstanceManagementResource(java.util.Map<java.lang.String,io.automatiko.engine.api.workflow.Process<?>> process, io.automatiko.engine.api.Application application, io.automatiko.engine.api.auth.IdentitySupplier identitySupplier, java.util.Optional<java.lang.String> serviceUrl)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	archiveInstance(java.lang.String processId, java.lang.String instanceId, boolean abort, java.lang.String user, java.util.List<java.lang.String> groups)
protected javax.ws.rs.core.Response	badRequestResponse(java.lang.String message)
protected <R> javax.ws.rs.core.Response	buildOkResponse(R body)
javax.ws.rs.core.Response	cancelNodeInstanceId(java.lang.String processId, java.lang.String processInstanceId, java.lang.String nodeInstanceId, java.lang.String user, java.util.List<java.lang.String> groups)
javax.ws.rs.core.Response	cancelProcessInstanceId(java.lang.String processId, java.lang.String processInstanceId, java.lang.String status, java.lang.String user, java.util.List<java.lang.String> groups)
JsonExportedProcessInstance	exportInstance(java.lang.String processId, java.lang.String instanceId, java.lang.String status, boolean abort, java.lang.String user, java.util.List<java.lang.String> groups)
java.util.List<ProcessDTO>	get(int page, int size, java.lang.String user, java.util.List<java.lang.String> groups)
ProcessInstanceDetailsDTO	getInstance(java.lang.String processId, java.lang.String instanceId, java.lang.String status, java.lang.String user, java.util.List<java.lang.String> groups)
javax.ws.rs.core.Response	getInstanceImage(java.lang.String processId, java.lang.String instanceId, java.lang.String status, java.lang.String user, java.util.List<java.lang.String> groups)
javax.ws.rs.core.Response	getInstanceInError(java.lang.String processId, java.lang.String processInstanceId, java.lang.String user, java.util.List<java.lang.String> groups)
java.util.List<ProcessInstanceDTO>	getInstances(java.lang.String processId, java.lang.String status, int page, int size, java.lang.String user, java.util.List<java.lang.String> groups)
java.util.List<java.lang.Object>	getInstanceVariableVersions(java.lang.String processId, java.lang.String instanceId, java.lang.String status, java.lang.String name, java.lang.String user, java.util.List<java.lang.String> groups)
javax.ws.rs.core.Response	getWorkItemsInProcessInstance(java.lang.String processId, java.lang.String processInstanceId, java.lang.String user, java.util.List<java.lang.String> groups)
ProcessInstanceDetailsDTO	importInstance(java.lang.String processId, java.lang.String user, java.util.List<java.lang.String> groups, JsonExportedProcessInstance instance)
protected javax.ws.rs.core.Response	notFoundResponse(java.lang.String message)
java.util.List<java.lang.Object>	restoreInstanceVariableVersions(java.lang.String processId, java.lang.String instanceId, java.lang.String status, java.lang.String name, java.lang.Integer version, java.lang.String user, java.util.List<java.lang.String> groups)
javax.ws.rs.core.Response	retriggerInstanceInError(java.lang.String processId, java.lang.String processInstanceId, java.lang.String user, java.util.List<java.lang.String> groups)
javax.ws.rs.core.Response	retriggerInstanceInErrorByErrorId(java.lang.String processId, java.lang.String processInstanceId, java.lang.String errorId, java.lang.String user, java.util.List<java.lang.String> groups)
javax.ws.rs.core.Response	retriggerNodeInstanceId(java.lang.String processId, java.lang.String processInstanceId, java.lang.String nodeInstanceId, java.lang.String user, java.util.List<java.lang.String> groups)
javax.ws.rs.core.Response	skipInstanceInError(java.lang.String processId, java.lang.String processInstanceId, java.lang.String user, java.util.List<java.lang.String> groups)
javax.ws.rs.core.Response	skipInstanceInErrorByErrorId(java.lang.String processId, java.lang.String processInstanceId, java.lang.String errorId, java.lang.String user, java.util.List<java.lang.String> groups)
javax.ws.rs.core.Response	triggerNodeInstanceId(java.lang.String processId, java.lang.String processInstanceId, java.lang.String nodeId, java.lang.String user, java.util.List<java.lang.String> groups)
java.lang.String	ui()

Methods inherited from class io.automatiko.engine.addons.process.management.BaseProcessInstanceManagementResource

doCancelNodeInstanceId, doCancelProcessInstanceId, doGetInstanceInError, doGetWorkItemsInProcessInstance, doRetriggerInstanceInError, doRetriggerInstanceInErrorByErrorId, doRetriggerNodeInstanceId, doSkipInstanceInError, doSkipInstanceInErrorByErrorId, doTriggerNodeInstanceId, mapStatus, reverseMapStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessInstanceManagementResource

public ProcessInstanceManagementResource()

ProcessInstanceManagementResource

public ProcessInstanceManagementResource(java.util.Map<java.lang.String,io.automatiko.engine.api.workflow.Process<?>> process,
                                         io.automatiko.engine.api.Application application,
                                         io.automatiko.engine.api.auth.IdentitySupplier identitySupplier,
                                         java.util.Optional<java.lang.String> serviceUrl)

ProcessInstanceManagementResource

@Inject
public ProcessInstanceManagementResource(io.automatiko.engine.api.Application application,
                                         javax.enterprise.inject.Instance<io.automatiko.engine.api.workflow.Process<?>> availableProcesses,
                                         io.automatiko.engine.api.auth.IdentitySupplier identitySupplier)

Method Detail

buildOkResponse

protected <R> javax.ws.rs.core.Response buildOkResponse(R body)

Specified by:

buildOkResponse in class BaseProcessInstanceManagementResource<javax.ws.rs.core.Response>

badRequestResponse

protected javax.ws.rs.core.Response badRequestResponse(java.lang.String message)

Specified by:

badRequestResponse in class BaseProcessInstanceManagementResource<javax.ws.rs.core.Response>

notFoundResponse

protected javax.ws.rs.core.Response notFoundResponse(java.lang.String message)

Specified by:

notFoundResponse in class BaseProcessInstanceManagementResource<javax.ws.rs.core.Response>

ui

@GET
@Path("/ui")
@Produces("text/html")
public java.lang.String ui()
                    throws java.io.IOException

Throws:

java.io.IOException

get

@GET
@Path("/")
@Produces("application/json")
public java.util.List<ProcessDTO> get(@QueryParam("page") @DefaultValue("1")
                                      int page,
                                      @QueryParam("size") @DefaultValue("10")
                                      int size,
                                      @QueryParam("user")
                                      java.lang.String user,
                                      @QueryParam("group")
                                      java.util.List<java.lang.String> groups)

getInstances

@GET
@Path("/{processId}/instances")
@Produces("application/json")
public java.util.List<ProcessInstanceDTO> getInstances(@PathParam("processId")
                                                       java.lang.String processId,
                                                       @QueryParam("status") @DefaultValue("active")
                                                       java.lang.String status,
                                                       @QueryParam("page") @DefaultValue("1")
                                                       int page,
                                                       @QueryParam("size") @DefaultValue("10")
                                                       int size,
                                                       @QueryParam("user")
                                                       java.lang.String user,
                                                       @QueryParam("group")
                                                       java.util.List<java.lang.String> groups)

getInstance

@GET
@Path("/{processId}/instances/{instanceId}")
@Produces("application/json")
public ProcessInstanceDetailsDTO getInstance(@PathParam("processId")
                                             java.lang.String processId,
                                             @PathParam("instanceId")
                                             java.lang.String instanceId,
                                             @QueryParam("status") @DefaultValue("active")
                                             java.lang.String status,
                                             @QueryParam("user")
                                             java.lang.String user,
                                             @QueryParam("group")
                                             java.util.List<java.lang.String> groups)

getInstanceVariableVersions

@GET
@Path("/{processId}/instances/{instanceId}/variables/{name}/versions")
@Produces("application/json")
public java.util.List<java.lang.Object> getInstanceVariableVersions(@PathParam("processId")
                                                                    java.lang.String processId,
                                                                    @PathParam("instanceId")
                                                                    java.lang.String instanceId,
                                                                    @QueryParam("status") @DefaultValue("active")
                                                                    java.lang.String status,
                                                                    @PathParam("name")
                                                                    java.lang.String name,
                                                                    @QueryParam("user")
                                                                    java.lang.String user,
                                                                    @QueryParam("group")
                                                                    java.util.List<java.lang.String> groups)

restoreInstanceVariableVersions

@POST
@Path("/{processId}/instances/{instanceId}/variables/{name}/versions/{version}")
@Produces("application/json")
public java.util.List<java.lang.Object> restoreInstanceVariableVersions(@PathParam("processId")
                                                                        java.lang.String processId,
                                                                        @PathParam("instanceId")
                                                                        java.lang.String instanceId,
                                                                        @QueryParam("status") @DefaultValue("active")
                                                                        java.lang.String status,
                                                                        @PathParam("name")
                                                                        java.lang.String name,
                                                                        @PathParam("version")
                                                                        java.lang.Integer version,
                                                                        @QueryParam("user")
                                                                        java.lang.String user,
                                                                        @QueryParam("group")
                                                                        java.util.List<java.lang.String> groups)

getInstanceImage

@GET
@Path("/{processId}/instances/{instanceId}/image")
@Produces("application/svg+xml")
public javax.ws.rs.core.Response getInstanceImage(@PathParam("processId")
                                                  java.lang.String processId,
                                                  @PathParam("instanceId")
                                                  java.lang.String instanceId,
                                                  @QueryParam("status") @DefaultValue("active")
                                                  java.lang.String status,
                                                  @QueryParam("user")
                                                  java.lang.String user,
                                                  @QueryParam("group")
                                                  java.util.List<java.lang.String> groups)

getInstanceInError

@GET
@Path("/{processId}/instances/{processInstanceId}/error")
@Produces("application/json")
public javax.ws.rs.core.Response getInstanceInError(@PathParam("processId")
                                                    java.lang.String processId,
                                                    @PathParam("processInstanceId")
                                                    java.lang.String processInstanceId,
                                                    @QueryParam("user")
                                                    java.lang.String user,
                                                    @QueryParam("group")
                                                    java.util.List<java.lang.String> groups)

getWorkItemsInProcessInstance

@GET
@Path("/{processId}/instances/{processInstanceId}/nodeInstances")
@Produces("application/json")
public javax.ws.rs.core.Response getWorkItemsInProcessInstance(@PathParam("processId")
                                                               java.lang.String processId,
                                                               @PathParam("processInstanceId")
                                                               java.lang.String processInstanceId,
                                                               @QueryParam("user")
                                                               java.lang.String user,
                                                               @QueryParam("group")
                                                               java.util.List<java.lang.String> groups)

retriggerInstanceInError

@POST
@Path("/{processId}/instances/{processInstanceId}/retrigger")
@Produces("application/json")
public javax.ws.rs.core.Response retriggerInstanceInError(@PathParam("processId")
                                                          java.lang.String processId,
                                                          @PathParam("processInstanceId")
                                                          java.lang.String processInstanceId,
                                                          @QueryParam("user")
                                                          java.lang.String user,
                                                          @QueryParam("group")
                                                          java.util.List<java.lang.String> groups)

retriggerInstanceInErrorByErrorId

@POST
@Path("/{processId}/instances/{processInstanceId}/retrigger/{errorId}")
@Produces("application/json")
public javax.ws.rs.core.Response retriggerInstanceInErrorByErrorId(@PathParam("processId")
                                                                   java.lang.String processId,
                                                                   @PathParam("processInstanceId")
                                                                   java.lang.String processInstanceId,
                                                                   @PathParam("errorId")
                                                                   java.lang.String errorId,
                                                                   @QueryParam("user")
                                                                   java.lang.String user,
                                                                   @QueryParam("group")
                                                                   java.util.List<java.lang.String> groups)

skipInstanceInError

@POST
@Path("/{processId}/instances/{processInstanceId}/skip")
@Produces("application/json")
public javax.ws.rs.core.Response skipInstanceInError(@PathParam("processId")
                                                     java.lang.String processId,
                                                     @PathParam("processInstanceId")
                                                     java.lang.String processInstanceId,
                                                     @QueryParam("user")
                                                     java.lang.String user,
                                                     @QueryParam("group")
                                                     java.util.List<java.lang.String> groups)

skipInstanceInErrorByErrorId

@POST
@Path("/{processId}/instances/{processInstanceId}/skip/{errorId}")
@Produces("application/json")
public javax.ws.rs.core.Response skipInstanceInErrorByErrorId(@PathParam("processId")
                                                              java.lang.String processId,
                                                              @PathParam("processInstanceId")
                                                              java.lang.String processInstanceId,
                                                              @PathParam("errorId")
                                                              java.lang.String errorId,
                                                              @QueryParam("user")
                                                              java.lang.String user,
                                                              @QueryParam("group")
                                                              java.util.List<java.lang.String> groups)

triggerNodeInstanceId

@POST
@Path("/{processId}/instances/{processInstanceId}/nodes/{nodeId}")
@Produces("application/json")
public javax.ws.rs.core.Response triggerNodeInstanceId(@PathParam("processId")
                                                       java.lang.String processId,
                                                       @PathParam("processInstanceId")
                                                       java.lang.String processInstanceId,
                                                       @PathParam("nodeId")
                                                       java.lang.String nodeId,
                                                       @QueryParam("user")
                                                       java.lang.String user,
                                                       @QueryParam("group")
                                                       java.util.List<java.lang.String> groups)

retriggerNodeInstanceId

@POST
@Path("/{processId}/instances/{processInstanceId}/nodeInstances/{nodeInstanceId}")
@Produces("application/json")
public javax.ws.rs.core.Response retriggerNodeInstanceId(@PathParam("processId")
                                                         java.lang.String processId,
                                                         @PathParam("processInstanceId")
                                                         java.lang.String processInstanceId,
                                                         @PathParam("nodeInstanceId")
                                                         java.lang.String nodeInstanceId,
                                                         @QueryParam("user")
                                                         java.lang.String user,
                                                         @QueryParam("group")
                                                         java.util.List<java.lang.String> groups)

cancelNodeInstanceId

@DELETE
@Path("/{processId}/instances/{processInstanceId}/nodeInstances/{nodeInstanceId}")
@Produces("application/json")
public javax.ws.rs.core.Response cancelNodeInstanceId(@PathParam("processId")
                                                      java.lang.String processId,
                                                      @PathParam("processInstanceId")
                                                      java.lang.String processInstanceId,
                                                      @PathParam("nodeInstanceId")
                                                      java.lang.String nodeInstanceId,
                                                      @QueryParam("user")
                                                      java.lang.String user,
                                                      @QueryParam("group")
                                                      java.util.List<java.lang.String> groups)

cancelProcessInstanceId

@DELETE
@Path("/{processId}/instances/{processInstanceId}")
@Produces("application/json")
public javax.ws.rs.core.Response cancelProcessInstanceId(@PathParam("processId")
                                                         java.lang.String processId,
                                                         @PathParam("processInstanceId")
                                                         java.lang.String processInstanceId,
                                                         @QueryParam("status") @DefaultValue("active")
                                                         java.lang.String status,
                                                         @QueryParam("user")
                                                         java.lang.String user,
                                                         @QueryParam("group")
                                                         java.util.List<java.lang.String> groups)

exportInstance

@GET
@Path("/{processId}/instances/{instanceId}/export")
@Produces("application/json")
public JsonExportedProcessInstance exportInstance(@PathParam("processId")
                                                  java.lang.String processId,
                                                  @PathParam("instanceId")
                                                  java.lang.String instanceId,
                                                  @QueryParam("status") @DefaultValue("active")
                                                  java.lang.String status,
                                                  @QueryParam("abort") @DefaultValue("false")
                                                  boolean abort,
                                                  @QueryParam("user")
                                                  java.lang.String user,
                                                  @QueryParam("group")
                                                  java.util.List<java.lang.String> groups)

importInstance

@POST
@Path("/{processId}/instances")
@Produces("application/json")
public ProcessInstanceDetailsDTO importInstance(@PathParam("processId")
                                                java.lang.String processId,
                                                @QueryParam("user")
                                                java.lang.String user,
                                                @QueryParam("group")
                                                java.util.List<java.lang.String> groups,
                                                JsonExportedProcessInstance instance)

archiveInstance

@GET
@Path("/{processId}/instances/{instanceId}/archive")
@Produces("application/zip")
public javax.ws.rs.core.Response archiveInstance(@PathParam("processId")
                                                 java.lang.String processId,
                                                 @PathParam("instanceId")
                                                 java.lang.String instanceId,
                                                 @QueryParam("abort") @DefaultValue("false")
                                                 boolean abort,
                                                 @QueryParam("user")
                                                 java.lang.String user,
                                                 @QueryParam("group")
                                                 java.util.List<java.lang.String> groups)