org.camunda.bpm.client.topic.impl

Class TopicSubscriptionImpl

java.lang.Object

org.camunda.bpm.client.topic.impl.TopicSubscriptionImpl

All Implemented Interfaces:

TopicSubscription

public class TopicSubscriptionImpl
extends Object
implements TopicSubscription

Author:

Tassilo Weidner

Field Summary

Fields

Modifier and Type	Field and Description
protected String	businessKey
protected ExternalTaskHandler	externalTaskHandler
protected boolean	includeExtensionProperties
protected boolean	localVariables
protected Long	lockDuration
protected String	processDefinitionId
protected List<String>	processDefinitionIdIn
protected String	processDefinitionKey
protected List<String>	processDefinitionKeyIn
protected String	processDefinitionVersionTag
protected Map<String,Object>	processVariables
protected List<String>	tenantIdIn
protected String	topicName
protected TopicSubscriptionManager	topicSubscriptionManager
protected List<String>	variableNames
protected boolean	withoutTenantId

Constructor Summary

Constructors

Constructor and Description
TopicSubscriptionImpl(String topicName, Long lockDuration, ExternalTaskHandler externalTaskHandler, TopicSubscriptionManager topicSubscriptionManager, List<String> variableNames, String businessKey)

Method Summary

Modifier and Type	Method and Description
void	close() The client has been unsubscribed from the topic.
boolean	equals(Object obj)
String	getBusinessKey()
ExternalTaskHandler	getExternalTaskHandler()
Long	getLockDuration()
String	getProcessDefinitionId()
List<String>	getProcessDefinitionIdIn()
String	getProcessDefinitionKey()
List<String>	getProcessDefinitionKeyIn()
String	getProcessDefinitionVersionTag()
HashMap<String,Object>	getProcessVariables()
List<String>	getTenantIdIn()
String	getTopicName()
List<String>	getVariableNames()
int	hashCode()
boolean	isIncludeExtensionProperties()
boolean	isLocalVariables()
boolean	isWithoutTenantId()
void	setIncludeExtensionProperties(boolean includeExtensionProperties)
void	setLocalVariables(boolean localVariables)
TopicSubscription	setProcessDefinitionId(String processDefinitionId)
TopicSubscription	setProcessDefinitionIdIn(List<String> processDefinitionIds)
TopicSubscription	setProcessDefinitionKey(String processDefinitionKey)
TopicSubscription	setProcessDefinitionKeyIn(List<String> processDefinitionKeys)
void	setProcessDefinitionVersionTag(String processDefinitionVersionTag)
void	setProcessVariables(Map<String,Object> processVariables)
TopicSubscription	setTenantIdIn(List<String> tenantIds)
void	setWithoutTenantId(boolean withoutTenantId)

Methods inherited from class java.lang.Object

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

Field Detail

topicName

protected String topicName

lockDuration

protected Long lockDuration

externalTaskHandler

protected ExternalTaskHandler externalTaskHandler

topicSubscriptionManager

protected TopicSubscriptionManager topicSubscriptionManager

variableNames

protected List<String> variableNames

localVariables

protected boolean localVariables

businessKey

protected String businessKey

processDefinitionId

protected String processDefinitionId

processDefinitionIdIn

protected List<String> processDefinitionIdIn

processDefinitionKey

protected String processDefinitionKey

processDefinitionKeyIn

protected List<String> processDefinitionKeyIn

processDefinitionVersionTag

protected String processDefinitionVersionTag

processVariables

protected Map<String,Object> processVariables

withoutTenantId

protected boolean withoutTenantId

tenantIdIn

protected List<String> tenantIdIn

includeExtensionProperties

protected boolean includeExtensionProperties

Constructor Detail

TopicSubscriptionImpl

public TopicSubscriptionImpl(String topicName,
                             Long lockDuration,
                             ExternalTaskHandler externalTaskHandler,
                             TopicSubscriptionManager topicSubscriptionManager,
                             List<String> variableNames,
                             String businessKey)

