Package org.camunda.bpm.engine.impl.externaltask

Class ExternalTaskQueryTopicBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.externaltask.ExternalTaskQueryTopicBuilderImpl

All Implemented Interfaces:

ExternalTaskQueryBuilder, ExternalTaskQueryTopicBuilder

public class ExternalTaskQueryTopicBuilderImpl
extends Object
implements ExternalTaskQueryTopicBuilder

Author:

Thorben Lindhauer, Christopher Zell

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandExecutor	commandExecutor
protected TopicFetchInstruction	currentInstruction
protected Map<String,TopicFetchInstruction>	instructions
protected int	maxTasks
protected List<QueryOrderingProperty>	orderingProperties
protected boolean	usePriority	Indicates that priority is enabled.
protected String	workerId

Constructor Summary

Constructors

Constructor	Description
ExternalTaskQueryTopicBuilderImpl(ExternalTaskQueryTopicBuilderImpl builder)	Copy constructor
ExternalTaskQueryTopicBuilderImpl(CommandExecutor commandExecutor, String workerId, int maxTasks, boolean usePriority)	Constructor using priority.
ExternalTaskQueryTopicBuilderImpl(CommandExecutor commandExecutor, String workerId, int maxTasks, boolean usePriority, List<QueryOrderingProperty> orderingProperties)	Constructor using priority & createTime.
ExternalTaskQueryTopicBuilderImpl(CommandExecutor commandExecutor, String workerId, int maxTasks, boolean usePriority, List<QueryOrderingProperty> orderingProperties, Map<String,TopicFetchInstruction> instructions, TopicFetchInstruction currentInstruction)	All args constructor.

Method Summary

Modifier and Type	Method	Description
ExternalTaskQueryTopicBuilder	businessKey(String businessKey)	Define business key value to filter external tasks by (Process Instance) Business Key.
ExternalTaskQueryTopicBuilder	enableCustomObjectDeserialization()	Enable deserialization of variable values that are custom objects.
List<LockedExternalTask>	execute()	Performs the fetching.
ExternalTaskQueryTopicBuilder	includeExtensionProperties()	Configure the query to include custom extension properties, if available, for all fetched tasks.
ExternalTaskQueryTopicBuilder	localVariables()	Define whether only local variables will be fetched with all tasks for the current topic.
ExternalTaskQueryTopicBuilder	processDefinitionId(String processDefinitionId)	Define process definition id to filter external tasks by.
ExternalTaskQueryTopicBuilder	processDefinitionIdIn(String... processDefinitionIds)	Define process definition ids to filter external tasksb by.
ExternalTaskQueryTopicBuilder	processDefinitionKey(String processDefinitionKey)	Define process definition key to filter external tasks by.
ExternalTaskQueryTopicBuilder	processDefinitionKeyIn(String... processDefinitionKeys)	Define process definition keys to filter external tasks by.
ExternalTaskQueryTopicBuilder	processDefinitionVersionTag(String processDefinitionVersionTag)	Define a process definition version tag to filter external tasks by.
ExternalTaskQueryTopicBuilder	processInstanceVariableEquals(String name, Object value)	Define a single variable and its name to filter tasks in a topic.
ExternalTaskQueryTopicBuilder	processInstanceVariableEquals(Map<String,Object> variables)	Define a HashMap of variables and their values to filter correlated tasks.
protected void	submitCurrentInstruction()
ExternalTaskQueryTopicBuilder	tenantIdIn(String... tenantIds)	Define tenant ids to filter external tasks by.
ExternalTaskQueryTopicBuilder	topic(String topicName, long lockDuration)	Specifies that tasks of a topic should be fetched and locked for a certain amount of time
ExternalTaskQueryTopicBuilder	variables(String... variables)	Define variables to fetch with all tasks for the current topic.
ExternalTaskQueryTopicBuilder	variables(List<String> variables)	Define variables to fetch with all tasks for the current topic.
ExternalTaskQueryTopicBuilder	withoutTenantId()	Filter external tasks only with null tenant id.

