org.apache.camel.processor

Class WireTapProcessor

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.processor.WireTapProcessor

All Implemented Interfaces:

AsyncProcessor, CamelContextAware, Processor, Service, ShutdownableService, HasId, IdAware, ShutdownAware, ShutdownPrepared, StatefulService, SuspendableService, Traceable

public class WireTapProcessor
extends ServiceSupport
implements AsyncProcessor, Traceable, ShutdownAware, IdAware, CamelContextAware

Processor for wire tapping exchanges to an endpoint destination.

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
WireTapProcessor(SendDynamicProcessor dynamicProcessor, Processor processor, ExchangePattern exchangePattern, ExecutorService executorService, boolean shutdownExecutorService, boolean dynamicUri)

Method Summary

Modifier and Type	Method and Description
void	addNewExchangeProcessor(Processor processor)
protected Exchange	configureExchange(Exchange exchange, ExchangePattern pattern)
boolean	deferShutdown(ShutdownRunningTask shutdownRunningTask) To defer shutdown during first phase of shutdown.
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.
int	getCacheSize()
CamelContext	getCamelContext() Get the CamelContext
EndpointUtilizationStatistics	getEndpointUtilizationStatistics()
String	getId() Returns the id
Expression	getNewExchangeExpression()
List<Processor>	getNewExchangeProcessors()
Processor	getOnPrepare()
int	getPendingExchangesSize() Gets the number of pending exchanges.
String	getTraceLabel() Gets the trace label used for logging when tracing is enabled.
String	getUri()
boolean	isCopy()
boolean	isDynamicUri()
boolean	isIgnoreInvalidEndpoint()
void	prepareShutdown(boolean suspendOnly, boolean forced) Prepares for stop/shutdown.
void	process(Exchange exchange) Processes the message exchange
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
void	setCamelContext(CamelContext camelContext) Injects the CamelContext
void	setCopy(boolean copy)
void	setId(String id) Sets the id
void	setNewExchangeExpression(Expression newExchangeExpression)
void	setNewExchangeProcessors(List<Processor> newExchangeProcessors)
void	setOnPrepare(Processor onPrepare)
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

Constructor Detail

WireTapProcessor

public WireTapProcessor(SendDynamicProcessor dynamicProcessor,
                        Processor processor,
                        ExchangePattern exchangePattern,
                        ExecutorService executorService,
                        boolean shutdownExecutorService,
                        boolean dynamicUri)

Method Detail

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

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

getCamelContext

public CamelContext getCamelContext()

Description copied from interface: CamelContextAware

Get the CamelContext

Specified by:

getCamelContext in interface CamelContextAware

Returns:

camelContext the Camel context

setCamelContext

public void setCamelContext(CamelContext camelContext)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

camelContext - the Camel context

deferShutdown

public boolean deferShutdown(ShutdownRunningTask shutdownRunningTask)

Description copied from interface: ShutdownAware

To defer shutdown during first phase of shutdown. This allows any pending exchanges to be completed and therefore ensure a graceful shutdown without loosing messages. At the very end when there are no more inflight and pending messages the consumer could then safely be shutdown.

This is needed by SedaConsumer.

Specified by:

deferShutdown in interface ShutdownAware

Parameters:

shutdownRunningTask - the configured option for how to act when shutting down running tasks.

Returns:

true to defer shutdown to very last.

getPendingExchangesSize

public int getPendingExchangesSize()

Description copied from interface: ShutdownAware

Gets the number of pending exchanges.

Some consumers has internal queues with Exchange which are pending. For example the SedaConsumer.

Return zero to indicate no pending exchanges and therefore ready to shutdown.

Specified by:

getPendingExchangesSize in interface ShutdownAware

Returns:

number of pending exchanges

prepareShutdown

public void prepareShutdown(boolean suspendOnly,
                            boolean forced)

Description copied from interface: ShutdownPrepared

Prepares for stop/shutdown.

The ShutdownStrategy supports preparing for shutdown using two steps. First a regular preparation, where the given forced parameter will be false. And if the shutdown times out, then the ShutdownStrategy performs a more aggressive shutdown, calling this method a second time with true for the given forced parameter. For example by graceful stopping any threads or the likes.

In addition a service can also be suspended (not stopped), and when this happens the parameter suspendOnly has the value true. This can be used to prepare the service for suspension, such as marking a worker thread to skip action.

For forced shutdown, then the service is expected to aggressively shutdown any child services, such as thread pools etc. This is the last chance it has to perform such duties.

Specified by:

prepareShutdown in interface ShutdownPrepared

Parameters:

suspendOnly - true if the intention is to only suspend the service, and not stop/shutdown the service.

forced - true is forcing a more aggressive shutdown, false is for preparing to shutdown.

getEndpointUtilizationStatistics

public EndpointUtilizationStatistics getEndpointUtilizationStatistics()

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

configureExchange

protected Exchange configureExchange(Exchange exchange,
                                     ExchangePattern pattern)
                              throws IOException

Throws:

IOException

getNewExchangeProcessors

public List<Processor> getNewExchangeProcessors()

setNewExchangeProcessors

public void setNewExchangeProcessors(List<Processor> newExchangeProcessors)

getNewExchangeExpression

public Expression getNewExchangeExpression()

setNewExchangeExpression

public void setNewExchangeExpression(Expression newExchangeExpression)

addNewExchangeProcessor

public void addNewExchangeProcessor(Processor processor)

isCopy

public boolean isCopy()

setCopy

public void setCopy(boolean copy)

getOnPrepare

public Processor getOnPrepare()

setOnPrepare

public void setOnPrepare(Processor onPrepare)

getUri

public String getUri()

getCacheSize

public int getCacheSize()

isIgnoreInvalidEndpoint

public boolean isIgnoreInvalidEndpoint()

isDynamicUri

public boolean isDynamicUri()

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