Annotation Interface ExternalTaskSubscription
Annotation to subscribe the External Task Client to a topic.
Heads-up:
- for attributes of type
String
, the string $null$ is reserved and used as default value - for attributes of type
Long
, the valueLong.MIN_VALUE
is reserved and used as default value
-
Nested Class Summary
-
Optional Element Summary
-
Field Summary
-
Field Details
-
STRING_NULL_VALUE
- See Also:
-
LONG_NULL_VALUE
static final long LONG_NULL_VALUE- See Also:
-
-
Element Details
-
autoOpen
boolean autoOpen- Returns:
- autoOpen
true
: the client immediately starts to fetch for External Tasksfalse
: topic subscription can be opened after application start by callingSpringTopicSubscription.open()
- Default:
- true
-
topicName
Alias forvalue()
.- Returns:
- topicName of the Service Task in the BPMN process model the client subscribes to
- Default:
- "$null$"
-
value
Alias fortopicName()
.- Returns:
- topicName of the Service Task in the BPMN process model the client subscribes to
- Default:
- "$null$"
-
lockDuration
long lockDuration- Returns:
- 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
- Default:
- -9223372036854775808L
-
variableNames
String[] variableNames- Returns:
- variableNames of variables which are supposed to be retrieved. All variables are retrieved by default.
- Default:
- {"$null$"}
-
localVariables
boolean localVariables- Returns:
- 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
- Default:
- false
-
businessKey
String businessKey- Returns:
- businessKey to filter for external tasks that are supposed to be fetched and locked
- Default:
- "$null$"
-
processDefinitionId
String processDefinitionId- Returns:
- processDefinitionId to filter for external tasks that are supposed to be fetched and locked
- Default:
- "$null$"
-
processDefinitionIdIn
String[] processDefinitionIdIn- Returns:
- processDefinitionIds to filter for external tasks that are supposed to be fetched and locked
- Default:
- {"$null$"}
-
processDefinitionKey
String processDefinitionKey- Returns:
- processDefinitionKey to filter for external tasks that are supposed to be fetched and locked
- Default:
- "$null$"
-
processDefinitionKeyIn
String[] processDefinitionKeyIn- Returns:
- processDefinitionKeyIn to filter for external tasks that are supposed to be fetched and locked
- Default:
- {"$null$"}
-
processDefinitionVersionTag
String processDefinitionVersionTag- Returns:
- processDefinitionVersionTag to filter for external tasks that are supposed to be fetched and locked
- Default:
- "$null$"
-
processVariables
ExternalTaskSubscription.ProcessVariable[] processVariables- Returns:
- processVariables of which the external tasks to be retrieved are related to. Each
value is instance of
ExternalTaskSubscription.ProcessVariable
- Default:
- {@org.camunda.bpm.client.spring.annotation.ExternalTaskSubscription.ProcessVariable(name="$null$", value="$null$")}
-
withoutTenantId
boolean withoutTenantId- Returns:
- Filter for external tasks without tenant
- Default:
- false
-
tenantIdIn
String[] tenantIdIn- Returns:
- tenantIds to filter for external tasks that are supposed to be fetched and locked
- Default:
- {"$null$"}
-
includeExtensionProperties
boolean includeExtensionProperties- Returns:
- 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
.
- Default:
- false
-