Package org.camunda.bpm.client.spring.annotation

Annotation Type EnableExternalTaskClient

  • @Documented
@Target(TYPE)
@Retention(RUNTIME)
@Import(PostProcessorConfiguration.class)
public @interface EnableExternalTaskClient

    Annotation to bootstrap the External Task Client

    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
    • for attributes of type Integer, the value Integer.MIN_VALUE is reserved and used as default value

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      long asyncResponseTimeout
      Asynchronous response (long polling) is enabled if a timeout is given.
      java.lang.String baseUrl
      Base url of the Camunda Runtime Platform REST API.
      java.lang.String dateFormat
      Specifies the date format to de-/serialize date variables.
      java.lang.String defaultSerializationFormat
      Specifies the serialization format that is used to serialize objects when no specific format is requested.
      boolean disableAutoFetching
      Disables immediate fetching for external tasks after bootstrapping the client.
      boolean disableBackoffStrategy
      Disables the client-side backoff strategy.
      long lockDuration  
      int maxTasks
      Specifies the maximum amount of tasks that can be fetched within one request.
      boolean usePriority
      Specifies whether tasks should be fetched based on their priority or arbitrarily.
      java.lang.String value
      Base url of the Camunda Runtime Platform REST API.
      java.lang.String workerId
      A custom worker id the Workflow Engine is aware of.

    • Field Detail

      • STRING_NULL_VALUE

        static final java.lang.String STRING_NULL_VALUE

      • LONG_NULL_VALUE

        static final long LONG_NULL_VALUE

      • INT_NULL_VALUE

        static final int INT_NULL_VALUE

    • Element Detail

      • value

        @AliasFor("baseUrl")
java.lang.String value
        Base url of the Camunda Runtime Platform REST API. This information is mandatory. Alias of baseUrl().
        Returns:
        baseUrl of the Camunda Runtime Platform REST API
        Default:
        "$null$"

      • baseUrl

        @AliasFor("value")
java.lang.String baseUrl
        Base url of the Camunda Runtime Platform REST API. This information is mandatory. Alias of value().
        Returns:
        baseUrl of the Camunda Runtime Platform REST API
        Default:
        "$null$"

      • maxTasks

        int maxTasks
        Specifies the maximum amount of tasks that can be fetched within one request. This information is optional. Default is 10.
        Returns:
        maxTasks which are supposed to be fetched within one request
        Default:
        -2147483648

      • workerId

        java.lang.String workerId
        A custom worker id the Workflow Engine is aware of. This information is optional. Note: make sure to choose a unique worker id

        If not given or null, a worker id is generated automatically which consists of the hostname as well as a random and unique 128 bit string (UUID).

        Returns:
        workerId the Workflow Engine is aware of
        Default:
        "$null$"

      • usePriority

        boolean usePriority
        Specifies whether tasks should be fetched based on their priority or arbitrarily. This information is optional. Default is true.
        Returns:
        usePriority when fetching and locking tasks
        Default:
        true

      • asyncResponseTimeout

        long asyncResponseTimeout
        Asynchronous response (long polling) is enabled if a timeout is given. Specifies the maximum waiting time for the response of fetched and locked external tasks. The response is performed immediately, if external tasks are available in the moment of the request. This information is optional. Unless a timeout is given, fetch and lock responses are synchronous.
        Returns:
        asyncResponseTimeout of fetched and locked external tasks in milliseconds
        Default:
        -9223372036854775808L

      • disableAutoFetching

        boolean disableAutoFetching
        Disables immediate fetching for external tasks after bootstrapping the client. To start fetching ExternalTaskClient.start() must be called.
        Returns:
        disableAutoFetching when after bootstrapping the client
        Default:
        false

      • disableBackoffStrategy

        boolean disableBackoffStrategy
        Disables the client-side backoff strategy. When set to true, a BackoffStrategy bean is ignored.

        NOTE: Please bear in mind that disabling the client-side backoff can lead to heavy load situations on engine side. To avoid this, please specify an appropriate asyncResponseTimeout().

        Returns:
        disableBackoffStrategy
        Default:
        false

      • lockDuration

        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)
        • is overridden by the lock duration configured on a topic subscription
        Default:
        -9223372036854775808L

      • dateFormat

        java.lang.String dateFormat
        Specifies the date format to de-/serialize date variables. The option defaults to yyyy-MM-dd'T'HH:mm:ss.SSSZ
        Returns:
        dateFormat date format to be used
        Default:
        "$null$"

      • defaultSerializationFormat

        java.lang.String defaultSerializationFormat
        Specifies the serialization format that is used to serialize objects when no specific format is requested. This option defaults to application/json.
        Returns:
        defaultSerializationFormat serialization format to be used
        Default:
        "$null$"