org.apache.camel.processor

Class ThreadsProcessor

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.processor.ThreadsProcessor

All Implemented Interfaces:

AsyncProcessor, Processor, Service, ShutdownableService, StatefulService, SuspendableService

public class ThreadsProcessor
extends ServiceSupport
implements AsyncProcessor

Threads processor that leverage a thread pool for continue processing the Exchanges using the asynchronous routing engine.

Notice: For transacted routes then this ThreadsProcessor is not in use, as we want to process messages using the same thread to support all work done in the same transaction. The reason is that the transaction manager that orchestrate the transaction, requires all the work to be done on the same thread.

Pay attention to how this processor handles rejected tasks.

• Abort - The current exchange will be set with a RejectedExecutionException exception, and marked to stop continue routing. The UnitOfWork will be regarded as failed, due the exception.
• Discard - The current exchange will be marked to stop continue routing (notice no exception is set). The UnitOfWork will be regarded as successful, due no exception being set.
• DiscardOldest - The oldest exchange will be marked to stop continue routing (notice no exception is set). The UnitOfWork will be regarded as successful, due no exception being set. And the current exchange will be added to the task queue.
• CallerRuns - The current exchange will be processed by the current thread. Which mean the current thread will not be free to process a new exchange, as its processing the current exchange.

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
ThreadsProcessor(CamelContext camelContext, ExecutorService executorService, boolean shutdownExecutorService)

Method Summary

Methods

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.
ThreadPoolRejectedPolicy	getRejectedPolicy()
boolean	isCallerRunsWhenRejected()
void	process(Exchange exchange) Processes the message exchange
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
void	setCallerRunsWhenRejected(boolean callerRunsWhenRejected)
void	setRejectedPolicy(ThreadPoolRejectedPolicy rejectedPolicy)
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

ThreadsProcessor

public ThreadsProcessor(CamelContext camelContext,
                ExecutorService executorService,
                boolean shutdownExecutorService)

Method Detail

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

isCallerRunsWhenRejected

public boolean isCallerRunsWhenRejected()

setCallerRunsWhenRejected

public void setCallerRunsWhenRejected(boolean callerRunsWhenRejected)

getRejectedPolicy

public ThreadPoolRejectedPolicy getRejectedPolicy()

setRejectedPolicy

public void setRejectedPolicy(ThreadPoolRejectedPolicy rejectedPolicy)

toString

public String toString()

Overrides:

toString in class Object

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