Package org.finos.fluxnova.bpm.engine.rest.impl

Class ProcessInstanceRestServiceImpl

java.lang.Object

org.finos.fluxnova.bpm.engine.rest.impl.AbstractRestProcessEngineAware

org.finos.fluxnova.bpm.engine.rest.impl.ProcessInstanceRestServiceImpl

All Implemented Interfaces:

ProcessInstanceRestService

public class ProcessInstanceRestServiceImpl
extends AbstractRestProcessEngineAware
implements ProcessInstanceRestService

Field Summary

Fields inherited from class org.finos.fluxnova.bpm.engine.rest.impl.AbstractRestProcessEngineAware

objectMapper, relativeRootResourcePath

Fields inherited from interface org.finos.fluxnova.bpm.engine.rest.ProcessInstanceRestService

PATH

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceRestServiceImpl(String engineName, tools.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
BatchDto	correlateMessageAsync(CorrelationMessageAsyncDto correlationMessageAsyncDto)
BatchDto	deleteAsync(DeleteProcessInstancesDto dto)
BatchDto	deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto deleteProcessInstancesDto)
ProcessInstanceResource	getProcessInstance(String processInstanceId)
List<ProcessInstanceDto>	getProcessInstances(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)	Exposes the ProcessInstanceQuery interface as a REST service.
CountResultDto	getProcessInstancesCount(jakarta.ws.rs.core.UriInfo uriInfo)
List<ProcessInstanceCountStatisticsDto>	getProcessInstanceStatistics(ProcessInstanceCountRequestDto requestDto)	Retrieves statistics about process instance counts based on the provided request criteria.
List<ProcessInstanceDto>	queryProcessInstances(ProcessInstanceQueryDto queryDto, Integer firstResult, Integer maxResults)	Expects the same parameters as ProcessInstanceRestService.getProcessInstances(UriInfo, Integer, Integer) (as a JSON message body) and allows for any number of variable checks.
CountResultDto	queryProcessInstancesCount(ProcessInstanceQueryDto queryDto)
BatchDto	setRetriesByProcess(SetJobRetriesByProcessDto setJobRetriesDto)
BatchDto	setRetriesByProcessHistoricQueryBased(SetJobRetriesByProcessDto setJobRetriesDto)
BatchDto	setVariablesAsync(SetVariablesAsyncDto setVariablesAsyncDto)
protected <T extends Query<?, ?>, R extends AbstractQueryDto<T>> T	toQuery(R query)
void	updateSuspensionState(ProcessInstanceSuspensionStateDto dto)
BatchDto	updateSuspensionStateAsync(ProcessInstanceSuspensionStateAsyncDto dto)

Methods inherited from class org.finos.fluxnova.bpm.engine.rest.impl.AbstractRestProcessEngineAware

getObjectMapper, getProcessEngine, setRelativeRootResourceUri

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessInstanceRestServiceImpl

public ProcessInstanceRestServiceImpl(String engineName,
 tools.jackson.databind.ObjectMapper objectMapper)

Method Details

getProcessInstances

public List<ProcessInstanceDto> getProcessInstances(jakarta.ws.rs.core.UriInfo uriInfo,
 Integer firstResult,
 Integer maxResults)

Description copied from interface: ProcessInstanceRestService

Exposes the ProcessInstanceQuery interface as a REST service.

Specified by:

getProcessInstances in interface ProcessInstanceRestService

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryProcessInstances

public List<ProcessInstanceDto> queryProcessInstances(ProcessInstanceQueryDto queryDto,
 Integer firstResult,
 Integer maxResults)

Description copied from interface: ProcessInstanceRestService

Expects the same parameters as ProcessInstanceRestService.getProcessInstances(UriInfo, Integer, Integer) (as a JSON message body) and allows for any number of variable checks.

Specified by:

queryProcessInstances in interface ProcessInstanceRestService

Parameters:

queryDto -

firstResult -

maxResults -

Returns:

getProcessInstancesCount

public CountResultDto getProcessInstancesCount(jakarta.ws.rs.core.UriInfo uriInfo)

Specified by:

getProcessInstancesCount in interface ProcessInstanceRestService

queryProcessInstancesCount

public CountResultDto queryProcessInstancesCount(ProcessInstanceQueryDto queryDto)

Specified by:

queryProcessInstancesCount in interface ProcessInstanceRestService

getProcessInstance

public ProcessInstanceResource getProcessInstance(String processInstanceId)

Specified by:

getProcessInstance in interface ProcessInstanceRestService

updateSuspensionState

public void updateSuspensionState(ProcessInstanceSuspensionStateDto dto)

Specified by:

updateSuspensionState in interface ProcessInstanceRestService

updateSuspensionStateAsync

public BatchDto updateSuspensionStateAsync(ProcessInstanceSuspensionStateAsyncDto dto)

Specified by:

updateSuspensionStateAsync in interface ProcessInstanceRestService

deleteAsync

public BatchDto deleteAsync(DeleteProcessInstancesDto dto)

Specified by:

deleteAsync in interface ProcessInstanceRestService

deleteAsyncHistoricQueryBased

public BatchDto deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto deleteProcessInstancesDto)

Specified by:

deleteAsyncHistoricQueryBased in interface ProcessInstanceRestService

setRetriesByProcess

public BatchDto setRetriesByProcess(SetJobRetriesByProcessDto setJobRetriesDto)

Specified by:

setRetriesByProcess in interface ProcessInstanceRestService

setRetriesByProcessHistoricQueryBased

public BatchDto setRetriesByProcessHistoricQueryBased(SetJobRetriesByProcessDto setJobRetriesDto)

Specified by:

setRetriesByProcessHistoricQueryBased in interface ProcessInstanceRestService

setVariablesAsync

public BatchDto setVariablesAsync(SetVariablesAsyncDto setVariablesAsyncDto)

Specified by:

setVariablesAsync in interface ProcessInstanceRestService

correlateMessageAsync

public BatchDto correlateMessageAsync(CorrelationMessageAsyncDto correlationMessageAsyncDto)

Specified by:

correlateMessageAsync in interface ProcessInstanceRestService

toQuery

protected <T extends Query<?,
?>,
R extends AbstractQueryDto<T>>
T toQuery(R query)

getProcessInstanceStatistics

public List<ProcessInstanceCountStatisticsDto> getProcessInstanceStatistics(ProcessInstanceCountRequestDto requestDto)

Description copied from interface: ProcessInstanceRestService

Retrieves statistics about process instance counts based on the provided request criteria.

This endpoint accepts a ProcessInstanceCountRequestDto in the request body, which can specify various filters and grouping options. The response is a list of ProcessInstanceCountStatisticsDto objects, each representing aggregated statistics for process instances matching the criteria.

Typical use cases include reporting, monitoring, or dashboarding scenarios where grouped or filtered process instance counts are required.

Specified by:

getProcessInstanceStatistics in interface ProcessInstanceRestService

Parameters:

requestDto - the request object containing filtering and grouping criteria

Returns:

a list of statistics objects, each containing count information for a group of process instances