Scala DSL and camel spring schema-CFANZ编程社区

Just like the Java DSL, the Scala DSL has a RouteBuilder class (org.apache.camel.scala.builder.RouteBuilder) that you can extend to implement your own routes. This example shows two very simple routes:

class MyRouteBuilder extends RouteBuilder {
  "direct:a" --> "mock:a"
  "direct:b" to "mock:b"      
}

If you compare this to the Java DSL, you notice:

there is no configure() method to override
a route starts directly with a URI instead of from(uri)
→ is just an alias for to

Setting the route ID

To assign the unique ID to the Scala route, insert the routeId

"direct:a" routeId "route-b" to "mock:b"

DSL supported The Scala DSL supports every DSL from the Java DSL. On this page we have examples for a number of the EIPs. You can check the unit test source code for the Scala Component to find more examples.

1 Messaging systems

1.1 Pipeline
1.2 Filter

2 Messaging channels

2.1 Dead letter channel

3 Message routing

3.1 Aggregator
3.2 Content based router
3.3 Delayer
3.4 Load balancer
3.5 Multicast
3.6 Recipient list
3.7 Resequencer
3.8 Splitter
3.9 Throttler

4 Message transformation

4.1 Content enricher

Messaging systems

Pipeline

There is a simple syntax available for specifying pipeline, by simple putting to or →

"direct:a" --> "mock:a" --> "mock:b"
"direct:c" to "mock:c" to "mock:d"

For more advanced use cases, you can also use a block-based syntax, where every step in the pipeline starts with either to or →.

"direct:e" ==> {
  --> ("mock:e")
  --> ("mock:f")
}

"direct:g" ==> {
  to ("mock:g")
  to ("mock:h")
}

Filter

For a message filter, use the when() method with a parameter of type The Exchange ⇒ Boolean. In the example below, we use a Scala convenience method named in to access the 'in' message body; only messages where the 'in' message is <hello/> will arrive at the mock:a

"direct:a" when(_.in == "<hello/>") to("mock:a")

Once again, if you need to specify a more advanced route, you can use the more elaborate syntax.

"direct:b" ==> {
  when(_.in == "<hallo/>") {
    --> ("mock:b")
    to ("mock:c")
  } otherwise {
    to ("mock:e")
  }
  to ("mock:d")
}

Messaging channels

Dead letter channel

The dead letter channel can be created with the syntax similar to the one used in Java DSL.

"jms:in" errorHandler(deadLetterChannel("jms:error")) to "jms:out"

You can also use different error handler available for the Java DSL. In particular Scala DSL supports DefaultErrorHandler and LoggingErrorHandler.

// DefaultErrorHandler
"jms:in" errorHandler(defaultErrorHandler) to "jms:out"

// LoggingErrorHandler
"jms:in" errorHandler(loggingErrorHandler.level(LoggingLevel.INFO).logName("com.example.MyLogger")) to "jms:out"

Message routing

Aggregator

The aggregator EIP aggregates messages based on some message correlation criteria. In the Scala DSL, the aggregate method takes a function Exchange ⇒ Any

"direct:b" ==> {
  aggregate(_.in[String].substring(0,7), new UseLatestAggregationStrategy()).completionSize(100) {
    to ("mock:b")
  }
}

Content based router

Similar to the Filter , the content based router uses when methods with Exchange ⇒ Boolean function literals and an optional otherwise. The function literal can contain plain Scala code as well as any of the supported languages . The example below routes a given message based on the language of the message body.

"direct:a" ==> {
 to ("mock:polyglot")
 choice {
    when (_.in == "<hello/>") to ("mock:english")
    when (_.in == "<hallo/>") {
      to ("mock:dutch")
      to ("mock:german")
    } 
    otherwise to ("mock:french")
  }
}

Delayer

Unlike a throttler, which only slows down messages if the rate exceeds a treshold, a delayer delays every messages with a fixed amount of time. An example: to delay every message going from seda:a to mock:a

"seda:a" delay(1 seconds) to ("mock:a")

Our second example will delay the entire block (containing mock:c) without doing anything to mock:b

"seda:b" ==> {
  to ("mock:b")
  delay(1 seconds) {
    to ("mock:c")
  }
}

Load balancer

To distribute the message handling load over multiple endpoints, we add a loadbalance to our route definition. You can optionally specify a load balancer strategy, like roundrobin

"direct:a" ==> {
  loadbalance roundrobin {
    to ("mock:a")
    to ("mock:b")
    to ("mock:c")
  }
}

Multicast

Multicast allows you to send a message to multiple endpoints at the same time. In a simple route, you can specify multiple targets in the to or →

"direct:a" --> ("mock:a", "mock:b") --> "mock:c"
"direct:d" to ("mock:d", "mock:e") to "mock:f"

Recipient list

You can handle a static recipient list with a multicast or pipeline , but this EIP is usually applied when you want to dynamically determine the name(s) of the next endpoint(s) to route to. Use the recipients() method with a function literal (Exchange => Any) that returns the endpoint name(s). In the example below, the target endpoint name can be found in the String message starting at position 21.

"direct:a" recipients(_.in[String].substring(21))

Because the recipients()

"direct:b" recipients(_.getIn().getBody() match {
  case Toddler(_) => "mock:playgarden"
  case _ => "mock:work"
})

