TopicSubscriptionBuilderImpl (Camunda Platform Javadocs 7.15.19-ee)

java.lang.Object
- org.camunda.bpm.client.topic.impl.TopicSubscriptionBuilderImpl

All Implemented Interfaces:: TopicSubscriptionBuilder

public class TopicSubscriptionBuilderImpl
extends Object
implements TopicSubscriptionBuilder

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 static ExternalTaskClientLogger`	`LOG`
`protected String`	`processDefinitionId`
`protected List<String>`	`processDefinitionIds`
`protected String`	`processDefinitionKey`
`protected List<String>`	`processDefinitionKeys`
`protected String`	`processDefinitionVersionTag`
`protected Map<String,Object>`	`processVariables`
`protected List<String>`	`tenantIds`
`protected String`	`topicName`
`protected TopicSubscriptionManager`	`topicSubscriptionManager`
`protected List<String>`	`variableNames`
`protected boolean`	`withoutTenantId`

Constructor Summary

Constructors
Constructor and Description

TopicSubscriptionBuilderImpl(String topicName, TopicSubscriptionManager topicSubscriptionManager)

Constructors
Constructor and Description
`TopicSubscriptionBuilderImpl(String topicName, TopicSubscriptionManager topicSubscriptionManager)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TopicSubscriptionBuilder`	`businessKey(String businessKey)`
`protected void`	`ensureNotNull(Object tenantIds, String parameterName)`
`TopicSubscriptionBuilder`	`handler(ExternalTaskHandler externalTaskHandler)`
`TopicSubscriptionBuilder`	`includeExtensionProperties(boolean includeExtensionProperties)`
`TopicSubscriptionBuilder`	`localVariables(boolean localVariables)`
`TopicSubscriptionBuilder`	`lockDuration(long lockDuration)`
`TopicSubscription`	`open()` Release the topic subscription for being executed asynchronously
`TopicSubscriptionBuilder`	`processDefinitionId(String processDefinitionId)`
`TopicSubscriptionBuilder`	`processDefinitionIdIn(String... processDefinitionIds)`
`TopicSubscriptionBuilder`	`processDefinitionKey(String processDefinitionKey)`
`TopicSubscriptionBuilder`	`processDefinitionKeyIn(String... processDefinitionKeys)`
`TopicSubscriptionBuilder`	`processDefinitionVersionTag(String processDefinitionVersionTag)`
`TopicSubscriptionBuilder`	`processVariableEquals(String name, Object value)`
`TopicSubscriptionBuilder`	`processVariablesEqualsIn(Map<String,Object> processVariables)`
`TopicSubscriptionBuilder`	`tenantIdIn(String... tenantIds)`
`TopicSubscriptionBuilder`	`variables(String... variableNames)`
`TopicSubscriptionBuilder`	`withoutTenantId()` Filter for external tasks without tenant

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
protected static final ExternalTaskClientLogger LOG
```
  - topicName
```
protected String topicName
```
  - lockDuration
```
protected Long lockDuration
```
  - variableNames
```
protected List<String> variableNames
```
  - localVariables
```
protected boolean localVariables
```
  - businessKey
```
protected String businessKey
```
  - processDefinitionId
```
protected String processDefinitionId
```
  - processDefinitionIds
```
protected List<String> processDefinitionIds
```
  - processDefinitionKey
```
protected String processDefinitionKey
```
  - processDefinitionKeys
```
protected List<String> processDefinitionKeys
```
  - processDefinitionVersionTag
```
protected String processDefinitionVersionTag
```
  - processVariables
```
protected Map<String,Object> processVariables
```
  - withoutTenantId
```
protected boolean withoutTenantId
```
  - tenantIds
```
protected List<String> tenantIds
```
  - externalTaskHandler
```
protected ExternalTaskHandler externalTaskHandler
```
  - topicSubscriptionManager
```
protected TopicSubscriptionManager topicSubscriptionManager
```
  - includeExtensionProperties
```
protected boolean includeExtensionProperties
```
- Constructor Detail
  - TopicSubscriptionBuilderImpl
```
public TopicSubscriptionBuilderImpl(String topicName,
                                    TopicSubscriptionManager topicSubscriptionManager)
```
- Method Detail
  - lockDuration
```
public TopicSubscriptionBuilder lockDuration(long lockDuration)
```
    Specified by:
    
    lockDuration in interface TopicSubscriptionBuilder
    
    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
```
public TopicSubscriptionBuilder handler(ExternalTaskHandler externalTaskHandler)
```
    Specified by:
    
    handler in interface TopicSubscriptionBuilder
    
    Parameters:
    
    externalTaskHandler - which will be executed for the external task
    
    Returns:
    
    the builder
  - variables
```
public TopicSubscriptionBuilder variables(String... variableNames)
```
    Specified by:
    
    variables in interface TopicSubscriptionBuilder
    
    Parameters:
    
    variableNames - of variables which are supposed to be retrieved
    
    Returns:
    
    the builder
  - localVariables
