Package org.flowable.external.client

Interface ExternalWorkerJobAcquireBuilder

All Known Implementing Classes:

BaseExternalWorkerJobAcquireBuilder, RestExternalWorkerJobAcquireBuilder

public interface ExternalWorkerJobAcquireBuilder

A builder providing configuration options for acquiring external worker jobs.

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method	Description
List<AcquiredExternalWorkerJob>	acquireAndLock()	Acquire and lock the configured amount of jobs.
ExternalWorkerJobAcquireBuilder	lockDuration(Duration lockDuration)	How long should the acquired jobs be locked for.
ExternalWorkerJobAcquireBuilder	numberOfRetries(int numberOfRetries)	The number of retries in case an optimistic lock exception occurs during acquiring.
ExternalWorkerJobAcquireBuilder	numberOfTasks(int numberOfTasks)	The number of tasks that should be acquired.
ExternalWorkerJobAcquireBuilder	onlyBpmn()	Acquire only jobs which are linked to a process instance.
ExternalWorkerJobAcquireBuilder	onlyCmmn()	Acquire only jobs which are linked to a case instance.
ExternalWorkerJobAcquireBuilder	scopeType(String scopeType)	Acquire only jobs which are linked to the given scope type.
ExternalWorkerJobAcquireBuilder	topic(String topic)	The topic for the requested jobs

Method Details

topic

ExternalWorkerJobAcquireBuilder topic(String topic)

The topic for the requested jobs

Parameters:

topic - the topic of the jobs

lockDuration

ExternalWorkerJobAcquireBuilder lockDuration(Duration lockDuration)

How long should the acquired jobs be locked for.

Parameters:

lockDuration - the duration for locking the jobs

onlyBpmn

ExternalWorkerJobAcquireBuilder onlyBpmn()

Acquire only jobs which are linked to a process instance. Cannot be combined with onlyCmmn() and scopeType(String)

onlyCmmn

ExternalWorkerJobAcquireBuilder onlyCmmn()

Acquire only jobs which are linked to a case instance. Cannot be combined with onlyBpmn() and scopeType(String)

scopeType

ExternalWorkerJobAcquireBuilder scopeType(String scopeType)

Acquire only jobs which are linked to the given scope type. Cannot be combined with onlyBpmn() or onlyCmmn()

numberOfTasks

ExternalWorkerJobAcquireBuilder numberOfTasks(int numberOfTasks)

The number of tasks that should be acquired.

numberOfRetries

ExternalWorkerJobAcquireBuilder numberOfRetries(int numberOfRetries)

The number of retries in case an optimistic lock exception occurs during acquiring.

acquireAndLock

List<AcquiredExternalWorkerJob> acquireAndLock()

Acquire and lock the configured amount of jobs.