Package org.camunda.bpm.client.topic

Interface TopicSubscription

All Known Subinterfaces:
SpringTopicSubscription
All Known Implementing Classes:
PropertiesAwareSpringTopicSubscription, SpringTopicSubscriptionImpl, TopicSubscriptionImpl
public interface TopicSubscription

Subscription to a topic

Author:
Tassilo Weidner

  • Method Details

    • close

      void close()
      The client has been unsubscribed from the topic. NB! It can happen, that the changes are not applied immediately, in case the client is currently iterating over the bunch of fetched and locked external tasks. The changes will have affect starting from the next bunch only.

    • getTopicName

      String getTopicName()
      Returns:
      the topic name of the subscription

    • getLockDuration

      Long getLockDuration()
      Returns:
      • the duration of the lock applied to the topic
      • if null, the client or the default lock duration is applied

    • getExternalTaskHandler

      ExternalTaskHandler getExternalTaskHandler()
      Returns:
      the external task handler of the topic

    • getVariableNames

      List<String> getVariableNames()
      Returns:
      a list of variable names which are supposed to be retrieved

    • isLocalVariables

      boolean isLocalVariables()
      Returns:
      whether or not variables from greater scopes than the external task are 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.

    • getBusinessKey

      String getBusinessKey()
      Returns:
      the business key associated with the external tasks which are supposed to be fetched and locked

    • getProcessDefinitionId

      String getProcessDefinitionId()
      Returns:
      the process definition id associated with the external tasks which are supposed to be fetched and locked

    • getProcessDefinitionIdIn

      List<String> getProcessDefinitionIdIn()
      Returns:
      the process definition ids associated with the external tasks which are supposed to be fetched and locked

    • getProcessDefinitionKey

      String getProcessDefinitionKey()
      Returns:
      the process definition key associated with the external tasks which are supposed to be fetched and locked

    • getProcessDefinitionKeyIn

      List<String> getProcessDefinitionKeyIn()
      Returns:
      the process definition keys associated with the external tasks which are supposed to be fetched and locked

    • getProcessDefinitionVersionTag

      String getProcessDefinitionVersionTag()
      Returns:
      the process definition version tag associated with the external task which are supposed to be fetched and locked

    • getProcessVariables

      Map<String,Object> getProcessVariables()
      Returns:
      the process variables associated with the external task which are supposed to be fetched and locked

    • isWithoutTenantId

      boolean isWithoutTenantId()
      Returns:
      the tenant id presence for the external tasks which are supposed to be fetched and locked

    • getTenantIdIn

      List<String> getTenantIdIn()
      Returns:
      the tenant ids associated with the external tasks which are supposed to be fetched and locked

    • isIncludeExtensionProperties

      boolean isIncludeExtensionProperties()
      Returns:
      whether or not custom extension properties defined in the external task activity are included. The default is false, which means that no extension properties will be available within the external-task-client. true means that all defined extension properties are fetched and provided.