```
public TopicSubscriptionBuilder localVariables(boolean localVariables)
```
    Specified by:
    
    localVariables in interface TopicSubscriptionBuilder
    
    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
```
public TopicSubscriptionBuilder businessKey(String businessKey)
```
    Specified by:
    
    businessKey in interface TopicSubscriptionBuilder
    
    Parameters:
    
    businessKey - to filter for external tasks that are supposed to be fetched and locked
    
    Returns:
    
    the builder
  - processDefinitionId
```
public TopicSubscriptionBuilder processDefinitionId(String processDefinitionId)
```
    Specified by:
    
    processDefinitionId in interface TopicSubscriptionBuilder
    
    Parameters:
    
    processDefinitionId - to filter for external tasks that are supposed to be fetched and locked
    
    Returns:
    
    the builder
  - processDefinitionIdIn
```
public TopicSubscriptionBuilder processDefinitionIdIn(String... processDefinitionIds)
```
    Specified by:
    
    processDefinitionIdIn in interface TopicSubscriptionBuilder
    
    Parameters:
    
    processDefinitionIds - to filter for external tasks that are supposed to be fetched and locked
    
    Returns:
    
    the builder
  - processDefinitionKey
```
public TopicSubscriptionBuilder processDefinitionKey(String processDefinitionKey)
```
    Specified by:
    
    processDefinitionKey in interface TopicSubscriptionBuilder
    
    Parameters:
    
    processDefinitionKey - to filter for external tasks that are supposed to be fetched and locked
    
    Returns:
    
    the builder
  - processDefinitionKeyIn
```
public TopicSubscriptionBuilder processDefinitionKeyIn(String... processDefinitionKeys)
```
    Specified by:
    
    processDefinitionKeyIn in interface TopicSubscriptionBuilder
    
    Parameters:
    
    processDefinitionKeys - to filter for external tasks that are supposed to be fetched and locked
    
    Returns:
    
    the builder
  - processDefinitionVersionTag
```
public TopicSubscriptionBuilder processDefinitionVersionTag(String processDefinitionVersionTag)
```
    Specified by:
    
    processDefinitionVersionTag in interface TopicSubscriptionBuilder
    
    Returns:
    
    the builder
  - processVariablesEqualsIn
```
public TopicSubscriptionBuilder processVariablesEqualsIn(Map<String,Object> processVariables)
```
    Specified by:
    
    processVariablesEqualsIn in interface TopicSubscriptionBuilder
    
    Parameters:
    
    processVariables - of which the external tasks to be retrieved are related to
    
    Returns:
    
    the builder
  - processVariableEquals
```
public TopicSubscriptionBuilder processVariableEquals(String name,
                                                      Object value)
```
    Specified by:
    
    processVariableEquals in interface TopicSubscriptionBuilder
    
    Returns:
    
    the builder
  - withoutTenantId
```
public TopicSubscriptionBuilder withoutTenantId()
```
    Description copied from interface: TopicSubscriptionBuilder
    
    Filter for external tasks without tenant
    
    Specified by:
    
    withoutTenantId in interface TopicSubscriptionBuilder
    
    Returns:
    
    the builder
  - tenantIdIn
```
public TopicSubscriptionBuilder tenantIdIn(String... tenantIds)
```
    Specified by:
    
    tenantIdIn in interface TopicSubscriptionBuilder
    
    Parameters:
    
    tenantIds - to filter for external tasks that are supposed to be fetched and locked
    
    Returns:
    
    the builder
  - includeExtensionProperties
```
public TopicSubscriptionBuilder includeExtensionProperties(boolean includeExtensionProperties)
```
    Specified by:
    
    includeExtensionProperties in interface TopicSubscriptionBuilder
    
    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 is false.
    
    Returns:
    
    the builder
  - open
```
public TopicSubscription open()
```
    Description copied from interface: TopicSubscriptionBuilder
    
    Release the topic subscription for being executed asynchronously
    
    Specified by:
    
    open in interface TopicSubscriptionBuilder
    
    Returns:
    
    the builder
  - ensureNotNull
```
protected void ensureNotNull(Object tenantIds,
                             String parameterName)
```

Class TopicSubscriptionBuilderImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

topicName

lockDuration

variableNames

localVariables

businessKey

processDefinitionId

processDefinitionIds

processDefinitionKey

processDefinitionKeys

processDefinitionVersionTag

processVariables

withoutTenantId

tenantIds

externalTaskHandler

topicSubscriptionManager

includeExtensionProperties

Constructor Detail

TopicSubscriptionBuilderImpl

Method Detail

lockDuration

handler

variables

localVariables

businessKey

processDefinitionId

processDefinitionIdIn

processDefinitionKey

processDefinitionKeyIn

processDefinitionVersionTag

processVariablesEqualsIn

processVariableEquals

withoutTenantId

tenantIdIn

includeExtensionProperties

open

ensureNotNull