org.apache.camel.model

Class IdempotentConsumerDefinition

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<Type>

org.apache.camel.model.ProcessorDefinition<ExpressionNode>

org.apache.camel.model.ExpressionNode

org.apache.camel.model.IdempotentConsumerDefinition

All Implemented Interfaces:

Block, OtherAttributesAware, NamedNode

@Metadata(label="eip,routing")
public class IdempotentConsumerDefinition
extends ExpressionNode

Filters out duplicate messages

Field Summary

Fields inherited from class org.apache.camel.model.ProcessorDefinition

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
IdempotentConsumerDefinition()
IdempotentConsumerDefinition(Expression messageIdExpression, IdempotentRepository<?> idempotentRepository)

Method Summary

Modifier and Type	Method and Description
IdempotentConsumerDefinition	completionEager(boolean completionEager) Sets whether to complete the idempotent consumer eager or when the exchange is done.
Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
IdempotentConsumerDefinition	eager(boolean eager) Sets whether to eagerly add the key to the idempotent repository or wait until the exchange is complete.
Boolean	getCompletionEager()
Boolean	getEager()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
IdempotentRepository<?>	getMessageIdRepository()
String	getMessageIdRepositoryRef()
Boolean	getRemoveOnFailure()
Boolean	getSkipDuplicate()
IdempotentConsumerDefinition	messageIdRepository(IdempotentRepository<?> idempotentRepository) Sets the message id repository for the idempotent consumer
IdempotentConsumerDefinition	messageIdRepositoryRef(String messageIdRepositoryRef) Sets the reference name of the message id repository
IdempotentConsumerDefinition	removeOnFailure(boolean removeOnFailure) Sets whether to remove or keep the key on failure.
protected <T> IdempotentRepository<T>	resolveMessageIdRepository(RouteContext routeContext) Strategy method to resolve the IdempotentRepository to use
void	setCompletionEager(Boolean completionEager)
void	setEager(Boolean eager)
void	setExpression(ExpressionDefinition expression) Expression used to calculate the correlation key to use for duplicate check.
void	setMessageIdRepository(IdempotentRepository<?> idempotentRepository)
void	setMessageIdRepositoryRef(String messageIdRepositoryRef)
void	setRemoveOnFailure(Boolean removeOnFailure)
void	setSkipDuplicate(Boolean skipDuplicate)
IdempotentConsumerDefinition	skipDuplicate(boolean skipDuplicate) Sets whether to skip duplicates or not.
String	toString()

Methods inherited from class org.apache.camel.model.ExpressionNode

configureChild, createFilterProcessor, createPredicate, getExpression, getOutputs, isOutputSupported, preCreateProcessor, setOutputs

Methods inherited from class org.apache.camel.model.ProcessorDefinition

addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, attribute, bean, bean, bean, bean, bean, bean, bean, bean, beanRef, beanRef, beanRef, beanRef, beanRef, choice, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createOutputsProcessorImpl, createProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endDoTry, endHystrix, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrichRef, enrichRef, enrichRef, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, hystrix, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pipeline, pipeline, pipeline, pipeline, placeholder, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, pollEnrichRef, pollEnrichWith, pollEnrichWith, pollEnrichWith, process, process, process, processRef, recipientList, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setBody, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, startupOrder, stop, threads, threads, threads, threads, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapChannel, wrapInErrorHandler, wrapProcessor

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, description, getCustomId, getDescription, getDescriptionText, getId, getShortName, hasCustomIdAssigned, idOrCreate, setCustomId, setDescription, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

IdempotentConsumerDefinition

public IdempotentConsumerDefinition()

IdempotentConsumerDefinition

public IdempotentConsumerDefinition(Expression messageIdExpression,
                                    IdempotentRepository<?> idempotentRepository)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getLabel

public String getLabel()

Description copied from class: ProcessorDefinition

Returns a label to describe this node such as the expression if some kind of expression node

Specified by:

