Class WorkflowInstanceResource

java.lang.Object

io.nflow.rest.v1.ResourceBase

io.nflow.rest.v1.jaxrs.JaxRsResource

io.nflow.rest.v1.jaxrs.WorkflowInstanceResource

@Path("/v1/workflow-instance")
@Consumes("application/json")
@Produces("application/json")
@Component
public class WorkflowInstanceResource
extends JaxRsResource

Field Summary

Fields inherited from class ResourceBase

DEPRECATED_INCLUDE_PARAM_DESC, INCLUDES_PARAM_DESC, QUERY_ARCHIVED_DEFAULT, QUERY_ARCHIVED_DEFAULT_STR

Modifier and Type	Field	Description
protected static final String	DEPRECATED_INCLUDE_PARAM_DESC
protected static final String	INCLUDES_PARAM_DESC
protected static final boolean	QUERY_ARCHIVED_DEFAULT
protected static final String	QUERY_ARCHIVED_DEFAULT_STR

Constructor Summary

Constructors

Constructor	Description
WorkflowInstanceResource(WorkflowInstanceService workflowInstances, CreateWorkflowConverter createWorkflowConverter, ListWorkflowInstanceConverter listWorkflowConverter, WorkflowInstanceFactory workflowInstanceFactory, io.nflow.engine.internal.dao.WorkflowInstanceDao workflowInstanceDao)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	corsPreflight()
jakarta.ws.rs.core.Response	createWorkflowInstance(@Valid CreateWorkflowInstanceRequest req)
jakarta.ws.rs.core.Response	fetchWorkflowInstance(long id, Set<ApiWorkflowInstanceInclude> includes, String include, Long maxActions, Boolean queryArchive)
jakarta.ws.rs.core.Response	listWorkflowInstances(Set<Long> ids, Set<String> types, Long parentWorkflowId, Long parentActionId, Set<String> states, Set<WorkflowInstance.WorkflowInstanceStatus> statuses, String businessKey, String externalId, String stateVariableKey, String stateVariableValue, Set<ApiWorkflowInstanceInclude> includes, String include, Long maxResults, Long maxActions, Boolean queryArchive)
jakarta.ws.rs.core.Response	setSignal(long id, @Valid SetSignalRequest req)
jakarta.ws.rs.core.Response	updateWorkflowInstance(long id, String expectedState, StateTransitionValidationMode validationMode, @Valid UpdateWorkflowInstanceRequest req)
jakarta.ws.rs.core.Response	wakeup(long id, @Valid WakeupRequest req)

Methods inherited from class JaxRsResource

handleExceptions

Modifier and Type	Method	Description
protected jakarta.ws.rs.core.Response	handleExceptions(Supplier<jakarta.ws.rs.core.Response.ResponseBuilder> responseBuilder)

Methods inherited from class ResourceBase

fetchWorkflowInstance, handleExceptions, listWorkflowDefinitions, listWorkflowInstances, resolveExceptionHttpStatus, updateWorkflowInstance

Modifier and Type	Method	Description
ListWorkflowInstanceResponse	fetchWorkflowInstance(long id, Set<ApiWorkflowInstanceInclude> apiIncludes, String include, Long maxActions, boolean queryArchive, WorkflowInstanceService workflowInstances, ListWorkflowInstanceConverter listWorkflowConverter)
protected <T> T	handleExceptions(Supplier<T> response, BiFunction<Integer, ErrorResponse, T> error)
List<ListWorkflowDefinitionResponse>	listWorkflowDefinitions(Collection<String> types, WorkflowDefinitionService workflowDefinitions, ListWorkflowDefinitionConverter converter, io.nflow.engine.internal.dao.WorkflowDefinitionDao workflowDefinitionDao)
Stream<ListWorkflowInstanceResponse>	listWorkflowInstances(Set<Long> ids, Set<String> types, Long parentWorkflowId, Long parentActionId, Set<String> states, Set<WorkflowInstance.WorkflowInstanceStatus> statuses, String businessKey, String externalId, String stateVariableKey, String stateVariableValue, Set<ApiWorkflowInstanceInclude> includes, String include, Long maxResults, Long maxActions, boolean queryArchive, WorkflowInstanceService workflowInstances, ListWorkflowInstanceConverter listWorkflowConverter)
protected int	resolveExceptionHttpStatus(Throwable t)
boolean	updateWorkflowInstance(long id, UpdateWorkflowInstanceRequest req, WorkflowInstanceFactory workflowInstanceFactory, WorkflowInstanceService workflowInstances, io.nflow.engine.internal.dao.WorkflowInstanceDao workflowInstanceDao, String expectedState, StateTransitionValidationMode validationMode)

