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, HasId, IdAware, StatefulService, SuspendableService, Traceable

Direct Known Subclasses:

DynamicRouter

public class RoutingSlip
extends ServiceSupport
implements AsyncProcessor, Traceable, IdAware

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

Nested Classes

Modifier and Type	Class and Description
protected static interface	RoutingSlip.RoutingSlipIterator The iterator to be used for retrieving the next routing slip(s) to be used.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cacheSize
protected CamelContext	camelContext
protected AsyncProcessor	errorHandler
protected Expression	expression
protected String	header
protected String	id
protected boolean	ignoreInvalidEndpoints
protected org.slf4j.Logger	log
protected ProducerCache	producerCache
protected SendDynamicProcessor	sendDynamicProcessor
protected String	uriDelimiter

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

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

Constructor Summary

Constructors

Constructor and Description
RoutingSlip(CamelContext camelContext)
RoutingSlip(CamelContext camelContext, Expression expression, String uriDelimiter)

Method Summary

Modifier and Type	Method and Description
protected AsyncProcessor	createErrorHandler(RouteContext routeContext, Exchange exchange, AsyncProcessor processor, Endpoint endpoint)
protected RoutingSlip.RoutingSlipIterator	createRoutingSlipIterator(Exchange exchange, Expression expression) 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.
int	getCacheSize()
EndpointUtilizationStatistics	getEndpointUtilizationStatistics()
AsyncProcessor	getErrorHandler()
Expression	getExpression()
String	getId() Returns the id
String	getTraceLabel() Gets the trace label used for logging when tracing is enabled.
String	getUriDelimiter()
boolean	isIgnoreInvalidEndpoints()
AsyncProcessor	newRoutingSlipProcessorForErrorHandler() Creates the embedded processor to use when wrapping this routing slip in an error handler.
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 originalCallback, RoutingSlip.RoutingSlipIterator iter)
protected Endpoint	resolveEndpoint(RoutingSlip.RoutingSlipIterator iter, Exchange exchange)
void	setCacheSize(int cacheSize)
void	setDelimiter(String delimiter)
void	setErrorHandler(AsyncProcessor errorHandler)
void	setId(String id) Sets the id
void	setIgnoreInvalidEndpoints(boolean ignoreInvalidEndpoints)
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

Field Detail

log

protected final org.slf4j.Logger log

id

protected String id

producerCache

protected ProducerCache producerCache

cacheSize

protected int cacheSize

ignoreInvalidEndpoints

protected boolean ignoreInvalidEndpoints

header

protected String header

expression

protected Expression expression

uriDelimiter

protected String uriDelimiter

camelContext

protected final CamelContext camelContext

errorHandler

protected AsyncProcessor errorHandler

sendDynamicProcessor

protected SendDynamicProcessor sendDynamicProcessor

Constructor Detail

RoutingSlip

public RoutingSlip(CamelContext camelContext)

RoutingSlip

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

Method Detail

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

getExpression

public Expression getExpression()

getUriDelimiter

public String getUriDelimiter()

setDelimiter

public void setDelimiter(String delimiter)

isIgnoreInvalidEndpoints

public boolean isIgnoreInvalidEndpoints()

setIgnoreInvalidEndpoints

public void setIgnoreInvalidEndpoints(boolean ignoreInvalidEndpoints)

getCacheSize

public int getCacheSize()

setCacheSize

public void setCacheSize(int cacheSize)

getErrorHandler

public AsyncProcessor getErrorHandler()

setErrorHandler

public void setErrorHandler(AsyncProcessor errorHandler)

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

doRoutingSlip

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

createRoutingSlipIterator

protected RoutingSlip.RoutingSlipIterator createRoutingSlipIterator(Exchange exchange,
                                                                    Expression expression)
                                                             throws Exception

Creates the route slip iterator to be used.

Parameters:

exchange - the exchange

expression - the expression

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)

createErrorHandler

protected AsyncProcessor createErrorHandler(RouteContext routeContext,
                                            Exchange exchange,
                                            AsyncProcessor processor,
                                            Endpoint endpoint)

processExchange

protected boolean processExchange(Endpoint endpoint,
                                  Exchange exchange,
                                  Exchange original,
                                  AsyncCallback originalCallback,
                                  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

getEndpointUtilizationStatistics

public EndpointUtilizationStatistics getEndpointUtilizationStatistics()

newRoutingSlipProcessorForErrorHandler

public AsyncProcessor newRoutingSlipProcessorForErrorHandler()

Creates the embedded processor to use when wrapping this routing slip in an error handler.