Package org.flowable.external.client.impl

Class BaseExternalWorkerJobAcquireBuilder

java.lang.Object

org.flowable.external.client.impl.BaseExternalWorkerJobAcquireBuilder

All Implemented Interfaces:

ExternalWorkerJobAcquireBuilder

Direct Known Subclasses:

RestExternalWorkerJobAcquireBuilder

public abstract class BaseExternalWorkerJobAcquireBuilder
extends Object
implements ExternalWorkerJobAcquireBuilder

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected Duration	lockDuration
protected int	numberOfRetries
protected int	numberOfTasks
protected String	scopeType
protected String	topic

Constructor Summary

Constructors

Constructor	Description
BaseExternalWorkerJobAcquireBuilder()

Method Summary

Modifier and Type	Method	Description
final List<AcquiredExternalWorkerJob>	acquireAndLock()	Acquire and lock the configured amount of jobs.
protected abstract List<AcquiredExternalWorkerJob>	acquireAndLockInternal()
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

Methods inherited from class java.lang.Object

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

Field Details

topic

protected String topic

lockDuration

protected Duration lockDuration

scopeType

protected String scopeType

numberOfTasks

protected int numberOfTasks

numberOfRetries

protected int numberOfRetries

Constructor Details

BaseExternalWorkerJobAcquireBuilder

public BaseExternalWorkerJobAcquireBuilder()

Method Details

topic

public ExternalWorkerJobAcquireBuilder topic(String topic)

Description copied from interface: ExternalWorkerJobAcquireBuilder

The topic for the requested jobs

Specified by:

topic in interface ExternalWorkerJobAcquireBuilder

Parameters:

topic - the topic of the jobs

lockDuration

public ExternalWorkerJobAcquireBuilder lockDuration(Duration lockDuration)

Description copied from interface: ExternalWorkerJobAcquireBuilder

How long should the acquired jobs be locked for.

Specified by:

lockDuration in interface ExternalWorkerJobAcquireBuilder

Parameters:

lockDuration - the duration for locking the jobs

onlyBpmn

public ExternalWorkerJobAcquireBuilder onlyBpmn()

Description copied from interface: ExternalWorkerJobAcquireBuilder

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

Specified by:

onlyBpmn in interface ExternalWorkerJobAcquireBuilder

onlyCmmn

public ExternalWorkerJobAcquireBuilder onlyCmmn()

Description copied from interface: ExternalWorkerJobAcquireBuilder

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

Specified by:

onlyCmmn in interface ExternalWorkerJobAcquireBuilder

scopeType

public ExternalWorkerJobAcquireBuilder scopeType(String scopeType)

Description copied from interface: ExternalWorkerJobAcquireBuilder

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

Specified by:

scopeType in interface ExternalWorkerJobAcquireBuilder

numberOfTasks

public ExternalWorkerJobAcquireBuilder numberOfTasks(int numberOfTasks)

Description copied from interface: ExternalWorkerJobAcquireBuilder

The number of tasks that should be acquired.

Specified by:

numberOfTasks in interface ExternalWorkerJobAcquireBuilder

numberOfRetries

public ExternalWorkerJobAcquireBuilder numberOfRetries(int numberOfRetries)

Description copied from interface: ExternalWorkerJobAcquireBuilder

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

Specified by:

numberOfRetries in interface ExternalWorkerJobAcquireBuilder

acquireAndLock

public final List<AcquiredExternalWorkerJob> acquireAndLock()

Description copied from interface: ExternalWorkerJobAcquireBuilder

Acquire and lock the configured amount of jobs.

Specified by:

acquireAndLock in interface ExternalWorkerJobAcquireBuilder

acquireAndLockInternal

protected abstract List<AcquiredExternalWorkerJob> acquireAndLockInternal()