Class TopicSubscriptionBuilderImpl
java.lang.Object
org.camunda.bpm.client.topic.impl.TopicSubscriptionBuilderImpl
- All Implemented Interfaces:
TopicSubscriptionBuilder
- Author:
- Tassilo Weidner
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected ExternalTaskHandler
protected boolean
protected boolean
protected Long
protected static final ExternalTaskClientLogger
protected String
protected String
protected String
protected String
protected TopicSubscriptionManager
protected boolean
-
Constructor Summary
ConstructorDescriptionTopicSubscriptionBuilderImpl
(String topicName, TopicSubscriptionManager topicSubscriptionManager) -
Method Summary
Modifier and TypeMethodDescriptionbusinessKey
(String businessKey) protected void
ensureNotNull
(Object tenantIds, String parameterName) handler
(ExternalTaskHandler externalTaskHandler) includeExtensionProperties
(boolean includeExtensionProperties) localVariables
(boolean localVariables) lockDuration
(long lockDuration) open()
Release the topic subscription for being executed asynchronouslyprocessDefinitionId
(String processDefinitionId) processDefinitionIdIn
(String... processDefinitionIds) processDefinitionKey
(String processDefinitionKey) processDefinitionKeyIn
(String... processDefinitionKeys) processDefinitionVersionTag
(String processDefinitionVersionTag) processVariableEquals
(String name, Object value) processVariablesEqualsIn
(Map<String, Object> processVariables) tenantIdIn
(String... tenantIds) Filter for external tasks without tenant
-
Field Details
-
LOG
-
topicName
-
lockDuration
-
variableNames
-
localVariables
protected boolean localVariables -
businessKey
-
processDefinitionId
-
processDefinitionIds
-
processDefinitionKey
-
processDefinitionKeys
-
processDefinitionVersionTag
-
processVariables
-
withoutTenantId
protected boolean withoutTenantId -
tenantIds
-
externalTaskHandler
-
topicSubscriptionManager
-
includeExtensionProperties
protected boolean includeExtensionProperties
-
-
Constructor Details
-
TopicSubscriptionBuilderImpl
public TopicSubscriptionBuilderImpl(String topicName, TopicSubscriptionManager topicSubscriptionManager)
-
-
Method Details
-
lockDuration
- Specified by:
lockDuration
in interfaceTopicSubscriptionBuilder
- Parameters:
lockDuration
-- in milliseconds to lock the external tasks
- must be greater than zero
- the default lock duration is 20 seconds (20,000 milliseconds)
- overrides the lock duration configured on bootstrapping the client
- Returns:
- the builder
-
handler
- Specified by:
handler
in interfaceTopicSubscriptionBuilder
- Parameters:
externalTaskHandler
- which will be executed for the external task- Returns:
- the builder
-
variables
- Specified by:
variables
in interfaceTopicSubscriptionBuilder
- Parameters:
variableNames
- of variables which are supposed to be retrieved- Returns:
- the builder
-
localVariables
- Specified by:
localVariables
in interfaceTopicSubscriptionBuilder
- Parameters:
localVariables
- whether or not variables from greater scope than the external task should be fetched.false
means all variables visible in the scope of the external task will be fetched,true
means only local variables (to the scope of the external task) will be fetched- Returns:
- the builder
-
businessKey
- Specified by:
businessKey
in interfaceTopicSubscriptionBuilder
- Parameters:
businessKey
- to filter for external tasks that are supposed to be fetched and locked- Returns:
- the builder
-
processDefinitionId
- Specified by:
processDefinitionId
in interfaceTopicSubscriptionBuilder
- Parameters:
processDefinitionId
- to filter for external tasks that are supposed to be fetched and locked- Returns:
- the builder
-
processDefinitionIdIn
- Specified by:
processDefinitionIdIn
in interfaceTopicSubscriptionBuilder
- Parameters:
processDefinitionIds
- to filter for external tasks that are supposed to be fetched and locked- Returns:
- the builder
-
processDefinitionKey
- Specified by:
processDefinitionKey
in interfaceTopicSubscriptionBuilder
- Parameters:
processDefinitionKey
- to filter for external tasks that are supposed to be fetched and locked- Returns:
- the builder
-
processDefinitionKeyIn
- Specified by:
processDefinitionKeyIn
in interfaceTopicSubscriptionBuilder
- Parameters:
processDefinitionKeys
- to filter for external tasks that are supposed to be fetched and locked- Returns:
- the builder
-
processDefinitionVersionTag
- Specified by:
processDefinitionVersionTag
in interfaceTopicSubscriptionBuilder
- Returns:
- the builder
-
processVariablesEqualsIn
- Specified by:
processVariablesEqualsIn
in interfaceTopicSubscriptionBuilder
- Parameters:
processVariables
- of which the external tasks to be retrieved are related to- Returns:
- the builder
-
processVariableEquals
- Specified by:
processVariableEquals
in interfaceTopicSubscriptionBuilder
- Returns:
- the builder
-
withoutTenantId
Description copied from interface:TopicSubscriptionBuilder
Filter for external tasks without tenant- Specified by:
withoutTenantId
in interfaceTopicSubscriptionBuilder
- Returns:
- the builder
-
tenantIdIn
- Specified by:
tenantIdIn
in interfaceTopicSubscriptionBuilder
- Parameters:
tenantIds
- to filter for external tasks that are supposed to be fetched and locked- Returns:
- the builder
-
includeExtensionProperties
- Specified by:
includeExtensionProperties
in interfaceTopicSubscriptionBuilder
- Parameters:
includeExtensionProperties
- whether or not to include custom extension properties for fetched external tasks.true
means all extensionProperties defined in the external task activity will be provided.false
means custom extension properties are not available within the external-task-client. The default isfalse
.- Returns:
- the builder
-
open
Description copied from interface:TopicSubscriptionBuilder
Release the topic subscription for being executed asynchronously- Specified by:
open
in interfaceTopicSubscriptionBuilder
- Returns:
- the builder
-
ensureNotNull
-