Method Detail

getTopicName

public String getTopicName()

Specified by:

getTopicName in interface TopicSubscription

Returns:

the topic name of the subscription

getLockDuration

public Long getLockDuration()

Specified by:

getLockDuration in interface TopicSubscription

Returns:

• the duration of the lock applied to the topic
• if null, the client or the default lock duration is applied

getExternalTaskHandler

public ExternalTaskHandler getExternalTaskHandler()

Specified by:

getExternalTaskHandler in interface TopicSubscription

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 interface TopicSubscription

getVariableNames

public List<String> getVariableNames()

Specified by:

getVariableNames in interface TopicSubscription

Returns:

a list of variable names which are supposed to be retrieved

isLocalVariables

public boolean isLocalVariables()

Specified by:

isLocalVariables in interface TopicSubscription

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

public String getBusinessKey()

Specified by:

getBusinessKey in interface TopicSubscription

Returns:

the business key associated with the external tasks which are supposed to be fetched and locked

getProcessDefinitionId

public String getProcessDefinitionId()

Specified by:

getProcessDefinitionId in interface TopicSubscription

Returns:

the process definition id associated with the external tasks which are supposed to be fetched and locked

setProcessDefinitionId

public TopicSubscription setProcessDefinitionId(String processDefinitionId)

getProcessDefinitionIdIn

public List<String> getProcessDefinitionIdIn()

Specified by:

getProcessDefinitionIdIn in interface TopicSubscription

Returns:

the process definition ids associated with the external tasks which are supposed to be fetched and locked

setProcessDefinitionIdIn

public TopicSubscription setProcessDefinitionIdIn(List<String> processDefinitionIds)

getProcessDefinitionKey

public String getProcessDefinitionKey()

Specified by:

getProcessDefinitionKey in interface TopicSubscription

Returns:

the process definition key associated with the external tasks which are supposed to be fetched and locked

setProcessDefinitionKey

public TopicSubscription setProcessDefinitionKey(String processDefinitionKey)

getProcessDefinitionKeyIn

public List<String> getProcessDefinitionKeyIn()

Specified by:

getProcessDefinitionKeyIn in interface TopicSubscription

Returns:

the process definition keys associated with the external tasks which are supposed to be fetched and locked

setProcessDefinitionKeyIn

public TopicSubscription setProcessDefinitionKeyIn(List<String> processDefinitionKeys)

getProcessDefinitionVersionTag

public String getProcessDefinitionVersionTag()

Specified by:

getProcessDefinitionVersionTag in interface TopicSubscription

Returns:

the process definition version tag associated with the external task which are supposed to be fetched and locked

setProcessDefinitionVersionTag

public void setProcessDefinitionVersionTag(String processDefinitionVersionTag)

getProcessVariables

public HashMap<String,Object> getProcessVariables()

Specified by:

getProcessVariables in interface TopicSubscription

Returns:

the process variables associated with the external task which are supposed to be fetched and locked

setProcessVariables

public void setProcessVariables(Map<String,Object> processVariables)

isWithoutTenantId

public boolean isWithoutTenantId()

Specified by:

isWithoutTenantId in interface TopicSubscription

Returns:

the tenant id presence for the external tasks which are supposed to be fetched and locked

setWithoutTenantId

public void setWithoutTenantId(boolean withoutTenantId)

getTenantIdIn

public List<String> getTenantIdIn()

Specified by:

getTenantIdIn in interface TopicSubscription

Returns:

the tenant ids associated with the external tasks which are supposed to be fetched and locked

setTenantIdIn

public TopicSubscription setTenantIdIn(List<String> tenantIds)

isIncludeExtensionProperties

public boolean isIncludeExtensionProperties()

Specified by:

isIncludeExtensionProperties in interface TopicSubscription

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()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object