org.apache.camel.processor

Class DelegateAsyncProcessor

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.processor.DelegateAsyncProcessor

All Implemented Interfaces:

AsyncProcessor, DelegateProcessor, Navigate<Processor>, Processor, Service, ShutdownableService, StatefulService, SuspendableService

Direct Known Subclasses:

CamelInternalProcessor, CatchProcessor, DelayProcessorSupport, DirectVmProcessor, FatalFallbackErrorHandler, FilterProcessor, FinallyProcessor, HandleFaultInterceptor, InstrumentationProcessor, InterceptEndpointProcessor, LoopProcessor, RestProducerBindingProcessor, SagaProcessor, SamplingThrottler, StreamCachingInterceptor, Throttler, TraceInterceptor, WrapProcessor

public class DelegateAsyncProcessor
extends ServiceSupport
implements DelegateProcessor, AsyncProcessor, Navigate<Processor>

A Delegate pattern which delegates processing to a nested AsyncProcessor which can be useful for implementation inheritance when writing an Policy

Important: This implementation does support the asynchronous routing engine. If you are implementing a EIP pattern please use this as the delegate.

Version:

See Also:

DelegateSyncProcessor, DelegateProcessor

Field Summary

Fields

Modifier and Type	Field and Description
protected AsyncProcessor	processor

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

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

Constructor Summary

Constructors

Constructor and Description
DelegateAsyncProcessor()
DelegateAsyncProcessor(AsyncProcessor processor)
DelegateAsyncProcessor(Processor processor)

Method Summary

Modifier and Type	Method and Description
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.
AsyncProcessor	getProcessor() Gets the delegated Processor.
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.
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.
void	process(Exchange exchange) Processes the message exchange
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
protected boolean	processNext(Exchange exchange, AsyncCallback callback) Deprecated. use process(org.apache.camel.Exchange, org.apache.camel.AsyncCallback) instead
void	setProcessor(AsyncProcessor processor)
void	setProcessor(Processor processor)
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

Field Detail

processor

protected AsyncProcessor processor

Constructor Detail

DelegateAsyncProcessor

public DelegateAsyncProcessor()

DelegateAsyncProcessor

public DelegateAsyncProcessor(AsyncProcessor processor)

DelegateAsyncProcessor

public DelegateAsyncProcessor(Processor processor)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getProcessor

public AsyncProcessor getProcessor()

Description copied from interface: DelegateProcessor

Gets the delegated Processor.

Specified by:

getProcessor in interface DelegateProcessor

Returns:

the processor we delegate to

setProcessor

public void setProcessor(AsyncProcessor processor)

setProcessor

public void setProcessor(Processor processor)

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

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

processNext

@Deprecated
protected boolean processNext(Exchange exchange,
                                          AsyncCallback callback)

Deprecated. use process(org.apache.camel.Exchange, org.apache.camel.AsyncCallback) instead

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

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