Class TopicSubscriptionImpl
java.lang.Object
org.camunda.bpm.client.topic.impl.TopicSubscriptionImpl
- All Implemented Interfaces:
TopicSubscription
- Author:
- Tassilo Weidner
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected ExternalTaskHandler
protected boolean
protected boolean
protected Long
protected String
protected String
protected String
protected String
protected TopicSubscriptionManager
protected boolean
-
Constructor Summary
ConstructorDescriptionTopicSubscriptionImpl
(String topicName, Long lockDuration, ExternalTaskHandler externalTaskHandler, TopicSubscriptionManager topicSubscriptionManager, List<String> variableNames, String businessKey) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
The client has been unsubscribed from the topic.boolean
int
hashCode()
boolean
boolean
boolean
void
setIncludeExtensionProperties
(boolean includeExtensionProperties) void
setLocalVariables
(boolean localVariables) setProcessDefinitionId
(String processDefinitionId) setProcessDefinitionIdIn
(List<String> processDefinitionIds) setProcessDefinitionKey
(String processDefinitionKey) setProcessDefinitionKeyIn
(List<String> processDefinitionKeys) void
setProcessDefinitionVersionTag
(String processDefinitionVersionTag) void
setProcessVariables
(Map<String, Object> processVariables) setTenantIdIn
(List<String> tenantIds) void
setWithoutTenantId
(boolean withoutTenantId)
-
Field Details
-
topicName
-
lockDuration
-
externalTaskHandler
-
topicSubscriptionManager
-
variableNames
-
localVariables
protected boolean localVariables -
businessKey
-
processDefinitionId
-
processDefinitionIdIn
-
processDefinitionKey
-
processDefinitionKeyIn
-
processDefinitionVersionTag
-
processVariables
-
withoutTenantId
protected boolean withoutTenantId -
tenantIdIn
-
includeExtensionProperties
protected boolean includeExtensionProperties
-
-
Constructor Details
-
TopicSubscriptionImpl
public TopicSubscriptionImpl(String topicName, Long lockDuration, ExternalTaskHandler externalTaskHandler, TopicSubscriptionManager topicSubscriptionManager, List<String> variableNames, String businessKey)
-
-
Method Details
-
getTopicName
- Specified by:
getTopicName
in interfaceTopicSubscription
- Returns:
- the topic name of the subscription
-
getLockDuration
- Specified by:
getLockDuration
in interfaceTopicSubscription
- Returns:
- the duration of the lock applied to the topic
- if
null
, the client or the default lock duration is applied
-
getExternalTaskHandler
- Specified by:
getExternalTaskHandler
in interfaceTopicSubscription
- Returns:
- the external task handler of the topic
-
close
public void close()Description copied from interface:TopicSubscription
The client has been unsubscribed from the topic. NB! It can happen, that the changes are not applied immediately, in case the client is currently iterating over the bunch of fetched and locked external tasks. The changes will have affect starting from the next bunch only.- Specified by:
close
in interfaceTopicSubscription
-
getVariableNames
- Specified by:
getVariableNames
in interfaceTopicSubscription
- Returns:
- a list of variable names which are supposed to be retrieved
-
isLocalVariables
public boolean isLocalVariables()- Specified by:
isLocalVariables
in interfaceTopicSubscription
- Returns:
- whether or not variables from greater scopes than the external task
are 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.
-
setLocalVariables
public void setLocalVariables(boolean localVariables) -
getBusinessKey
- Specified by:
getBusinessKey
in interfaceTopicSubscription
- Returns:
- the business key associated with the external tasks which are supposed to be fetched and locked
-
getProcessDefinitionId
- Specified by:
getProcessDefinitionId
in interfaceTopicSubscription
- Returns:
- the process definition id associated with the external tasks which are supposed to be fetched and locked
-
setProcessDefinitionId
-
getProcessDefinitionIdIn
- Specified by:
getProcessDefinitionIdIn
in interfaceTopicSubscription
- Returns:
- the process definition ids associated with the external tasks which are supposed to be fetched and locked
-
setProcessDefinitionIdIn
-
getProcessDefinitionKey
- Specified by:
getProcessDefinitionKey
in interfaceTopicSubscription
- Returns:
- the process definition key associated with the external tasks which are supposed to be fetched and locked
-
setProcessDefinitionKey
-
getProcessDefinitionKeyIn
- Specified by:
getProcessDefinitionKeyIn
in interfaceTopicSubscription
- Returns:
- the process definition keys associated with the external tasks which are supposed to be fetched and locked
-
setProcessDefinitionKeyIn
-
getProcessDefinitionVersionTag
- Specified by:
getProcessDefinitionVersionTag
in interfaceTopicSubscription
- Returns:
- the process definition version tag associated with the external task which are supposed to be fetched and locked
-
setProcessDefinitionVersionTag
-
getProcessVariables
- Specified by:
getProcessVariables
in interfaceTopicSubscription
- Returns:
- the process variables associated with the external task which are supposed to be fetched and locked
-
setProcessVariables
-
isWithoutTenantId
public boolean isWithoutTenantId()- Specified by:
isWithoutTenantId
in interfaceTopicSubscription
- Returns:
- the tenant id presence for the external tasks which are supposed to be fetched and locked
-
setWithoutTenantId
public void setWithoutTenantId(boolean withoutTenantId) -
getTenantIdIn
- Specified by:
getTenantIdIn
in interfaceTopicSubscription
- Returns:
- the tenant ids associated with the external tasks which are supposed to be fetched and locked
-
setTenantIdIn
-
isIncludeExtensionProperties
public boolean isIncludeExtensionProperties()- Specified by:
isIncludeExtensionProperties
in interfaceTopicSubscription
- Returns:
- whether or not custom extension properties defined in the external
task activity are included. The default is
false
, which means that no extension properties will be available within the external-task-client.true
means that all defined extension properties are fetched and provided.
-
setIncludeExtensionProperties
public void setIncludeExtensionProperties(boolean includeExtensionProperties) -
hashCode
public int hashCode() -
equals
-