org.apache.camel.spi

Interface ExchangeIdempotentRepository<E>

All Superinterfaces:

IdempotentRepository<E>, Service

public interface ExchangeIdempotentRepository<E>
extends IdempotentRepository<E>

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.

This repository supports the operations to pass in the current exchange, which can be needed by some implementations such as the JPA idempotent consumer.

Important: Implementations of this should use String as the generic type as that is what is required by Camel to allow using the idempotent repository with the Idempotent Consumer EIP and also as file consumer read-lock. It was a mistake to make IdempotentRepository parameterized, as it should have been a pre-configured to use a String type.

Version:

Method Summary

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

Methods inherited from interface org.apache.camel.spi.IdempotentRepository

add, clear, confirm, contains, remove

Methods inherited from interface org.apache.camel.Service

start, stop

Method Detail

add

boolean add(Exchange exchange,
            E 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(Exchange exchange,
                 E 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(Exchange exchange,
               E 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(Exchange exchange,
                E 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