org.apache.camel.processor

Class LoopProcessor

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.processor.DelegateAsyncProcessor

org.apache.camel.processor.LoopProcessor

All Implemented Interfaces:

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

public class LoopProcessor
extends DelegateAsyncProcessor
implements Traceable, IdAware

The processor which sends messages in a loop.

Field Summary

Fields inherited from class org.apache.camel.processor.DelegateAsyncProcessor

processor

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

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

Constructor Summary

Constructors

Constructor and Description
LoopProcessor(Processor processor, Expression expression, Predicate predicate, boolean copy)

Method Summary

Modifier and Type	Method and Description
Expression	getExpression()
String	getId() Returns the id
Predicate	getPredicate()
String	getTraceLabel() Gets the trace label used for logging when tracing is enabled.
boolean	isCopy()
protected Exchange	prepareExchange(Exchange exchange, int index, Exchange original) Prepares the exchange for the next iteration
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
protected boolean	process(Exchange exchange, AsyncCallback callback, AtomicInteger index, AtomicInteger count, AtomicBoolean doWhile, Exchange original)
void	setId(String id) Sets the id
String	toString()

Methods inherited from class org.apache.camel.processor.DelegateAsyncProcessor

doShutdown, doStart, doStop, getProcessor, hasNext, next, process, processNext, setProcessor, setProcessor

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

LoopProcessor

public LoopProcessor(Processor processor,
                     Expression expression,
                     Predicate predicate,
                     boolean copy)

Method Detail

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

Overrides:

process in class DelegateAsyncProcessor

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

process

protected boolean process(Exchange exchange,
                          AsyncCallback callback,
                          AtomicInteger index,
                          AtomicInteger count,
                          AtomicBoolean doWhile,
                          Exchange original)

prepareExchange

protected Exchange prepareExchange(Exchange exchange,
                                   int index,
                                   Exchange original)

Prepares the exchange for the next iteration

Parameters:

exchange - the exchange

index - the index of the next iteration

Returns:

the exchange to use

getExpression

public Expression getExpression()

getPredicate

public Predicate getPredicate()

isCopy

public boolean isCopy()

getTraceLabel

public String getTraceLabel()

Description copied from interface: Traceable

Gets the trace label used for logging when tracing is enabled.

The label should be short and precise.

Specified by:

getTraceLabel in interface Traceable

Returns:

the label

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

toString

public String toString()

Overrides:

toString in class DelegateAsyncProcessor