Again, we can also use the same thing in a more block-like syntax. For this example, we use the Scala DSL's support for JXPath to determine the target.

"direct:c" ==> {
  to("mock:c")
  recipients(jxpath("./in/body/destination"))
}

Resequencer

Use the resequence method to add a resequencer to the RouteBuilder. The method takes a function (Exchange ⇒ Unit) that determines the value to resequence on. In this example, we resequence messages based on the 'in' message body.

"direct:a" resequence (_.in) to "mock:a"

The same EIP can also be used with a block-like syntax...

"direct:b" ==> {
  to ("mock:b")
  resequence (_.in) {
    to ("mock:c")
  }
}

... and with configurable batch size. In this last example, messages will be send to mock:e

"direct:d" ==> {
  to ("mock:d")
  resequence(_.in).batch(5) {
    to ("mock:e")
  }
}

Splitter

To handle large message in smaller chunks, you can write a Scala Exchange ⇒ Any* method and add it to your route with the splitter

"direct:a" as(classOf[Document]) split(xpath("/persons/person")) to "mock:a"

"direct:b" ==> {
  as(classOf[Document])
  split(xpath("/persons/person")) {
    to("mock:b")
    to("mock:c")
  }
}

The above examples also show you how other languages like XPath can be within the Scala DSL.

Throttler

The throttler allows you to slow down messages before sending them along. The throttle

"seda:a" throttle (3 per (2 seconds)) to ("mock:a")

It can also be used in front of block to throttle messages at that point. In the example below, message are passed on to mock:b in a normal rate (i.e. as fast as possible), but a maximum 3 messages/2 seconds will arrive at the mock:c

"seda:b" ==> {
  to ("mock:b")
  throttle (3 per (2 seconds)) {
    to ("mock:c")
  }
}

Message transformation

Content enricher

Using a processor function (Exchange → Unit), you can alter/enrich the message content. This example uses a simple function literal to append " says Hello"

"direct:a" process(_.in += " says hello") to ("mock:a")

However, you can also define a separate method/function to handle the transformation and pass that to the process

val myProcessor = (exchange: Exchange) => {
  exchange.in match {
    case "hello" => exchange.in = "hello from the UK"
    case "hallo" => exchange.in = "hallo vanuit Belgie"
    case "bonjour" => exchange.in = "bonjour de la douce France"
  }
}    

"direct:b" process(myProcessor) to ("mock:b")

Off course, you can also use any other Camel component (e.g. Velocity) to enrich the content and add it to a pipeline

"direct:c" to ("velocity:org/apache/camel/scala/dsl/enricher.vm") to ("mock:c")

Support for other languages inside the Scala DSL routes is delivered through traits. The org.apache.camel.scala.dsl.languages package currently offers traits to support XPath. To use any given language, you can mix-in the trait when creating your RouteBuilder.
You can use any of the supported Camel Languages in the Scala DSL; see below for a couple of examples: 

Using XPath

With the XPath trait, you have an additional method available on an Exchange to do XPath queries against the message. Just look at this Splitter example, where the xpath method is used in a Exchange ⇒ Any* function literal

     
     
      
      "direct:b" ==> {
  as(classOf[Document])
  split(xpath("/persons/person")) {
    to("mock:b")
    to("mock:c")
  }
}

     
     
"direct:c" ==> {
  to("mock:c")
  recipients(jxpath("./in/body/destination"))
}

RouteBuilder builder = new RouteBuilder() {
    public void configure() {
        errorHandler(deadLetterChannel("mock:error"));

        from("direct:a").to("direct:b");
    }
};

from("direct:start").toF("file://%s?fileName=%s", path, name);

fromF("file://%s?include=%s", path, pattern).toF("mock:%s", result);

RouteBuilder builder = new RouteBuilder() {
    public void configure() {
        errorHandler(deadLetterChannel("mock:error"));

        from("direct:a")
            .filter(header("foo").isEqualTo("bar"))
                .to("direct:b");
    }
};

RouteBuilder builder = new RouteBuilder() {
    public void configure() {
        errorHandler(deadLetterChannel("mock:error"));

        from("direct:a")
            .choice()
                .when(header("foo").isEqualTo("bar"))
                    .to("direct:b")
                .when(header("foo").isEqualTo("cheese"))
                    .to("direct:c")
                .otherwise()
                    .to("direct:d");
    }
};

myProcessor = new Processor() {
    public void process(Exchange exchange) {
        log.debug("Called with exchange: " + exchange);
    }
};

RouteBuilder builder = new RouteBuilder() {
    public void configure() {
        errorHandler(deadLetterChannel("mock:error"));

        from("direct:a")
            .process(myProcessor);
    }
};

RouteBuilder builder = new RouteBuilder() {
    public void configure() {
        errorHandler(deadLetterChannel("mock:error"));

        from("direct:a")
            .filter(header("foo").isEqualTo("bar"))
                .process(myProcessor);
    }
};

RouteBuilder builder = new RouteBuilder() {
    public void configure() {
        errorHandler(deadLetterChannel("mock:error"));

        from("direct:a")
            .filter(header("foo").isEqualTo(123))
                .to("direct:b");
    }
};