Methods inherited from class Object

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

Constructor Details

WorkflowInstanceResource

@Inject
public WorkflowInstanceResource(WorkflowInstanceService workflowInstances,
 CreateWorkflowConverter createWorkflowConverter,
 ListWorkflowInstanceConverter listWorkflowConverter,
 WorkflowInstanceFactory workflowInstanceFactory,
 io.nflow.engine.internal.dao.WorkflowInstanceDao workflowInstanceDao)

Method Details

corsPreflight

@OPTIONS
@Path("{any: .*}")
@Consumes("*/*")
public jakarta.ws.rs.core.Response corsPreflight()

createWorkflowInstance

@PUT
public jakarta.ws.rs.core.Response createWorkflowInstance(@Valid
 @Valid CreateWorkflowInstanceRequest req)

updateWorkflowInstance

@PUT
@Path("/id/{id}")
public jakarta.ws.rs.core.Response updateWorkflowInstance(@PathParam("id")
 long id,
 @QueryParam("expectedState")
 String expectedState,
 @QueryParam("validationMode")
 StateTransitionValidationMode validationMode,
 @Valid
 @Valid UpdateWorkflowInstanceRequest req)

fetchWorkflowInstance

@GET
@Path("/id/{id}")
public jakarta.ws.rs.core.Response fetchWorkflowInstance(@PathParam("id")
 long id,
 @QueryParam("includes")
 Set<ApiWorkflowInstanceInclude> includes,
 @QueryParam("include")
 String include,
 @QueryParam("maxActions")
 Long maxActions,
 @QueryParam("queryArchive")
 Boolean queryArchive)

listWorkflowInstances

@GET
public jakarta.ws.rs.core.Response listWorkflowInstances(@QueryParam("id")
 Set<Long> ids,
 @QueryParam("type")
 Set<String> types,
 @QueryParam("parentWorkflowId")
 Long parentWorkflowId,
 @QueryParam("parentActionId")
 Long parentActionId,
 @QueryParam("state")
 Set<String> states,
 @QueryParam("status")
 Set<WorkflowInstance.WorkflowInstanceStatus> statuses,
 @QueryParam("businessKey")
 String businessKey,
 @QueryParam("externalId")
 String externalId,
 @QueryParam("stateVariableKey")
 String stateVariableKey,
 @QueryParam("stateVariableValue")
 String stateVariableValue,
 @QueryParam("includes")
 Set<ApiWorkflowInstanceInclude> includes,
 @QueryParam("include")
 String include,
 @QueryParam("maxResults")
 Long maxResults,
 @QueryParam("maxActions")
 Long maxActions,
 @QueryParam("queryArchive")
 Boolean queryArchive)

setSignal

@PUT
@Path("/{id}/signal")
public jakarta.ws.rs.core.Response setSignal(@PathParam("id")
 long id,
 @Valid
 @Valid SetSignalRequest req)

wakeup

@PUT
@Path("/{id}/wakeup")
public jakarta.ws.rs.core.Response wakeup(@PathParam("id")
 long id,
 @Valid
 @Valid WakeupRequest req)