Package org.apache.camel.processor.aggregate

Interface AggregateController

All Known Implementing Classes:
DefaultAggregateController
public interface AggregateController
A controller which allows controlling a AggregateProcessor from an external source, such as Java API or JMX. This can be used to force completion of aggregated groups, and more.

  • Method Details

    • onStart

      void onStart(AggregateProcessor processor)
      Callback when the aggregate processor is started.
      Parameters:
      processor - the aggregate processor

    • onStop

      void onStop(AggregateProcessor processor)
      Callback when the aggregate processor is stopped.
      Parameters:
      processor - the aggregate processor

    • forceCompletionOfGroup

      int forceCompletionOfGroup(String key)
      To force completing a specific group by its key.
      Parameters:
      key - the key
      Returns:
      1 if the group was forced completed, 0 if the group does not exists

    • forceCompletionOfAllGroups

      int forceCompletionOfAllGroups()
      To force complete of all groups
      Returns:
      number of groups that was forced completed

    • forceDiscardingOfGroup

      int forceDiscardingOfGroup(String key)
      To force discarding a specific group by its key.
      Parameters:
      key - the key
      Returns:
      1 if the group was forced discarded, 0 if the group does not exists

    • forceDiscardingOfAllGroups

      int forceDiscardingOfAllGroups()
      To force discardingof all groups
      Returns:
      number of groups that was forced discarded