Package io.jmix.stormbpmn.client

Interface StormbpmnClient

All Known Implementing Classes:

StormbpmnClientImpl

@NullMarked
public interface StormbpmnClient

Interface for communicating with Storm BPMN service.

All operations are synchronous and block the current thread until completion.

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	DIAGRAMS_PAGE_SIZE
static final Integer	DIAGRAMS_UPLOAD_BATCH_SIZE

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<String>	getDiagramById(UUID id)	Loads diagram by id.
org.springframework.http.ResponseEntity<String>	getDiagrams(int page)	Loads diagrams list for the specified page.
org.springframework.http.ResponseEntity<String>	uploadDiagrams(Collection<StormbpmnUploadDiagramDto> diagramDtos)	Uploads diagrams to Storm BPMN.

Field Details

DIAGRAMS_PAGE_SIZE

static final Integer DIAGRAMS_PAGE_SIZE

DIAGRAMS_UPLOAD_BATCH_SIZE

static final Integer DIAGRAMS_UPLOAD_BATCH_SIZE

Method Details

getDiagramById

org.springframework.http.ResponseEntity<String> getDiagramById(UUID id)
                                                        throws IOException,
InterruptedException

Loads diagram by id.

Parameters:

id - diagram id

Returns:

response entity with JSON body

Throws:

IOException - if an I/ O error occurs when sending or receiving

InterruptedException - if the operation is interrupted

getDiagrams

org.springframework.http.ResponseEntity<String> getDiagrams(int page)
                                                     throws IOException,
InterruptedException

Loads diagrams list for the specified page.

Parameters:

page - page number starts from 0

Returns:

response entity with JSON body

Throws:

IOException - if an I/ O error occurs when sending or receiving

InterruptedException - if the operation is interrupted

uploadDiagrams

org.springframework.http.ResponseEntity<String> uploadDiagrams(Collection<StormbpmnUploadDiagramDto> diagramDtos)
                                                        throws IOException,
InterruptedException

Uploads diagrams to Storm BPMN.

Note, maximum available diagrams size for single request is DIAGRAMS_UPLOAD_BATCH_SIZE.

Parameters:

diagramDtos - diagram DTOs to upload

Returns:

response entity with JSON body

Throws:

IOException - if an I/ O error occurs when sending or receiving

InterruptedException - if the operation is interrupted