Package org.apache.camel.processor.aggregate

Class GroupedExchangeAggregationStrategy

java.lang.Object
org.apache.camel.processor.aggregate.AbstractListAggregationStrategy<org.apache.camel.Exchange>
org.apache.camel.processor.aggregate.GroupedExchangeAggregationStrategy
All Implemented Interfaces:
org.apache.camel.AggregationStrategy
@Metadata(label="bean", description="Aggregate all Exchanges into a single combined Exchange holding all the aggregated exchanges in a List of Exchange as the message body. This aggregation strategy can be used in combination with Splitter to batch messages.", annotations="interfaceName=org.apache.camel.AggregationStrategy") @Configurer(metadataOnly=true) public class GroupedExchangeAggregationStrategy extends AbstractListAggregationStrategy<org.apache.camel.Exchange>
Aggregate all exchanges into a single combined Exchange holding all the aggregated exchanges in a List of Exchange as the message body.

Important: This strategy is not to be used with the Content Enricher EIP which is enrich or pollEnrich.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GroupedExchangeAggregationStrategy()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.camel.Exchange
    aggregate(org.apache.camel.Exchange oldExchange, org.apache.camel.Exchange newExchange)
    This method will aggregate the old and new exchange and return the result.
    org.apache.camel.Exchange
    getValue(org.apache.camel.Exchange exchange)
    This method is implemented by the sub-class and is called to retrieve an instance of the value that will be aggregated and forwarded to the receiving end point.

    Methods inherited from class org.apache.camel.processor.aggregate.AbstractListAggregationStrategy

    isStoreAsBodyOnCompletion, onCompletion

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.apache.camel.AggregationStrategy

    aggregate, canPreComplete, onCompletion, onOptimisticLockFailure, preComplete, timeout

  • Constructor Details

    • GroupedExchangeAggregationStrategy

      public GroupedExchangeAggregationStrategy()

  • Method Details

    • aggregate

      public org.apache.camel.Exchange aggregate(org.apache.camel.Exchange oldExchange, org.apache.camel.Exchange newExchange)
      Description copied from class: AbstractListAggregationStrategy
      This method will aggregate the old and new exchange and return the result.
      Specified by:
      aggregate in interface org.apache.camel.AggregationStrategy
      Overrides:
      aggregate in class AbstractListAggregationStrategy<org.apache.camel.Exchange>
      Parameters:
      oldExchange - The oldest exchange, can be null
      newExchange - The newest exchange, can be null
      Returns:
      a composite exchange of the old and/or new exchanges

    • getValue

      public org.apache.camel.Exchange getValue(org.apache.camel.Exchange exchange)
      Description copied from class: AbstractListAggregationStrategy
      This method is implemented by the sub-class and is called to retrieve an instance of the value that will be aggregated and forwarded to the receiving end point.

      If null is returned, then the value is not added to the List.

      Specified by:
      getValue in class AbstractListAggregationStrategy<org.apache.camel.Exchange>
      Parameters:
      exchange - The exchange that is used to retrieve the value from
      Returns:
      An instance of V that is the associated value of the passed exchange