org.apache.camel.model

Class ResequenceDefinition

java.lang.Object

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

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

org.apache.camel.model.ResequenceDefinition

All Implemented Interfaces:

Block, OtherAttributesAware, NamedNode

@Metadata(label="eip,routing")
public class ResequenceDefinition
extends ProcessorDefinition<ResequenceDefinition>

Resequences (re-order) messages based on an expression

Version:

Field Summary

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

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
ResequenceDefinition()
ResequenceDefinition(Expression expression)

Method Summary

Modifier and Type	Method and Description
ResequenceDefinition	allowDuplicates() Enables duplicates for the batch resequencer mode
ResequenceDefinition	batch() Configures the batch-based resequencing algorithm using the default configuration.
ResequenceDefinition	batch(BatchResequencerConfig config) Configures the batch-based resequencing algorithm using the given BatchResequencerConfig.
ResequenceDefinition	capacity(int capacity) Sets the capacity for the stream resequencer
ResequenceDefinition	comparator(ExpressionResultComparator comparator) Sets the comparator to use for stream resequencer
protected Resequencer	createBatchResequencer(RouteContext routeContext, BatchResequencerConfig config) Creates a batch Resequencer instance applying the given config.
Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
protected StreamResequencer	createStreamResequencer(RouteContext routeContext, StreamResequencerConfig config) Creates a StreamResequencer instance applying the given config.
ResequenceDefinition	deliveryAttemptInterval(long deliveryAttemptInterval) Sets the interval in milli seconds the stream resequencer will at most wait while waiting for condition of being able to deliver.
BatchResequencerConfig	getBatchConfig()
ExpressionDefinition	getExpression()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
List<ProcessorDefinition<?>>	getOutputs()
ResequencerConfig	getResequencerConfig()
StreamResequencerConfig	getStreamConfig()
ResequenceDefinition	ignoreInvalidExchanges() If an incoming Exchange is invalid, then it will be ignored.
boolean	isOutputSupported()
ResequenceDefinition	rejectOld() Sets the rejectOld flag to throw an error when a message older than the last delivered message is processed
ResequenceDefinition	reverse() Enables reverse mode for the batch resequencer mode.
void	setBatchConfig(BatchResequencerConfig batchConfig)
void	setExpression(ExpressionDefinition expression) Expression to use for re-ordering the messages, such as a header with a sequence number
void	setOutputs(List<ProcessorDefinition<?>> outputs)
void	setResequencerConfig(ResequencerConfig resequencerConfig) To configure the resequencer in using either batch or stream configuration.
void	setStreamConfig(StreamResequencerConfig streamConfig)
ResequenceDefinition	size(int batchSize) Sets the in batch size for number of exchanges received
ResequenceDefinition	stream() Configures the stream-based resequencing algorithm using the default configuration.
ResequenceDefinition	stream(StreamResequencerConfig config) Configures the stream-based resequencing algorithm using the given StreamResequencerConfig.
ResequenceDefinition	timeout(long timeout) Sets the timeout
String	toString()

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, configureChild, 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, preCreateProcessor, 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

ResequenceDefinition

public ResequenceDefinition()

ResequenceDefinition

public ResequenceDefinition(Expression expression)

Method Detail

getOutputs

public List<ProcessorDefinition<?>> getOutputs()

Specified by:

getOutputs in class ProcessorDefinition<ResequenceDefinition>

setOutputs

public void setOutputs(List<ProcessorDefinition<?>> outputs)

isOutputSupported

public boolean isOutputSupported()

Specified by:

isOutputSupported in class ProcessorDefinition<ResequenceDefinition>

stream

public ResequenceDefinition stream()

Configures the stream-based resequencing algorithm using the default configuration.

Returns:

the builder

batch

public ResequenceDefinition batch()

Configures the batch-based resequencing algorithm using the default configuration.

Returns:

the builder

stream

public ResequenceDefinition stream(StreamResequencerConfig config)

Configures the stream-based resequencing algorithm using the given StreamResequencerConfig.

Parameters:

config - the config

Returns:

the builder

batch

public ResequenceDefinition batch(BatchResequencerConfig config)

Configures the batch-based resequencing algorithm using the given BatchResequencerConfig.

Parameters:

config - the config

Returns:

the builder

timeout

public ResequenceDefinition timeout(long timeout)

Sets the timeout

Parameters:

timeout - timeout in millis

Returns:

the builder

deliveryAttemptInterval

public ResequenceDefinition deliveryAttemptInterval(long deliveryAttemptInterval)

Sets the interval in milli seconds the stream resequencer will at most wait while waiting for condition of being able to deliver.

Parameters:

deliveryAttemptInterval - interval in millis

Returns:

the builder

rejectOld

public ResequenceDefinition rejectOld()

Sets the rejectOld flag to throw an error when a message older than the last delivered message is processed

Returns:

the builder

size

public ResequenceDefinition size(int batchSize)

Sets the in batch size for number of exchanges received

Parameters:

batchSize - the batch size

Returns:

the builder

capacity

public ResequenceDefinition capacity(int capacity)

Sets the capacity for the stream resequencer

Parameters:

capacity - the capacity

Returns:

the builder

allowDuplicates

public ResequenceDefinition allowDuplicates()

Enables duplicates for the batch resequencer mode

Returns:

the builder

reverse

public ResequenceDefinition reverse()

Enables reverse mode for the batch resequencer mode.

This means the expression for determine the sequence order will be reversed. Can be used for Z..A or 9..0 ordering.

Returns:

the builder

ignoreInvalidExchanges

public ResequenceDefinition ignoreInvalidExchanges()

If an incoming Exchange is invalid, then it will be ignored.

Returns:

builder

comparator

public ResequenceDefinition comparator(ExpressionResultComparator comparator)

Sets the comparator to use for stream resequencer

Parameters:

comparator - the comparator

Returns:

the builder

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 ProcessorDefinition<ResequenceDefinition>

getResequencerConfig

public ResequencerConfig getResequencerConfig()

setResequencerConfig

public void setResequencerConfig(ResequencerConfig resequencerConfig)

To configure the resequencer in using either batch or stream configuration. Will by default use batch configuration.

getBatchConfig

public BatchResequencerConfig getBatchConfig()

getStreamConfig

public StreamResequencerConfig getStreamConfig()

setBatchConfig

public void setBatchConfig(BatchResequencerConfig batchConfig)

setStreamConfig

public void setStreamConfig(StreamResequencerConfig streamConfig)

getExpression

public ExpressionDefinition getExpression()

setExpression

public void setExpression(ExpressionDefinition expression)

Expression to use for re-ordering the messages, such as a header with a sequence number

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<ResequenceDefinition>

Throws:

Exception

createBatchResequencer

protected Resequencer createBatchResequencer(RouteContext routeContext,
                                             BatchResequencerConfig config)
                                      throws Exception

Creates a batch Resequencer instance applying the given config.

Parameters:

routeContext - route context.

config - batch resequencer configuration.

Returns:

the configured batch resequencer.

Throws:

Exception - can be thrown

createStreamResequencer

protected StreamResequencer createStreamResequencer(RouteContext routeContext,
                                                    StreamResequencerConfig config)
                                             throws Exception

Creates a StreamResequencer instance applying the given config.

Parameters:

routeContext - route context.

config - stream resequencer configuration.

Returns:

the configured stream resequencer.

Throws:

Exception - can be thrwon