org.apache.camel.processor

Class OnCompletionProcessor

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.processor.OnCompletionProcessor

All Implemented Interfaces:

AsyncProcessor, Processor, Service, ShutdownableService, StatefulService, SuspendableService, Traceable

public class OnCompletionProcessor
extends ServiceSupport
implements AsyncProcessor, Traceable

Processor implementing onCompletion.

Version:

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
OnCompletionProcessor(CamelContext camelContext, Processor processor, ExecutorService executorService, boolean shutdownExecutorService, boolean onCompleteOnly, boolean onFailureOnly, Predicate onWhen, boolean useOriginalBody, boolean afterConsumer)

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	doProcess(Processor processor, Exchange exchange) Processes the exchange by the processors
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()
String	getTraceLabel() Gets the trace label used for logging when tracing is enabled.
protected boolean	isCreateCopy()
protected Exchange	prepareExchange(Exchange exchange) Prepares the Exchange to send as onCompletion.
void	process(Exchange exchange) Processes the message exchange
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OnCompletionProcessor

public OnCompletionProcessor(CamelContext camelContext,
                     Processor processor,
                     ExecutorService executorService,
                     boolean shutdownExecutorService,
                     boolean onCompleteOnly,
                     boolean onFailureOnly,
                     Predicate onWhen,
                     boolean useOriginalBody,
                     boolean afterConsumer)

Method Detail

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

getCamelContext

public CamelContext getCamelContext()

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

isCreateCopy

protected boolean isCreateCopy()

doProcess

protected static void doProcess(Processor processor,
             Exchange exchange)

Processes the exchange by the processors

Parameters:

processor - the processor

exchange - the exchange

prepareExchange

protected Exchange prepareExchange(Exchange exchange)

Prepares the Exchange to send as onCompletion.

Parameters:

exchange - the current exchange

Returns:

the exchange to be routed in onComplete

toString

public String toString()

Overrides:

toString in class Object

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