org.camunda.bpm.client.spring

Interface SpringTopicSubscription

All Superinterfaces:

TopicSubscription

All Known Implementing Classes:

PropertiesAwareSpringTopicSubscription, SpringTopicSubscriptionImpl

public interface SpringTopicSubscription
extends TopicSubscription

Represents a topic subscription of the External Task Client.

Existence of this bean means that the subscription has been created but might have not been fully initialized or released to the External Task Client. The SubscriptionInitializedEvent is emitted as soon as the subscription has been fully initialized.

You can check if the subscription has been released to the External Task Client with isOpen()

Method Summary

Modifier and Type	Method and Description
void	close() Delegates to TopicSubscription.close().
boolean	isAutoOpen()
boolean	isOpen()
void	open() Releases the topic subscription for asynchronous execution when isAutoOpen() is false

Methods inherited from interface org.camunda.bpm.client.topic.TopicSubscription

getBusinessKey, getExternalTaskHandler, getLockDuration, getProcessDefinitionId, getProcessDefinitionIdIn, getProcessDefinitionKey, getProcessDefinitionKeyIn, getProcessDefinitionVersionTag, getProcessVariables, getTenantIdIn, getTopicName, getVariableNames, isIncludeExtensionProperties, isLocalVariables, isWithoutTenantId

Method Detail

isAutoOpen

boolean isAutoOpen()

Returns:

• true when the topic subscription is automatically released for execution
• false when you need to call open() to release the topic for execution

open

void open()

Releases the topic subscription for asynchronous execution when isAutoOpen() is false

Throws:

ExternalTaskClientException -

• if topic name is null or an empty string
• if lock duration is not greater than zero
• if external task handler is null
• if topic name has already been subscribed

NotInitializedException - if called before fully initialized

isOpen

boolean isOpen()

Returns:

• true when the topic subscription is already released for execution
• false when the topic subscription is not already released for execution; call open() to release the topic for execution

close

void close()

Delegates to TopicSubscription.close().

Specified by:

close in interface TopicSubscription

Throws:

NotInitializedException - if called before fully initialized

NotOpenedException - if called before subscription has been opened

See Also:

TopicSubscription.close()