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

Class HvlBpmnRepositoryRestController

java.lang.Object

tr.com.havelsan.javarch.bpmn.engine.starter.module.repository.controller.HvlBpmnRepositoryRestController

All Implemented Interfaces:

HvlBpmnRepositoryOperationalRestService, HvlBpmnRepositoryRestService

@RestController
@RequestMapping("${hvl.bpmn.service.repository.controller-path:/repository}")
@HvlActuatorService(name="hvlBpmnRepositoryRestService",
                    groupName="hvlBpmnRepository")
public class HvlBpmnRepositoryRestController
extends Object
implements HvlBpmnRepositoryRestService, HvlBpmnRepositoryOperationalRestService

A restful service which provides specific methods for bpmn engine repository.

Constructor Summary

Constructors

Constructor	Description
HvlBpmnRepositoryRestController(HvlBpmnRepositoryService bpmnRepositoryService, HvlBpmnProcessDefinitonQueryGenerator processDefinitonQueryGenerator, HvlBpmnProcessDefinitionMapper processDefinitionMapper)	Instantiates a new HvlBpmnRepositoryRestController.

Method Summary

Modifier and Type	Method	Description
tr.com.havelsan.javarch.service.data.HvlResponse<Void>	activateProcessDefinition(@NotNull HvlBpmnActivateProcessDefinitionModel activateProcessDefinitionModel)	Activate process definition by id.
tr.com.havelsan.javarch.service.data.HvlResponse<Void>	deploy(org.springframework.web.multipart.MultipartFile xmlFile)	Deploy to engine from bpmn xml.
tr.com.havelsan.javarch.service.data.HvlResponse<Void>	deployList(@NotEmpty List<org.springframework.web.multipart.MultipartFile> xmlFileList)	Deploy to engine from list of bpmn xml.
tr.com.havelsan.javarch.service.data.HvlResponse<byte[]>	getBpmnModelArrayByProcessDefinitionId(@NotBlank String id)	Gets bpmn model array by process definition id.
tr.com.havelsan.javarch.service.data.HvlResponse<List<HvlBpmnProcessDefinitionModel>>	queryList(@NotNull HvlBpmnProcessDefinitionQueryModel processDefinitionQueryModel)	Returns a list of process definition matching the query criteria.
tr.com.havelsan.javarch.service.data.HvlResponse<tr.com.havelsan.javarch.data.commons.pageable.HvlPage<HvlBpmnProcessDefinitionModel>>	queryPage(@NotNull HvlBpmnProcessDefinitionQueryModel processDefinitionQueryModel)	Returns a page of process definition matching the query criteria.
tr.com.havelsan.javarch.service.data.HvlResponse<Void>	suspendProcessDefinition(@NotNull HvlBpmnSuspendProcessDefinitionModel suspendProcessDefinitionModel)	Suspend process definition by id.

Methods inherited from class java.lang.Object

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

Constructor Details

HvlBpmnRepositoryRestController

public HvlBpmnRepositoryRestController(HvlBpmnRepositoryService bpmnRepositoryService,
 HvlBpmnProcessDefinitonQueryGenerator processDefinitonQueryGenerator,
 HvlBpmnProcessDefinitionMapper processDefinitionMapper)

Instantiates a new HvlBpmnRepositoryRestController.

Parameters:

bpmnRepositoryService - the bpmn repository service

processDefinitonQueryGenerator - the process definiton query generator

processDefinitionMapper - the process definition mapper

Method Details

deploy

public tr.com.havelsan.javarch.service.data.HvlResponse<Void> deploy(@RequestPart
 org.springframework.web.multipart.MultipartFile xmlFile)

Deploy to engine from bpmn xml.

Specified by:

deploy in interface HvlBpmnRepositoryOperationalRestService

Parameters:

xmlFile - the xml file

Returns:

the hvl response

deployList

public tr.com.havelsan.javarch.service.data.HvlResponse<Void> deployList(@NotEmpty @RequestPart
 @NotEmpty List<org.springframework.web.multipart.MultipartFile> xmlFileList)

Deploy to engine from list of bpmn xml.

Specified by:

deployList in interface HvlBpmnRepositoryOperationalRestService

Parameters:

xmlFileList - the xml file list

Returns:

the hvl response

getBpmnModelArrayByProcessDefinitionId

public tr.com.havelsan.javarch.service.data.HvlResponse<byte[]> getBpmnModelArrayByProcessDefinitionId(@NotBlank @PathVariable("id")
 @NotBlank String id)
                                                                                                throws IOException

Gets bpmn model array by process definition id.

Specified by:

getBpmnModelArrayByProcessDefinitionId in interface HvlBpmnRepositoryRestService

Parameters:

id - the id

Returns:

the bpmn model array by process definition id

Throws:

IOException - the io exception

suspendProcessDefinition

public tr.com.havelsan.javarch.service.data.HvlResponse<Void> suspendProcessDefinition(@RequestBody @NotNull
 @NotNull HvlBpmnSuspendProcessDefinitionModel suspendProcessDefinitionModel)

Suspend process definition by id.

Specified by:

suspendProcessDefinition in interface HvlBpmnRepositoryOperationalRestService

Parameters:

suspendProcessDefinitionModel - the suspend process definition model

Returns:

the hvl response

activateProcessDefinition

public tr.com.havelsan.javarch.service.data.HvlResponse<Void> activateProcessDefinition(@RequestBody @NotNull
 @NotNull HvlBpmnActivateProcessDefinitionModel activateProcessDefinitionModel)

Activate process definition by id.

Specified by:

activateProcessDefinition in interface HvlBpmnRepositoryOperationalRestService

Parameters:

activateProcessDefinitionModel - the activate process definition model

Returns:

the hvl response

queryList

public tr.com.havelsan.javarch.service.data.HvlResponse<List<HvlBpmnProcessDefinitionModel>> queryList(@RequestBody @NotNull
 @NotNull HvlBpmnProcessDefinitionQueryModel processDefinitionQueryModel)

Description copied from interface: HvlBpmnRepositoryRestService

Returns a list of process definition matching the query criteria.

Specified by:

queryList in interface HvlBpmnRepositoryRestService

Parameters:

processDefinitionQueryModel - the process definition query model

Returns:

the hvl response

queryPage

public tr.com.havelsan.javarch.service.data.HvlResponse<tr.com.havelsan.javarch.data.commons.pageable.HvlPage<HvlBpmnProcessDefinitionModel>> queryPage(@RequestBody @NotNull
 @NotNull HvlBpmnProcessDefinitionQueryModel processDefinitionQueryModel)

Description copied from interface: HvlBpmnRepositoryRestService

Returns a page of process definition matching the query criteria.

Specified by:

queryPage in interface HvlBpmnRepositoryRestService

Parameters:

processDefinitionQueryModel - the process definition query model

Returns:

the hvl response