io.nflow.rest.v1.springweb

Class WorkflowInstanceResource

java.lang.Object

io.nflow.rest.v1.ResourceBase

io.nflow.rest.v1.springweb.SpringWebResource

io.nflow.rest.v1.springweb.WorkflowInstanceResource

@RestController
 @RequestMapping(value="/${nflow.rest.path.prefix}/v1/workflow-instance",
                produces="application/json")
 @Component
public class WorkflowInstanceResource
extends SpringWebResource

Field Summary

Fields inherited from class io.nflow.rest.v1.ResourceBase

actions, actionStateVariables, childWorkflows, currentStateVariables, INCLUDE_PARAM_DESC, INCLUDE_PARAM_VALUES

Constructor Summary

Constructors

Constructor and Description
WorkflowInstanceResource(SchedulerService scheduler, io.nflow.engine.service.WorkflowInstanceService workflowInstances, CreateWorkflowConverter createWorkflowConverter, ListWorkflowInstanceConverter listWorkflowConverter, io.nflow.engine.workflow.instance.WorkflowInstanceFactory workflowInstanceFactory, io.nflow.engine.internal.dao.WorkflowInstanceDao workflowInstanceDao)

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<ResponseEntity<?>>	createWorkflowInstance(CreateWorkflowInstanceRequest req)
reactor.core.publisher.Mono<ResponseEntity<?>>	fetchWorkflowInstance(long id, String include, Long maxActions)
reactor.core.publisher.Mono<ResponseEntity<?>>	listWorkflowInstances(List<Long> ids, List<String> types, Long parentWorkflowId, Long parentActionId, List<String> states, List<io.nflow.engine.workflow.instance.WorkflowInstance.WorkflowInstanceStatus> statuses, String businessKey, String externalId, String stateVariableKey, String stateVariableValue, String include, Long maxResults, Long maxActions)
reactor.core.publisher.Mono<ResponseEntity<?>>	setSignal(long id, @Valid SetSignalRequest req)
reactor.core.publisher.Mono<ResponseEntity<?>>	updateWorkflowInstance(long id, UpdateWorkflowInstanceRequest req)
reactor.core.publisher.Mono<ResponseEntity<?>>	wakeup(long id, @Valid WakeupRequest req)

Methods inherited from class io.nflow.rest.v1.springweb.SpringWebResource

handleExceptions, wrapBlocking

Methods inherited from class io.nflow.rest.v1.ResourceBase

fetchWorkflowInstance, handleExceptions, listWorkflowDefinitions, listWorkflowInstances, resolveExceptionHttpStatus, updateWorkflowInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowInstanceResource

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

Method Detail

createWorkflowInstance

@PutMapping(consumes="application/json")
public reactor.core.publisher.Mono<ResponseEntity<?>> createWorkflowInstance(@RequestBody
                                                                                                                      CreateWorkflowInstanceRequest req)

updateWorkflowInstance

@PutMapping(path="/id/{id}",
            consumes="application/json")
public reactor.core.publisher.Mono<ResponseEntity<?>> updateWorkflowInstance(@PathVariable(value="id")
                                                                                                                                                   long id,
                                                                                                                                                   @RequestBody
                                                                                                                                                   UpdateWorkflowInstanceRequest req)

fetchWorkflowInstance

@GetMapping(path="/id/{id}")
public reactor.core.publisher.Mono<ResponseEntity<?>> fetchWorkflowInstance(@PathVariable(value="id")
                                                                                                         long id,
                                                                                                         @RequestParam(value="include",required=false)
                                                                                                         String include,
                                                                                                         @RequestParam(value="maxActions",required=false)
                                                                                                         Long maxActions)

listWorkflowInstances

@GetMapping
public reactor.core.publisher.Mono<ResponseEntity<?>> listWorkflowInstances(@RequestParam(value="id",defaultValue="")
                                                                                        List<Long> ids,
                                                                                        @RequestParam(value="type",defaultValue="")
                                                                                        List<String> types,
                                                                                        @RequestParam(value="parentWorkflowId",required=false)
                                                                                        Long parentWorkflowId,
                                                                                        @RequestParam(value="parentActionId",required=false)
                                                                                        Long parentActionId,
                                                                                        @RequestParam(value="state",defaultValue="")
                                                                                        List<String> states,
                                                                                        @RequestParam(value="status",defaultValue="")
                                                                                        List<io.nflow.engine.workflow.instance.WorkflowInstance.WorkflowInstanceStatus> statuses,
                                                                                        @RequestParam(value="businessKey",required=false)
                                                                                        String businessKey,
                                                                                        @RequestParam(value="externalId",required=false)
                                                                                        String externalId,
                                                                                        @RequestParam(value="stateVariableKey",required=false)
                                                                                        String stateVariableKey,
                                                                                        @RequestParam(value="stateVariableValue",required=false)
                                                                                        String stateVariableValue,
                                                                                        @RequestParam(value="include",required=false)
                                                                                        String include,
                                                                                        @RequestParam(value="maxResults",required=false)
                                                                                        Long maxResults,
                                                                                        @RequestParam(value="maxActions",required=false)
                                                                                        Long maxActions)

setSignal

@PutMapping(path="/{id}/signal",
            consumes="application/json")
public reactor.core.publisher.Mono<ResponseEntity<?>> setSignal(@PathVariable(value="id")
                                                                                                                                          long id,
                                                                                                                                          @RequestBody @Valid
                                                                                                                                          @Valid SetSignalRequest req)

wakeup

@PutMapping(path="/{id}/wakeup",
            consumes="application/json")
public reactor.core.publisher.Mono<ResponseEntity<?>> wakeup(@PathVariable(value="id")
                                                                                                                                       long id,
                                                                                                                                       @RequestBody @Valid
                                                                                                                                       @Valid WakeupRequest req)