Package org.apache.camel

Annotation Interface RecipientList

@Retention(RUNTIME) @Documented @Target({FIELD,METHOD,CONSTRUCTOR}) public @interface RecipientList
Indicates that this method is to be used as a Dynamic Recipient List routing the incoming message to one or more endpoints. When a message Exchange is received from an Endpoint then the Bean Integration mechanism is used to map the incoming Message to the method parameters. The return value of the method is then converted to either a Collection or array of objects where each element is converted to an Endpoint or a String, or if it is not a collection/array then it is converted to an Endpoint or String. Then for each endpoint or URI the message is forwarded a separate copy.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    aggregationStrategy
    Sets a reference to the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList.
    int
    cacheSize
    Sets the maximum size used by the ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused.
    String
    delimiter
    Delimiter used if the Expression returned multiple endpoints.
    String
    executorService
    Refers to a custom Thread Pool to be used for parallel processing.
    boolean
    ignoreInvalidEndpoints
    Whether to ignore the invalidate endpoint exception when try to create a producer with that endpoint
    String
    onPrepare
    Uses the Processor when preparing the Exchange to be sent.
    boolean
    parallelAggregate
    If enabled then the aggregate method on AggregationStrategy can be called concurrently.
    boolean
    parallelProcessing
    If enabled then sending messages to the recipients occurs concurrently.
    boolean
    shareUnitOfWork
    Shares the UnitOfWork with the parent and each of the sub messages.
    boolean
    stopOnException
    Will now stop further processing if an exception or failure occurred during processing of an Exchange and the caused exception will be thrown.
    boolean
    streaming
    If enabled then Camel will process replies out-of-order, eg in the order they come back.
    long
    timeout
    Sets a total timeout specified in millis, when using parallel processing.

  • Element Details

    • delimiter

      String delimiter
      Delimiter used if the Expression returned multiple endpoints. Can be turned off using the value false.

      The default value is ,

      Default:
      ","

    • parallelProcessing

      boolean parallelProcessing
      If enabled then sending messages to the recipients occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only the sending and processing the replies from the recipients which happens concurrently.
      Default:
      false

    • parallelAggregate

      boolean parallelAggregate
      If enabled then the aggregate method on AggregationStrategy can be called concurrently. Notice that this would require the implementation of AggregationStrategy to be implemented as thread-safe. By default this is false meaning that Camel synchronizes the call to the aggregate method. Though in some use-cases this can be used to archive higher performance when the AggregationStrategy is implemented as thread-safe.
      Default:
      false

    • stopOnException

      boolean stopOnException
      Will now stop further processing if an exception or failure occurred during processing of an Exchange and the caused exception will be thrown.

      Will also stop if processing the exchange failed (has a fault message) or an exception was thrown and handled by the error handler (such as using onException). In all situations the recipient list will stop further processing. This is the same behavior as in pipeline, which is used by the routing engine.

      The default behavior is to not stop but continue processing till the end

      Default:
      false

    • streaming

      boolean streaming
      If enabled then Camel will process replies out-of-order, eg in the order they come back. If disabled, Camel will process replies in the same order as defined by the recipient list.
      Default:
      false

    • ignoreInvalidEndpoints

      boolean ignoreInvalidEndpoints
      Whether to ignore the invalidate endpoint exception when try to create a producer with that endpoint
      Default:
      false

    • aggregationStrategy

      String aggregationStrategy
      Sets a reference to the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy
      Default:
      ""

    • executorService

      String executorService
      Refers to a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatically implied, and you do not have to enable that option as well.
      Default:
      ""

    • timeout

      long timeout
      Sets a total timeout specified in millis, when using parallel processing. If the Recipient List hasn't been able to send and process all replies within the given timeframe, then the timeout triggers and the Recipient List breaks out and continues. Notice if you provide a TimeoutAwareAggregationStrategy then the timeout method is invoked before breaking out. If the timeout is reached with running tasks still remaining, certain tasks for which it is difficult for Camel to shut down in a graceful manner may continue to run. So use this option with a bit of care.
      Default:
      0L

    • cacheSize

      int cacheSize
      Sets the maximum size used by the ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.
      Default:
      0

    • onPrepare

      String onPrepare
      Uses the Processor when preparing the Exchange to be sent. This can be used to deep-clone messages that should be sent, or any custom logic needed before the exchange is sent.
      Default:
      ""

    • shareUnitOfWork

      boolean shareUnitOfWork
      Shares the UnitOfWork with the parent and each of the sub messages. Recipient List will by default not share unit of work between the parent exchange and each recipient exchange. This means each sub exchange has its own individual unit of work.
      Default:
      false