org.apache.camel.processor
Class RoutingSlip

java.lang.Object
  org.apache.camel.support.ServiceSupport
      org.apache.camel.processor.RoutingSlip

All Implemented Interfaces:

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

Direct Known Subclasses:

DynamicRouter

public class RoutingSlip
extends ServiceSupport
implements AsyncProcessor, Traceable

Implements a Routing Slip pattern where the list of actual endpoints to send a message exchange to are dependent on the value of a message header.

This implementation mirrors the logic from the Pipeline in the async variation as the failover load balancer is a specialized pipeline. So the trick is to keep doing the same as the pipeline to ensure it works the same and the async routing engine is flawless.

Nested Class Summary

protected static interface

RoutingSlip.RoutingSlipIterator The iterator to be used for retrieving the next routing slip(s) to be used.

Field Summary

protected CamelContext	camelContext
protected Expression	expression
protected String	header
protected boolean	ignoreInvalidEndpoints
protected org.slf4j.Logger	log
protected ProducerCache	producerCache
protected String	uriDelimiter

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

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

Constructor Summary

RoutingSlip(CamelContext camelContext)

RoutingSlip(CamelContext camelContext, Expression expression, String uriDelimiter)

Method Summary

protected RoutingSlip.RoutingSlipIterator	createRoutingSlipIterator(Exchange exchange) Creates the route slip iterator to be used.
boolean	doRoutingSlip(Exchange exchange, Object routingSlip, AsyncCallback callback)
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.
String	getTraceLabel() Gets the trace label used for logging when tracing is enabled.
boolean	isIgnoreInvalidEndpoints()
protected Exchange	prepareExchangeForRoutingSlip(Exchange current, Endpoint endpoint)
void	process(Exchange exchange) Processes the message exchange
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
protected boolean	processExchange(Endpoint endpoint, Exchange exchange, Exchange original, AsyncCallback callback, RoutingSlip.RoutingSlipIterator iter)
protected Endpoint	resolveEndpoint(RoutingSlip.RoutingSlipIterator iter, Exchange exchange)
void	setDelimiter(String delimiter)
void	setIgnoreInvalidEndpoints(boolean ignoreInvalidEndpoints)
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final transient org.slf4j.Logger log

producerCache

protected ProducerCache producerCache

ignoreInvalidEndpoints

protected boolean ignoreInvalidEndpoints

header

protected String header

expression

protected Expression expression

uriDelimiter

protected String uriDelimiter

camelContext

protected final CamelContext camelContext

Constructor Detail

RoutingSlip

public RoutingSlip(CamelContext camelContext)

RoutingSlip

public RoutingSlip(CamelContext camelContext,
                   Expression expression,
                   String uriDelimiter)

Method Detail

setDelimiter

public void setDelimiter(String delimiter)

isIgnoreInvalidEndpoints

public boolean isIgnoreInvalidEndpoints()

setIgnoreInvalidEndpoints

public void setIgnoreInvalidEndpoints(boolean ignoreInvalidEndpoints)

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

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

See Also:

AsyncProcessorHelper.process(AsyncProcessor, Exchange, AsyncCallback)

doRoutingSlip

public boolean doRoutingSlip(Exchange exchange,
                             Object routingSlip,
                             AsyncCallback callback)

createRoutingSlipIterator

protected RoutingSlip.RoutingSlipIterator createRoutingSlipIterator(Exchange exchange)
                                                             throws Exception

Creates the route slip iterator to be used.

Parameters:

exchange - the exchange

Returns:

the iterator, should never be null

Throws:

Exception

resolveEndpoint

protected Endpoint resolveEndpoint(RoutingSlip.RoutingSlipIterator iter,
                                   Exchange exchange)
                            throws Exception

Throws:

Exception

prepareExchangeForRoutingSlip

protected Exchange prepareExchangeForRoutingSlip(Exchange current,
                                                 Endpoint endpoint)

processExchange

protected boolean processExchange(Endpoint endpoint,
                                  Exchange exchange,
                                  Exchange original,
                                  AsyncCallback callback,
                                  RoutingSlip.RoutingSlipIterator iter)

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