org.camunda.bpm.client.spring.annotation

Annotation Type ExternalTaskSubscription

@Documented
 @Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
public @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 value Long.MIN_VALUE is reserved and used as default value

Field Summary

Fields

Modifier and Type	Fields and Description
static long	LONG_NULL_VALUE
static String	STRING_NULL_VALUE

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoOpen
String	businessKey
boolean	includeExtensionProperties
boolean	localVariables
long	lockDuration
String	processDefinitionId
String[]	processDefinitionIdIn
String	processDefinitionKey
String[]	processDefinitionKeyIn
String	processDefinitionVersionTag
ExternalTaskSubscription.ProcessVariable[]	processVariables
String[]	tenantIdIn
String	topicName Alias for value().
String	value Alias for topicName().
String[]	variableNames
boolean	withoutTenantId

Field Detail

STRING_NULL_VALUE

public static final String STRING_NULL_VALUE

LONG_NULL_VALUE

public static final long LONG_NULL_VALUE

Element Detail

autoOpen

public abstract boolean autoOpen

Returns:

autoOpen

• true: the client immediately starts to fetch for External Tasks
• false: topic subscription can be opened after application start by calling SpringTopicSubscription.open()

Default:

true

topicName

@AliasFor(value="value")
public abstract String topicName

Alias for value().

Returns:

topicName of the Service Task in the BPMN process model the client subscribes to

Default:

"$null$"

value

@AliasFor(value="topicName")
public abstract String value

Alias for topicName().

Returns:

topicName of the Service Task in the BPMN process model the client subscribes to

Default:

"$null$"

lockDuration

public abstract 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

public abstract String[] variableNames

Returns:

variableNames of variables which are supposed to be retrieved. All variables are retrieved by default.

Default:

"$null$"

localVariables

public abstract 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

public abstract String businessKey

Returns:

businessKey to filter for external tasks that are supposed to be fetched and locked

Default:

"$null$"

processDefinitionId

public abstract String processDefinitionId

Returns:

processDefinitionId to filter for external tasks that are supposed to be fetched and locked

Default:

"$null$"

processDefinitionIdIn

public abstract String[] processDefinitionIdIn

Returns:

processDefinitionIds to filter for external tasks that are supposed to be fetched and locked

Default:

"$null$"

processDefinitionKey

public abstract String processDefinitionKey

Returns:

processDefinitionKey to filter for external tasks that are supposed to be fetched and locked

Default:

"$null$"

processDefinitionKeyIn

public abstract String[] processDefinitionKeyIn

Returns:

processDefinitionKeyIn to filter for external tasks that are supposed to be fetched and locked

Default:

"$null$"

processDefinitionVersionTag

public abstract String processDefinitionVersionTag

Returns:

processDefinitionVersionTag to filter for external tasks that are supposed to be fetched and locked

Default:

"$null$"

processVariables

public abstract 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

public abstract boolean withoutTenantId

Returns:

Filter for external tasks without tenant

Default:

false

tenantIdIn

public abstract String[] tenantIdIn

Returns:

tenantIds to filter for external tasks that are supposed to be fetched and locked

Default:

"$null$"

includeExtensionProperties

public abstract 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 is false.

Default:

false