org.apache.camel.spi

Interface IdempotentRepository<E>

All Superinterfaces:

Service

All Known Subinterfaces:

ExchangeIdempotentRepository<E>

All Known Implementing Classes:

FileIdempotentRepository, MemoryIdempotentRepository

public interface IdempotentRepository<E>
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.

Implementations for the idempotent consumer EIP should favor using ExchangeIdempotentRepository instead.

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:

See Also:

ExchangeIdempotentRepository

Method Summary

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

Methods inherited from interface org.apache.camel.Service

start, stop

Method Detail

add

boolean add(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(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(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(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

clear

void clear()

Clear the repository.

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