Package tr.com.havelsan.javarch.bpmn.admin.cloud.client.module.process.service

Interface HvlBpmnProcessOperationalRestService

All Known Implementing Classes:
HvlBpmnProcessRestController
@Validated @HvlPublicFeignRestService @FeignClient(name="bpmnProcessPrivateRestService", path="${hvl.bpmn.service.process.path:/process}", url="${hvl.bpmn.service.process.url:${hvl.bpmn.service.url}}") public interface HvlBpmnProcessOperationalRestService
A restful service which provides specific operational methods for bpmn admin process.

  • Method Summary

    Modifier and Type
    Method
    Description
    tr.com.havelsan.javarch.service.data.HvlResponse<Void>
    delete(@NotNull Long id)
    Removes object according to provided parameter.
    tr.com.havelsan.javarch.service.data.HvlResponse<Void>
    deployProcess(@NotNull Long processId)
    Deploy process.
    tr.com.havelsan.javarch.service.data.HvlResponseEntity<byte[]>
    exportAll(@NotEmpty List<Long> processIdList)
    Exports all processes as zip file.
    tr.com.havelsan.javarch.service.data.HvlResponseEntity<byte[]>
    exportProcess(@NotNull Long processId)
    Exports process as bpmn xml.
    tr.com.havelsan.javarch.service.data.HvlResponse<List<HvlBpmnProcessModel>>
    importAll(org.springframework.web.multipart.MultipartFile zipFile)
    Imports all bpmn xml files from a zip file.
    tr.com.havelsan.javarch.service.data.HvlResponse<HvlProcessDefinitionImportResultModel>
    importProcess(org.springframework.web.multipart.MultipartFile xmlFile)
    Imports a bpmn xml.
    tr.com.havelsan.javarch.service.data.HvlResponse<Void>
    lock(@NotNull Long id)
    Lock the process.
    tr.com.havelsan.javarch.service.data.HvlResponse<Long>
    save(@Valid HvlBpmnProcessModel bpmnModel, Long sourceProcessId)
    Adds provided object.
    tr.com.havelsan.javarch.service.data.HvlResponse<Void>
    saveProcessModelNode(@NotNull Long modelId, @NotEmpty org.springframework.util.MultiValueMap<String,String> values)
    Saves process model node.
    tr.com.havelsan.javarch.service.data.HvlResponse<Void>
    unlock(@NotNull Long id)
    Unlock the process.
    tr.com.havelsan.javarch.service.data.HvlResponse<Long>
    update(@Valid HvlBpmnProcessModel bpmnModel, Boolean newVersion)
    Edits object associated provided object.
    tr.com.havelsan.javarch.service.data.HvlResponse<Void>
    upgradeVersion(@NotNull String processDefinitionKey, org.springframework.web.multipart.MultipartFile upgradedProcessDefinitionXmlFile)
    Upgrades existing process definition.

  • Method Details

    • save

      @PostMapping(path="/save", consumes="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Long> save(@Valid @RequestBody @Valid HvlBpmnProcessModel bpmnModel, @RequestParam(required=false) Long sourceProcessId)
      Adds provided object.
      Parameters:
      bpmnModel - the bpmn model
      sourceProcessId - the source process's id if cloning is wanted
      Returns:
      the hvl response

    • update

      @PutMapping(path="/update", consumes="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Long> update(@Valid @RequestBody @Valid HvlBpmnProcessModel bpmnModel, @RequestParam Boolean newVersion)
      Edits object associated provided object.
      Parameters:
      bpmnModel - the bpmn model
      newVersion - the new version
      Returns:
      the hvl response

    • delete

      @DeleteMapping(path="/delete/{id}", produces="application/json") tr.com.havelsan.javarch.service.data.HvlResponse<Void> delete(@NotNull @PathVariable("id") @NotNull Long id)
      Removes object according to provided parameter.
      Parameters:
      id - the id
      Returns:
      the hvl response

    • deployProcess

      @PutMapping(path="/deploy/{processId}") tr.com.havelsan.javarch.service.data.HvlResponse<Void> deployProcess(@NotNull @PathVariable("processId") @NotNull Long processId)
      Deploy process.
      Parameters:
      processId - the process id
      Returns:
      the hvl response

    • importProcess

      @PostMapping(path="/import", consumes="multipart/form-data") tr.com.havelsan.javarch.service.data.HvlResponse<HvlProcessDefinitionImportResultModel> importProcess(@RequestPart org.springframework.web.multipart.MultipartFile xmlFile)
      Imports a bpmn xml.
      Parameters:
      xmlFile - the xml file
      Returns:
      the hvl response

    • importAll

      @PostMapping(path="/import/all", consumes="multipart/form-data") tr.com.havelsan.javarch.service.data.HvlResponse<List<HvlBpmnProcessModel>> importAll(@RequestPart org.springframework.web.multipart.MultipartFile zipFile)
      Imports all bpmn xml files from a zip file.
      Parameters:
      zipFile - the zip file
      Returns:
      the hvl response

    • exportProcess

      @GetMapping(path="/export/{processId}") tr.com.havelsan.javarch.service.data.HvlResponseEntity<byte[]> exportProcess(@NotNull @PathVariable("processId") @NotNull Long processId)
      Exports process as bpmn xml.
      Parameters:
      processId - the process id
      Returns:
      the hvl response entity

    • exportAll

      @PostMapping(path="/export/all", consumes="application/json") tr.com.havelsan.javarch.service.data.HvlResponseEntity<byte[]> exportAll(@NotEmpty @RequestBody @NotEmpty List<Long> processIdList)
      Exports all processes as zip file.
      Parameters:
      processIdList - the process id list
      Returns:
      the hvl response entity

    • lock

      @PutMapping(path="/lock/process/{id}") tr.com.havelsan.javarch.service.data.HvlResponse<Void> lock(@NotNull @PathVariable("id") @NotNull Long id)
      Lock the process.
      Parameters:
      id - the id
      Returns:
      the hvl response

    • unlock

      @PutMapping(path="/lock/unlock/process/{id}") tr.com.havelsan.javarch.service.data.HvlResponse<Void> unlock(@NotNull @PathVariable("id") @NotNull Long id)
      Unlock the process.
      Parameters:
      id - the id
      Returns:
      the hvl response

    • saveProcessModelNode

      @PostMapping(value="/model/{modelId}", consumes="application/x-www-form-urlencoded") tr.com.havelsan.javarch.service.data.HvlResponse<Void> saveProcessModelNode(@NotNull @PathVariable("modelId") @NotNull Long modelId, @NotEmpty @RequestBody @NotEmpty org.springframework.util.MultiValueMap<String,String> values)
      Saves process model node.
      Parameters:
      modelId - the model id
      values - the values
      Returns:
      the hvl response

    • upgradeVersion

      @PutMapping(path="/upgrade-version/{processDefinitionKey}", consumes="multipart/form-data") tr.com.havelsan.javarch.service.data.HvlResponse<Void> upgradeVersion(@NotNull @PathVariable("processDefinitionKey") @NotNull String processDefinitionKey, @RequestPart org.springframework.web.multipart.MultipartFile upgradedProcessDefinitionXmlFile)
      Upgrades existing process definition.
      Parameters:
      processDefinitionKey - the process definition key
      upgradedProcessDefinitionXmlFile - the upgraded process definition xml file
      Returns:
      the hvl response