Package org.apache.camel.spi

Interface IdempotentRepository

All Superinterfaces:
AutoCloseable, Service
public interface IdempotentRepository extends Service
Access to a repository of Message IDs to implement the Idempotent Consumer pattern.

The add and contains methods is operating according to the Set contract.

The repository supports eager (default) and non-eager mode.

  • eager: calls add and confirm if complete, or remove if failed
  • non-eager: calls contains and add if complete, or remove if failed
Notice the remove callback, can be configured to be disabled.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(String key)
    Adds the key to the repository.
    default boolean
    add(Exchange exchange, String key)
    Adds the key to the repository.
    void
    clear()
    Clear the repository.
    boolean
    confirm(String key)
    Confirms the key, after the exchange has been processed successfully.
    default boolean
    confirm(Exchange exchange, String key)
    Confirms the key, after the exchange has been processed successfully.
    boolean
    contains(String key)
    Returns true if this repository contains the specified element.
    default boolean
    contains(Exchange exchange, String key)
    Returns true if this repository contains the specified element.
    boolean
    remove(String key)
    Removes the key from the repository.
    default boolean
    remove(Exchange exchange, String key)
    Removes the key from the repository.

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

  • Method Details

    • add

      boolean add(String key)
      Adds the key to the repository.

      Important: Read the class javadoc about eager vs non-eager mode.

      Parameters:
      key - the key of the message for duplicate test
      Returns:
      true if this repository did not already contain the specified element

    • contains

      boolean contains(String key)
      Returns true if this repository contains the specified element.

      Important: Read the class javadoc about eager vs non-eager mode.

      Parameters:
      key - the key of the message
      Returns:
      true if this repository contains the specified element

    • remove

      boolean remove(String key)
      Removes the key from the repository.

      Is usually invoked if the exchange failed.

      Important: Read the class javadoc about eager vs non-eager mode.

      Parameters:
      key - the key of the message for duplicate test
      Returns:
      true if the key was removed

    • confirm

      boolean confirm(String key)
      Confirms the key, after the exchange has been processed successfully.

      Important: Read the class javadoc about eager vs non-eager mode.

      Parameters:
      key - the key of the message for duplicate test
      Returns:
      true if the key was confirmed

    • clear

      void clear()
      Clear the repository.

      Important: Read the class javadoc about eager vs non-eager mode.

    • add

      default boolean add(Exchange exchange, String key)
      Adds the key to the repository.

      Important: Read the class javadoc about eager vs non-eager mode.

      Parameters:
      key - the key of the message for duplicate test
      Returns:
      true if this repository did not already contain the specified element

    • contains

      default boolean contains(Exchange exchange, String key)
      Returns true if this repository contains the specified element.

      Important: Read the class javadoc about eager vs non-eager mode.

      Parameters:
      key - the key of the message
      Returns:
      true if this repository contains the specified element

    • remove

      default boolean remove(Exchange exchange, String key)
      Removes the key from the repository.

      Is usually invoked if the exchange failed.

      Important: Read the class javadoc about eager vs non-eager mode.

      Parameters:
      key - the key of the message for duplicate test
      Returns:
      true if the key was removed

    • confirm

      default boolean confirm(Exchange exchange, String key)
      Confirms the key, after the exchange has been processed successfully.

      Important: Read the class javadoc about eager vs non-eager mode.

      Parameters:
      key - the key of the message for duplicate test
      Returns:
      true if the key was confirmed