getLabel in interface NamedNode

Overrides:

getLabel in class ExpressionNode

messageIdRepositoryRef

public IdempotentConsumerDefinition messageIdRepositoryRef(String messageIdRepositoryRef)

Sets the reference name of the message id repository

Parameters:

messageIdRepositoryRef - the reference name of message id repository

Returns:

builder

messageIdRepository

public IdempotentConsumerDefinition messageIdRepository(IdempotentRepository<?> idempotentRepository)

Sets the message id repository for the idempotent consumer

Parameters:

idempotentRepository - the repository instance of idempotent

Returns:

builder

eager

public IdempotentConsumerDefinition eager(boolean eager)

Sets whether to eagerly add the key to the idempotent repository or wait until the exchange is complete. Eager is default enabled.

Parameters:

eager - true to add the key before processing, false to wait until the exchange is complete.

Returns:

builder

completionEager

public IdempotentConsumerDefinition completionEager(boolean completionEager)

Sets whether to complete the idempotent consumer eager or when the exchange is done.

If this option is true to complete eager, then the idempotent consumer will trigger its completion when the exchange reached the end of the block of the idempotent consumer pattern. So if the exchange is continued routed after the block ends, then whatever happens there does not affect the state.

If this option is false (default) to not complete eager, then the idempotent consumer will complete when the exchange is done being routed. So if the exchange is continued routed after the block ends, then whatever happens there also affect the state. For example if the exchange failed due to an exception, then the state of the idempotent consumer will be a rollback.

Parameters:

completionEager - whether to complete eager or complete when the exchange is done

Returns:

builder

removeOnFailure

public IdempotentConsumerDefinition removeOnFailure(boolean removeOnFailure)

Sets whether to remove or keep the key on failure.

The default behavior is to remove the key on failure.

Parameters:

removeOnFailure - true to remove the key, false to keep the key if the exchange fails.

Returns:

builder

skipDuplicate

public IdempotentConsumerDefinition skipDuplicate(boolean skipDuplicate)

Sets whether to skip duplicates or not.

The default behavior is to skip duplicates.

A duplicate message would have the Exchange property Exchange.DUPLICATE_MESSAGE set to a Boolean.TRUE value. A none duplicate message will not have this property set.

Parameters:

skipDuplicate - true to skip duplicates, false to allow duplicates.

Returns:

builder

setExpression

public void setExpression(ExpressionDefinition expression)

Expression used to calculate the correlation key to use for duplicate check. The Exchange which has the same correlation key is regarded as a duplicate and will be rejected.

Overrides:

setExpression in class ExpressionNode

getMessageIdRepositoryRef

public String getMessageIdRepositoryRef()

setMessageIdRepositoryRef

public void setMessageIdRepositoryRef(String messageIdRepositoryRef)

getMessageIdRepository

public IdempotentRepository<?> getMessageIdRepository()

setMessageIdRepository

public void setMessageIdRepository(IdempotentRepository<?> idempotentRepository)

getEager

public Boolean getEager()

setEager

public void setEager(Boolean eager)

getSkipDuplicate

public Boolean getSkipDuplicate()

setSkipDuplicate

public void setSkipDuplicate(Boolean skipDuplicate)

getRemoveOnFailure

public Boolean getRemoveOnFailure()

setRemoveOnFailure

public void setRemoveOnFailure(Boolean removeOnFailure)

getCompletionEager

public Boolean getCompletionEager()

setCompletionEager

public void setCompletionEager(Boolean completionEager)

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception

Description copied from class: ProcessorDefinition

Override this in definition class and implement logic to create the processor based on the definition model.

Overrides:

createProcessor in class ProcessorDefinition<ExpressionNode>

Throws:

Exception

resolveMessageIdRepository

protected <T> IdempotentRepository<T> resolveMessageIdRepository(RouteContext routeContext)

Strategy method to resolve the IdempotentRepository to use

Parameters:

routeContext - route context

Returns:

the repository