org.apache.camel.processor.idempotent

Class IdempotentConsumer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.processor.idempotent.IdempotentConsumer

All Implemented Interfaces:

AsyncProcessor, CamelContextAware, Navigate<Processor>, Processor, Service, ShutdownableService, HasId, IdAware, StatefulService, SuspendableService

public class IdempotentConsumer
extends ServiceSupport
implements CamelContextAware, AsyncProcessor, Navigate<Processor>, IdAware

An implementation of the Idempotent Consumer pattern.

This implementation supports idempotent repositories implemented as

• IdempotentRepository
• ExchangeIdempotentRepository

See Also:

IdempotentRepository, ExchangeIdempotentRepository

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
IdempotentConsumer(Expression messageIdExpression, IdempotentRepository<String> idempotentRepository, boolean eager, boolean completionEager, boolean skipDuplicate, boolean removeOnFailure, Processor processor)

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the idempotent repository
protected void	doShutdown() Implementations override this method to perform customized shutdown.
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
CamelContext	getCamelContext() Get the CamelContext
long	getDuplicateMessageCount()
String	getId() Returns the id
IdempotentRepository<String>	getIdempotentRepository()
Expression	getMessageIdExpression()
Processor	getProcessor()
boolean	hasNext() Are there more outputs? Important only invoke this once, as this method do not carry state, and is not intended to be used in a while loop, but used by a if statement instead.
boolean	isCompletionEager()
boolean	isEager()
boolean	isRemoveOnFailure()
boolean	isSkipDuplicate()
List<Processor>	next() Next group of outputs Important only invoke this once, as this method do not carry state, and is not intended to be used in a while loop, but used by a if statement instead.
protected void	onDuplicateMessage(Exchange exchange, String messageId) A strategy method to allow derived classes to overload the behaviour of processing a duplicate message
void	process(Exchange exchange) Processes the message exchange
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
void	resetDuplicateMessageCount() Resets the duplicate message counter to 0L.
void	setCamelContext(CamelContext camelContext) Injects the CamelContext
void	setId(String id) Sets the id
String	toString()

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Constructor Detail

IdempotentConsumer

public IdempotentConsumer(Expression messageIdExpression,
                          IdempotentRepository<String> idempotentRepository,
                          boolean eager,
                          boolean completionEager,
                          boolean skipDuplicate,
                          boolean removeOnFailure,
                          Processor processor)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getCamelContext

public CamelContext getCamelContext()

Description copied from interface: CamelContextAware

Get the CamelContext

Specified by:

getCamelContext in interface CamelContextAware

Returns:

camelContext the Camel context

setCamelContext

public void setCamelContext(CamelContext camelContext)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

camelContext - the Camel context

getId

public String getId()

Description copied from interface: HasId

Returns the id

Specified by:

getId in interface HasId

Returns:

the id

setId

public void setId(String id)

Description copied from interface: IdAware

Sets the id

Specified by:

setId in interface IdAware

Parameters:

id - the id

process

public void process(Exchange exchange)
             throws Exception

Description copied from interface: Processor

Processes the message exchange

Specified by:

process in interface Processor

Parameters:

exchange - the message exchange

Throws:

Exception - if an internal processing error has occurred.

process

public boolean process(Exchange exchange,
                       AsyncCallback callback)

Description copied from interface: AsyncProcessor

Processes the message exchange. Similar to Processor.process(org.apache.camel.Exchange), but the caller supports having the exchange asynchronously processed.

If there was a failure processing then the caused Exception would be set on the Exchange.

Specified by:

process in interface AsyncProcessor

Parameters:

exchange - the message exchange

callback - the AsyncCallback will be invoked when the processing of the exchange is completed. If the exchange is completed synchronously, then the callback is also invoked synchronously. The callback should therefore be careful of starting recursive loop.

Returns:

(doneSync) true to continue execute synchronously, false to continue being executed asynchronously

next

public List<Processor> next()

Description copied from interface: Navigate

Next group of outputs

Important only invoke this once, as this method do not carry state, and is not intended to be used in a while loop, but used by a if statement instead.

Specified by:

next in interface Navigate<Processor>

Returns:

next group or null if no more outputs

hasNext

public boolean hasNext()

Description copied from interface: Navigate

Are there more outputs?

Important only invoke this once, as this method do not carry state, and is not intended to be used in a while loop, but used by a if statement instead.

Specified by:

hasNext in interface Navigate<Processor>

Returns:

true if more outputs

getMessageIdExpression

public Expression getMessageIdExpression()

getIdempotentRepository

public IdempotentRepository<String> getIdempotentRepository()

getProcessor

public Processor getProcessor()

getDuplicateMessageCount

public long getDuplicateMessageCount()

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Specified by:

doStart in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Specified by:

doStop in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStart()

doShutdown

protected void doShutdown()
                   throws Exception

Description copied from class: ServiceSupport

Implementations override this method to perform customized shutdown.

Overrides:

doShutdown in class ServiceSupport

Throws:

Exception

isEager

public boolean isEager()

isCompletionEager

public boolean isCompletionEager()

isSkipDuplicate

public boolean isSkipDuplicate()

isRemoveOnFailure

public boolean isRemoveOnFailure()

resetDuplicateMessageCount

public void resetDuplicateMessageCount()

Resets the duplicate message counter to 0L.

clear

public void clear()

Clear the idempotent repository

onDuplicateMessage

protected void onDuplicateMessage(Exchange exchange,
                                  String messageId)

A strategy method to allow derived classes to overload the behaviour of processing a duplicate message

Parameters:

exchange - the exchange

messageId - the message ID of this exchange