Dynamic Router - 6.3

Talend ESB Mediation Developer Guide

Talend Data Fabric
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
Design and Development
Talend ESB

The Dynamic Router from the EIP patterns allows you to route messages while avoiding the dependency of the router on all possible destinations while maintaining its efficiency.

There is a dynamicRouter in the DSL which is like a dynamic Routing Slip which evaluates the slip on-the-fly.


You must ensure the expression used for the dynamicRouter such as a bean, will return null to indicate the end. Otherwise the dynamicRouter will keep repeating endlessly.






Delimiter used if the Expression returned multiple endpoints.



If an endpoint URI could not be resolved, whether it should it be ignored. Otherwise Camel will throw an exception stating that the endpoint URI is not valid.



Camel 2.13.1/2.12.4: Allows to configure the cache size for the ProducerCache which caches producers for reuse in the routing slip. Will by default use the default cache size which is 1000. Setting the value to -1 allows to turn off the cache all together.

The Dynamic Router will set a property (Exchange.SLIP_ENDPOINT) on the Exchange which contains the current endpoint as it advanced though the slip. This allows you to know how far we have processed in the slip. (It's a slip because the Dynamic Router implementation is based on top of Routing Slip ).

Java DSL

In Java DSL you can use the routingSlip as shown below:

    // use a bean as the dynamic router
    .dynamicRouter(bean(DynamicRouterTest.class, "slip"));

Which will leverage a Camel Component: Bean to compute the slip on-the-fly, which could be implemented as follows:

 * Use this method to compute dynamic where we should route next.
 * @param body the message body
 * @return endpoints to go, or null to indicate the end
public String slip(String body) {

    if (invoked == 1) {
        return "mock:a";
    } else if (invoked == 2) {
        return "mock:b,mock:c";
    } else if (invoked == 3) {
        return "direct:foo";
    } else if (invoked == 4) {
        return "mock:result";

    // no more so return null
    return null;

Mind that this example is only for show and tell. The current implementation is not thread safe. You would have to store the state on the Exchange, to ensure thread safety.

Spring XML

The same example in Spring XML would be:

<bean id="mySlip" class="org.apache.camel.processor.DynamicRouterTest"/>

<camelContext xmlns="http://camel.apache.org/schema/spring">
        <from uri="direct:start"/>
            <!-- use a method call on a bean as dynamic router -->
            <method ref="mySlip" method="slip"/>

        <from uri="direct:foo"/>
        <transform><constant>Bye World</constant></transform>
        <to uri="mock:foo"/>


@DynamicRouter annotation

You can also use the @DynamicRouter annotation, for example the example below could be written as follows. The route method would then be invoked repeatedly as the message is processed dynamically. The idea is to return the next endpoint uri where to go. Return null to indicate the end. You can return multiple endpoints if you like, just as the Routing Slip, where each endpoint is separated by a delimiter.

public class MyDynamicRouter {

    @Consume(uri = "activemq:foo")
    public String route(@XPath("/customer/id") String customerId, 
    @Header("Location") String location, Document body) {
        // query a database to find the best match of the endpoint  
        // based on the input parameters
        // return the next endpoint uri, where to go. Return null 
        // to indicate the end.