Interface ExternalTaskClient

All Known Implementing Classes:
ExternalTaskClientImpl

public interface ExternalTaskClient

Camunda external task client

Author:
Tassilo Weidner
  • Method Summary

    Modifier and Type
    Method
    Description
    Creates a fluent builder to configure the Camunda client
    boolean
     
    void
    Starts continuous fetching and locking of tasks
    void
    Stops continuous fetching and locking of tasks
    subscribe(String topicName)
    Creates a fluent builder to create and configure a topic subscription
  • Method Details

    • create

      static ExternalTaskClientBuilder create()
      Creates a fluent builder to configure the Camunda client
      Returns:
      builder to apply configurations on
    • subscribe

      TopicSubscriptionBuilder subscribe(String topicName)
      Creates a fluent builder to create and configure a topic subscription
      Parameters:
      topicName - the client subscribes to
      Returns:
      builder to apply configurations on
    • stop

      void stop()
      Stops continuous fetching and locking of tasks
    • start

      void start()
      Starts continuous fetching and locking of tasks
    • isActive

      boolean isActive()
      Returns:
      • true if the client is actively fetching for tasks
      • false if the client is not actively fetching for tasks