Methods inherited from class java.lang.Object

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

Field Details

commandExecutor

protected CommandExecutor commandExecutor

workerId

protected String workerId

maxTasks

protected int maxTasks

usePriority

protected boolean usePriority

Indicates that priority is enabled.

orderingProperties

protected List<QueryOrderingProperty> orderingProperties

instructions

protected Map<String,TopicFetchInstruction> instructions

currentInstruction

protected TopicFetchInstruction currentInstruction

Constructor Details

ExternalTaskQueryTopicBuilderImpl

public ExternalTaskQueryTopicBuilderImpl(CommandExecutor commandExecutor,
 String workerId,
 int maxTasks,
 boolean usePriority,
 List<QueryOrderingProperty> orderingProperties,
 Map<String,TopicFetchInstruction> instructions,
 TopicFetchInstruction currentInstruction)

All args constructor.

ExternalTaskQueryTopicBuilderImpl

public ExternalTaskQueryTopicBuilderImpl(CommandExecutor commandExecutor,
 String workerId,
 int maxTasks,
 boolean usePriority,
 List<QueryOrderingProperty> orderingProperties)

Constructor using priority & createTime.

ExternalTaskQueryTopicBuilderImpl

public ExternalTaskQueryTopicBuilderImpl(CommandExecutor commandExecutor,
 String workerId,
 int maxTasks,
 boolean usePriority)

Constructor using priority.

ExternalTaskQueryTopicBuilderImpl

public ExternalTaskQueryTopicBuilderImpl(ExternalTaskQueryTopicBuilderImpl builder)

Copy constructor

Method Details

execute

public List<LockedExternalTask> execute()

Description copied from interface: ExternalTaskQueryBuilder

Performs the fetching. Locks candidate tasks of the given topics for the specified duration.

Specified by:

execute in interface ExternalTaskQueryBuilder

Returns:

fetched external tasks that match the topic and that can be successfully locked

topic

public ExternalTaskQueryTopicBuilder topic(String topicName,
 long lockDuration)

Description copied from interface: ExternalTaskQueryBuilder

Specifies that tasks of a topic should be fetched and locked for a certain amount of time

Specified by:

topic in interface ExternalTaskQueryBuilder

Parameters:

topicName - the name of the topic

lockDuration - the duration in milliseconds for which tasks should be locked; begins at the time of fetching

Returns:

variables

public ExternalTaskQueryTopicBuilder variables(String... variables)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define variables to fetch with all tasks for the current topic. Calling this method multiple times overrides the previously specified variables.

Specified by:

variables in interface ExternalTaskQueryTopicBuilder

Parameters:

variables - the variable names to fetch, if null all variables will be fetched

Returns:

this builder

variables

public ExternalTaskQueryTopicBuilder variables(List<String> variables)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define variables to fetch with all tasks for the current topic. Calling this method multiple times overrides the previously specified variables.

Specified by:

variables in interface ExternalTaskQueryTopicBuilder

Parameters:

variables - the variable names to fetch, if null all variables will be fetched

Returns:

this builder

processInstanceVariableEquals

public ExternalTaskQueryTopicBuilder processInstanceVariableEquals(Map<String,Object> variables)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define a HashMap of variables and their values to filter correlated tasks. Calling this method multiple times overrides the previously specified variables.

Specified by:

processInstanceVariableEquals in interface ExternalTaskQueryTopicBuilder

Parameters:

variables - a HashMap of the variable names (keys) and the values to filter by

Returns:

this builder

processInstanceVariableEquals

public ExternalTaskQueryTopicBuilder processInstanceVariableEquals(String name,
 Object value)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define a single variable and its name to filter tasks in a topic. Multiple calls to this method add to the existing "variable filters".

Specified by:

