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()
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 |
getBusinessKey, getExternalTaskHandler, getLockDuration, getProcessDefinitionId, getProcessDefinitionIdIn, getProcessDefinitionKey, getProcessDefinitionKeyIn, getProcessDefinitionVersionTag, getProcessVariables, getTenantIdIn, getTopicName, getVariableNames, isIncludeExtensionProperties, isLocalVariables, isWithoutTenantId
boolean isAutoOpen()
true
when the topic subscription is automatically released for execution
false
when you need to call open()
to release the topic for executionvoid open()
isAutoOpen()
is
false
ExternalTaskClientException
- null
or an empty string
NotInitializedException
- if called before fully initializedboolean isOpen()
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 executionvoid close()
TopicSubscription.close()
.close
in interface TopicSubscription
NotInitializedException
- if called before fully initializedNotOpenedException
- if called before subscription has been openedTopicSubscription.close()
Copyright © 2022. All rights reserved.