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 Summary
ConstructorDescriptionHvlBpmnRuntimeRestController
(HvlBpmnRuntimeService bpmnRuntimeService, HvlBpmnProcessInstanceQueryGenerator processInstanceQueryGenerator, HvlBpmnProcessInstanceMapper processInstanceMapper) Instantiates a new Hvl bpmn runtime rest controller. -
Method Summary
Modifier and TypeMethodDescriptiontr.com.havelsan.javarch.service.data.HvlResponse
<Object> getVariable
(@NotBlank String executionId, @NotBlank String variableName) Gets execution variable.getVariables
(@NotBlank String executionId) Gets execution variables.tr.com.havelsan.javarch.service.data.HvlResponse
<Boolean> isExecutionExists
(@NotBlank String businessKey) Check the execution is existed.tr.com.havelsan.javarch.service.data.HvlResponse
<List<HvlBpmnProcessInstanceModel>> queryList
(@NotNull HvlBpmnProcessInstanceQueryModel processInstanceQueryModel) Returns a list of process instance matching the query criteria.tr.com.havelsan.javarch.service.data.HvlResponse
<tr.com.havelsan.javarch.data.commons.pageable.HvlPage<HvlBpmnProcessInstanceModel>> queryPage
(@NotNull HvlBpmnProcessInstanceQueryModel processDefinitionQueryModel) Returns a page of process instance matching the query criteria.tr.com.havelsan.javarch.service.data.HvlResponse
<Void> setVariable
(@NotBlank String executionId, @NotBlank String variableName, @NotNull Object value) Sets execution variable.tr.com.havelsan.javarch.service.data.HvlResponse
<HvlBpmnProcessInstanceModel> startProcessInstanceById
(@NotBlank String processDefinitionId, HvlBpmnStartProcessInstanceModel startProcessInstanceModel) Start process instance.tr.com.havelsan.javarch.service.data.HvlResponse
<HvlBpmnProcessInstanceModel> startProcessInstanceByKey
(@NotBlank String processDefinitionKey, HvlBpmnStartProcessInstanceModel runtimeProcessModel) Start process instance.
-
Constructor Details
-
HvlBpmnRuntimeRestController
public HvlBpmnRuntimeRestController(HvlBpmnRuntimeService bpmnRuntimeService, HvlBpmnProcessInstanceQueryGenerator processInstanceQueryGenerator, HvlBpmnProcessInstanceMapper processInstanceMapper) Instantiates a new Hvl bpmn runtime rest controller.- Parameters:
bpmnRuntimeService
- the bpmn runtime serviceprocessInstanceQueryGenerator
- the process instance query generatorprocessInstanceMapper
- 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 interfaceHvlBpmnRuntimeOperationalRestService
- Parameters:
processDefinitionId
- the process definition idstartProcessInstanceModel
- 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 interfaceHvlBpmnRuntimeOperationalRestService
- Parameters:
processDefinitionKey
- the process definition keyruntimeProcessModel
- 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 interfaceHvlBpmnRuntimeRestService
- 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 interfaceHvlBpmnRuntimeRestService
- 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 interfaceHvlBpmnRuntimeRestService
- 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 interfaceHvlBpmnRuntimeRestService
- 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 interfaceHvlBpmnRuntimeRestService
- Parameters:
executionId
- the execution idvariableName
- 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 interfaceHvlBpmnRuntimeOperationalRestService
- Parameters:
executionId
- the execution idvariableName
- the variable namevalue
- the value- Returns:
- the variable
-