processInstanceVariableEquals in interface ExternalTaskQueryTopicBuilder

Parameters:

name - the name of the variable you want to fetch and query by

value - the value of the variable which you want to filter

Returns:

this builder

businessKey

public ExternalTaskQueryTopicBuilder businessKey(String businessKey)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define business key value to filter external tasks by (Process Instance) Business Key.

Specified by:

businessKey in interface ExternalTaskQueryTopicBuilder

Parameters:

businessKey - the value of the Business Key to filter by

Returns:

this builder

processDefinitionId

public ExternalTaskQueryTopicBuilder processDefinitionId(String processDefinitionId)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define process definition id to filter external tasks by.

Specified by:

processDefinitionId in interface ExternalTaskQueryTopicBuilder

Parameters:

processDefinitionId - the definition id to filter by

Returns:

this builder

processDefinitionIdIn

public ExternalTaskQueryTopicBuilder processDefinitionIdIn(String... processDefinitionIds)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define process definition ids to filter external tasksb by.

Specified by:

processDefinitionIdIn in interface ExternalTaskQueryTopicBuilder

Parameters:

processDefinitionIds - the definition ids to filter by

Returns:

this builder

processDefinitionKey

public ExternalTaskQueryTopicBuilder processDefinitionKey(String processDefinitionKey)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define process definition key to filter external tasks by.

Specified by:

processDefinitionKey in interface ExternalTaskQueryTopicBuilder

Parameters:

processDefinitionKey - the definition key to filter by

Returns:

this builder

processDefinitionKeyIn

public ExternalTaskQueryTopicBuilder processDefinitionKeyIn(String... processDefinitionKeys)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define process definition keys to filter external tasks by.

Specified by:

processDefinitionKeyIn in interface ExternalTaskQueryTopicBuilder

Returns:

this builder

processDefinitionVersionTag

public ExternalTaskQueryTopicBuilder processDefinitionVersionTag(String processDefinitionVersionTag)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define a process definition version tag to filter external tasks by.

Specified by:

processDefinitionVersionTag in interface ExternalTaskQueryTopicBuilder

Parameters:

processDefinitionVersionTag - the version tag to filter by

Returns:

this builder

withoutTenantId

public ExternalTaskQueryTopicBuilder withoutTenantId()

Description copied from interface: ExternalTaskQueryTopicBuilder

Filter external tasks only with null tenant id.

Specified by:

withoutTenantId in interface ExternalTaskQueryTopicBuilder

Returns:

this builder

tenantIdIn

public ExternalTaskQueryTopicBuilder tenantIdIn(String... tenantIds)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define tenant ids to filter external tasks by.

Specified by:

tenantIdIn in interface ExternalTaskQueryTopicBuilder

Parameters:

tenantIds - the tenant ids to filter by

Returns:

this builder

submitCurrentInstruction

protected void submitCurrentInstruction()

enableCustomObjectDeserialization

public ExternalTaskQueryTopicBuilder enableCustomObjectDeserialization()

Description copied from interface: ExternalTaskQueryTopicBuilder

Enable deserialization of variable values that are custom objects. By default, the query will not attempt to deserialize the value of these variables.

Specified by:

enableCustomObjectDeserialization in interface ExternalTaskQueryTopicBuilder

Returns:

this builder

localVariables

public ExternalTaskQueryTopicBuilder localVariables()

Description copied from interface: ExternalTaskQueryTopicBuilder

Define whether only local variables will be fetched with all tasks for the current topic.

Specified by:

localVariables in interface ExternalTaskQueryTopicBuilder

Returns:

this builder

includeExtensionProperties

public ExternalTaskQueryTopicBuilder includeExtensionProperties()

Description copied from interface: ExternalTaskQueryTopicBuilder

Configure the query to include custom extension properties, if available, for all fetched tasks.

Specified by:

includeExtensionProperties in interface ExternalTaskQueryTopicBuilder

Returns:

this builder