Package org.flowable.job.service.impl

Class ExternalWorkerJobAcquireBuilderImpl

java.lang.Object

org.flowable.job.service.impl.ExternalWorkerJobAcquireBuilderImpl

All Implemented Interfaces:

ExternalWorkerJobAcquireBuilder

public class ExternalWorkerJobAcquireBuilderImpl
extends Object
implements ExternalWorkerJobAcquireBuilder

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<String>	authorizedGroups
protected String	authorizedUser
protected final CommandExecutor	commandExecutor
protected final JobServiceConfiguration	jobServiceConfiguration
protected Duration	lockDuration
protected String	scopeType
protected String	tenantId
protected String	topic

Constructor Summary

Constructors

Constructor	Description
ExternalWorkerJobAcquireBuilderImpl(CommandExecutor commandExecutor, JobServiceConfiguration jobServiceConfiguration)

Method Summary

Modifier and Type	Method	Description
List<AcquiredExternalWorkerJob>	acquireAndLock(int numberOfTasks, String workerId, int numberOfRetries)	Acquire and lock the given number of jobs for the given worker id.
ExternalWorkerJobAcquireBuilder	forUserOrGroups(String userId, Collection<String> groups)	Acquire only jobs where the given user or groups are authorized to execute.
Collection<String>	getAuthorizedGroups()
String	getAuthorizedUser()
Duration	getLockDuration()
String	getScopeType()
String	getTenantId()
String	getTopic()
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	tenantId(String tenantId)	Acquire only jobs which are within the given tenant.
ExternalWorkerJobAcquireBuilder	topic(String topic, Duration lockDuration)	The topic and lock duration for the requested jobs

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flowable.job.api.ExternalWorkerJobAcquireBuilder

acquireAndLock

Field Details

commandExecutor

protected final CommandExecutor commandExecutor

jobServiceConfiguration

protected final JobServiceConfiguration jobServiceConfiguration

topic

protected String topic

lockDuration

protected Duration lockDuration

scopeType

protected String scopeType

tenantId

protected String tenantId

authorizedUser

protected String authorizedUser

authorizedGroups

protected Collection<String> authorizedGroups

Constructor Details

ExternalWorkerJobAcquireBuilderImpl

public ExternalWorkerJobAcquireBuilderImpl(CommandExecutor commandExecutor,
 JobServiceConfiguration jobServiceConfiguration)

Method Details

topic

public ExternalWorkerJobAcquireBuilder topic(String topic,
 Duration lockDuration)

Description copied from interface: ExternalWorkerJobAcquireBuilder

The topic and lock duration for the requested jobs

Specified by:

topic in interface ExternalWorkerJobAcquireBuilder

Parameters:

topic - the topic of the jobs

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

tenantId

public ExternalWorkerJobAcquireBuilder tenantId(String tenantId)

Description copied from interface: ExternalWorkerJobAcquireBuilder

Acquire only jobs which are within the given tenant.

Specified by:

tenantId in interface ExternalWorkerJobAcquireBuilder

forUserOrGroups

public ExternalWorkerJobAcquireBuilder forUserOrGroups(String userId,
 Collection<String> groups)

Description copied from interface: ExternalWorkerJobAcquireBuilder

Acquire only jobs where the given user or groups are authorized to execute.

Specified by:

forUserOrGroups in interface ExternalWorkerJobAcquireBuilder

acquireAndLock

public List<AcquiredExternalWorkerJob> acquireAndLock(int numberOfTasks,
 String workerId,
 int numberOfRetries)

Description copied from interface: ExternalWorkerJobAcquireBuilder

Acquire and lock the given number of jobs for the given worker id. If it fails to lock the jobs / scope after numberOfRetries it will return an empty list

Specified by:

acquireAndLock in interface ExternalWorkerJobAcquireBuilder

Parameters:

numberOfTasks - the number of jobs to acquire

workerId - the id of the worker acquiring the jobs

numberOfRetries - the number of retries if an optimistic lock exception occurs during acquiring

getTopic

public String getTopic()

getLockDuration

public Duration getLockDuration()

getScopeType

public String getScopeType()

getTenantId

public String getTenantId()

getAuthorizedUser

public String getAuthorizedUser()

getAuthorizedGroups

public Collection<String> getAuthorizedGroups()