org.apache.camel.impl

Class DefaultAsyncProcessorAwaitManager

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultAsyncProcessorAwaitManager

All Implemented Interfaces:

Service, ShutdownableService, AsyncProcessorAwaitManager, StatefulService, StaticService, SuspendableService

public class DefaultAsyncProcessorAwaitManager
extends ServiceSupport
implements AsyncProcessorAwaitManager

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.camel.spi.AsyncProcessorAwaitManager

AsyncProcessorAwaitManager.AwaitThread, AsyncProcessorAwaitManager.Statistics

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
DefaultAsyncProcessorAwaitManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	await(Exchange exchange, CountDownLatch latch) Registers the exchange to await for the callback to be triggered by another thread which has taken over processing this exchange.
Collection<AsyncProcessorAwaitManager.AwaitThread>	browse() A read-only browser of the AsyncProcessorAwaitManager.AwaitThreads that are currently inflight.
void	countDown(Exchange exchange, CountDownLatch latch) Triggered when the other thread is done processing the exchange, to signal to the waiting thread is done, and can take over control to further process the exchange.
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
AsyncProcessorAwaitManager.Statistics	getStatistics() Gets the utilization statistics of this manager
void	interrupt(Exchange exchange) To interrupt an exchange which may seem as stuck, to force the exchange to continue, allowing any blocking thread to be released.
void	interrupt(String exchangeId) To interrupt an exchange which may seem as stuck, to force the exchange to continue, allowing any blocking thread to be released.
boolean	isInterruptThreadsWhileStopping() Whether to interrupt any blocking threads during stopping.
void	setInterruptThreadsWhileStopping(boolean interruptThreadsWhileStopping) Sets whether to interrupt any blocking threads during stopping.
int	size() Number of threads that are blocked waiting for other threads to trigger the callback when they are done processing the exchange.

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

doResume, doShutdown, 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, toString, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

DefaultAsyncProcessorAwaitManager

public DefaultAsyncProcessorAwaitManager()

Method Detail

await

public void await(Exchange exchange,
         CountDownLatch latch)

Description copied from interface: AsyncProcessorAwaitManager

Registers the exchange to await for the callback to be triggered by another thread which has taken over processing this exchange. The current thread will await until that callback happens in the future (blocking until this happens).

Specified by:

await in interface AsyncProcessorAwaitManager

Parameters:

exchange - the exchange

latch - the latch used to wait for other thread to signal when its done

countDown

public void countDown(Exchange exchange,
             CountDownLatch latch)

Description copied from interface: AsyncProcessorAwaitManager

Triggered when the other thread is done processing the exchange, to signal to the waiting thread is done, and can take over control to further process the exchange.

Specified by:

countDown in interface AsyncProcessorAwaitManager

Parameters:

exchange - the exchange

latch - the latch used to wait for other thread to signal when its done

size

public int size()

Description copied from interface: AsyncProcessorAwaitManager

Number of threads that are blocked waiting for other threads to trigger the callback when they are done processing the exchange.

Specified by:

size in interface AsyncProcessorAwaitManager

browse

public Collection<AsyncProcessorAwaitManager.AwaitThread> browse()

Description copied from interface: AsyncProcessorAwaitManager

A read-only browser of the AsyncProcessorAwaitManager.AwaitThreads that are currently inflight.

Specified by:

browse in interface AsyncProcessorAwaitManager

interrupt

public void interrupt(String exchangeId)

Description copied from interface: AsyncProcessorAwaitManager

To interrupt an exchange which may seem as stuck, to force the exchange to continue, allowing any blocking thread to be released.

Important: Use this with caution as the other thread is still assumed to be process the exchange. Though if it appears as the exchange is stuck, then this method can remedy this, by forcing the latch to count-down so the blocked thread can continue. An exception is set on the exchange which allows Camel's error handler to deal with this malfunctioned exchange.

Specified by:

interrupt in interface AsyncProcessorAwaitManager

Parameters:

exchangeId - the exchange id to interrupt.

interrupt

public void interrupt(Exchange exchange)

Description copied from interface: AsyncProcessorAwaitManager

To interrupt an exchange which may seem as stuck, to force the exchange to continue, allowing any blocking thread to be released.

Important: Use this with caution as the other thread is still assumed to be process the exchange. Though if it appears as the exchange is stuck, then this method can remedy this, by forcing the latch to count-down so the blocked thread can continue. An exception is set on the exchange which allows Camel's error handler to deal with this malfunctioned exchange.

Specified by:

interrupt in interface AsyncProcessorAwaitManager

Parameters:

exchange - the exchange to interrupt.

isInterruptThreadsWhileStopping

public boolean isInterruptThreadsWhileStopping()

Description copied from interface: AsyncProcessorAwaitManager

Whether to interrupt any blocking threads during stopping.

This is enabled by default which allows Camel to release any blocked thread during shutting down Camel itself.

Specified by:

isInterruptThreadsWhileStopping in interface AsyncProcessorAwaitManager

setInterruptThreadsWhileStopping

public void setInterruptThreadsWhileStopping(boolean interruptThreadsWhileStopping)

Description copied from interface: AsyncProcessorAwaitManager

Sets whether to interrupt any blocking threads during stopping.

This is enabled by default which allows Camel to release any blocked thread during shutting down Camel itself.

Specified by:

setInterruptThreadsWhileStopping in interface AsyncProcessorAwaitManager

getStatistics

public AsyncProcessorAwaitManager.Statistics getStatistics()

Description copied from interface: AsyncProcessorAwaitManager

Gets the utilization statistics of this manager

Specified by:

getStatistics in interface AsyncProcessorAwaitManager

Returns:

the utilization statistics

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()