Package tr.com.havelsan.javarch.bpmn.engine.starter.module.runtime.controller

Class HvlBpmnRuntimeRestController

java.lang.Object
tr.com.havelsan.javarch.bpmn.engine.starter.module.runtime.controller.HvlBpmnRuntimeRestController
All Implemented Interfaces:
HvlBpmnRuntimeOperationalRestService, HvlBpmnRuntimeRestService
@RestController @RequestMapping("${hvl.bpmn.service.runtime.controller-path:/runtime}") @HvlActuatorService(name="hvlBpmnRuntimeRestService", groupName="hvlBpmnRuntime") public class HvlBpmnRuntimeRestController extends Object implements HvlBpmnRuntimeRestService, HvlBpmnRuntimeOperationalRestService
A restful service which provides specific methods for bpmn engine runtime.

  • Constructor Details

    • HvlBpmnRuntimeRestController

      public HvlBpmnRuntimeRestController(HvlBpmnRuntimeService bpmnRuntimeService, HvlBpmnProcessInstanceQueryGenerator processInstanceQueryGenerator, HvlBpmnProcessInstanceMapper processInstanceMapper)
      Instantiates a new Hvl bpmn runtime rest controller.
      Parameters:
      bpmnRuntimeService - the bpmn runtime service
      processInstanceQueryGenerator - the process instance query generator
      processInstanceMapper - the process instance mapper

  • Method Details

    • startProcessInstanceById

      public tr.com.havelsan.javarch.service.data.HvlResponse<HvlBpmnProcessInstanceModel> startProcessInstanceById(@NotBlank @PathVariable("processDefinitionId") @NotBlank String processDefinitionId, @RequestBody HvlBpmnStartProcessInstanceModel startProcessInstanceModel)
      Start process instance.
      Specified by:
      startProcessInstanceById in interface HvlBpmnRuntimeOperationalRestService
      Parameters:
      processDefinitionId - the process definition id
      startProcessInstanceModel - the start process instance model
      Returns:
      the hvl response

    • startProcessInstanceByKey

      public tr.com.havelsan.javarch.service.data.HvlResponse<HvlBpmnProcessInstanceModel> startProcessInstanceByKey(@NotBlank @PathVariable("processDefinitionKey") @NotBlank String processDefinitionKey, @RequestBody HvlBpmnStartProcessInstanceModel runtimeProcessModel)
      Start process instance.
      Specified by:
      startProcessInstanceByKey in interface HvlBpmnRuntimeOperationalRestService
      Parameters:
      processDefinitionKey - the process definition key
      runtimeProcessModel - the start process instance model
      Returns:
      the hvl response

    • isExecutionExists

      public tr.com.havelsan.javarch.service.data.HvlResponse<Boolean> isExecutionExists(@NotBlank @PathVariable("businessKey") @NotBlank String businessKey)
      Check the execution is existed.
      Specified by:
      isExecutionExists in interface HvlBpmnRuntimeRestService
      Parameters:
      businessKey - the business key
      Returns:
      the hvl response

    • queryList

      public tr.com.havelsan.javarch.service.data.HvlResponse<List<HvlBpmnProcessInstanceModel>> queryList(@NotNull @RequestBody @NotNull HvlBpmnProcessInstanceQueryModel processInstanceQueryModel)
      Returns a list of process instance matching the query criteria.
      Specified by:
      queryList in interface HvlBpmnRuntimeRestService
      Parameters:
      processInstanceQueryModel - the process instance query model
      Returns:
      the hvl response

    • queryPage

      public tr.com.havelsan.javarch.service.data.HvlResponse<tr.com.havelsan.javarch.data.commons.pageable.HvlPage<HvlBpmnProcessInstanceModel>> queryPage(@NotNull @RequestBody @NotNull HvlBpmnProcessInstanceQueryModel processDefinitionQueryModel)
      Returns a page of process instance matching the query criteria.
      Specified by:
      queryPage in interface HvlBpmnRuntimeRestService
      Parameters:
      processDefinitionQueryModel - the process definition query model
      Returns:
      the hvl response

    • getVariables

      public tr.com.havelsan.javarch.service.data.HvlResponse<Map<String,Object>> getVariables(@NotBlank @PathVariable("executionId") @NotBlank String executionId)
      Gets execution variables.
      Specified by:
      getVariables in interface HvlBpmnRuntimeRestService
      Parameters:
      executionId - the execution id
      Returns:
      the variables

    • getVariable

      public tr.com.havelsan.javarch.service.data.HvlResponse<Object> getVariable(@NotBlank @PathVariable("executionId") @NotBlank String executionId, @NotBlank @PathVariable("variableName") @NotBlank String variableName)
      Gets execution variable.
      Specified by:
      getVariable in interface HvlBpmnRuntimeRestService
      Parameters:
      executionId - the execution id
      variableName - the variable name
      Returns:
      the variable

    • setVariable

      public tr.com.havelsan.javarch.service.data.HvlResponse<Void> setVariable(@NotBlank @PathVariable("executionId") @NotBlank String executionId, @NotBlank @PathVariable("variableName") @NotBlank String variableName, @NotNull @RequestBody @NotNull Object value)
      Sets execution variable.
      Specified by:
      setVariable in interface HvlBpmnRuntimeOperationalRestService
      Parameters:
      executionId - the execution id
      variableName - the variable name
      value - the value
      Returns:
      the variable