Brought to you by...

#47 Get More Refcardz! Visit refcardz.com

CONTENTS INCLUDE:

Enterprise Integration Patterns

n
About Enterprise Integration Patterns
n
About Apache Camel
n
Essential Patterns
Conclusions and more...
with Apache Camel
n

By Claus Ibsen
Problem A single event often triggers a sequence of processing steps
About Enterprise Integration Patterns
Solution Use Pipes and Filters to divide a larger processing steps (filters) that are
connected by channels (pipes)
Integration is a hard problem. To help deal with the complexity
Camel Camel supports Pipes and Filters using the pipeline node.
of integration problems the Enterprise Integration Patterns
Java DSL from(“jms:queue:order:in”).pipeline(“direct:transformOrd
(EIP) have become the standard way to describe, document er”, “direct:validateOrder”, “jms:queue:order:process”);
and implement complex integration problems. Hohpe & Where jms represents the JMS component used for consuming JMS messages
on the JMS broker. Direct is used for combining endpoints in a synchronous
Woolf’s book the Enterprise Integration Patterns has become fashion, allow you to divide routes into sub routes and/or reuse common routes.
the bible in the integration space – essential reading for any Tip: Pipeline is the default mode of operation when you specify multiple
integration professional. outputs, so it can be omitted and replaced with the more common node:
from(“jms:queue:order:in”).to(“direct:transformOrder”,
“direct:validateOrder”, “jms:queue:order:process”);
Apache Camel is an open source project for implementing
TIP: You can also separate each step as individual to nodes:
the EIP easily in a few lines of Java code or Spring XML from(“jms:queue:order:in”)
configuration. This reference card, the first in a two card series, .to(“direct:transformOrder”)
.to(“direct:validateOrder”)
guides you through the most common Enterprise Integration .to(“jms:queue:order:process”);
Patterns and gives you examples of how to implement them Spring DSL <route>
<from uri=”jms:queue:order:in”/>
either in Java code or using Spring XML. This Refcard is
www.dzone.com

<pipeline>
<to uri=”direct:transformOrder”/>
targeted for software developers and enterprise architects, but <to uri=”direct:validateOrder”/>
<to uri=”jms:queue:order:process”/>
anyone in the integration space can benefit as well. </pipeline>
</route>
<route>
ABout apache camel <from uri=”jms:queue:order:in”/>
<to uri=”direct:transformOrder”/>
<to uri=”direct:validateOrder”/>
<to uri=”jms:queue:order:process”/>
Apache Camel is a powerful open source integration platform </route>

based on Enterprise Integration Patterns (EIP) with powerful Message Router

Bean Integration. Camel lets you implementing EIP routing How can you deouple indevidual processing steps so that messages can be
using Camels intuitive Domain Specific Language (DSL) passed to different filters depending on a set of conditions?
outQueue 1
based on Java (aka fluent builder) or XML. Camel uses URI for inQueue
endpoint resolution so its very easy to work with any kind of
outQueue 2
transport such as HTTP, REST, JMS, web service, File, FTP, TCP,
Message Router
Mail, JBI, Bean (POJO) and many others. Camel also provides
Enterprise Integration Patterns

Data Formats for various popular formats such as: CSV, EDI, Problem Pipes and Filters route each message in the same processing steps. How can we
route messages differently?
FIX, HL7, JAXB, Json, Xstream. Camel is an integration API that
Solution Filter using predicates to choose the right output destination.
can be embedded in any server of choice such as: J2EE Server,
Camel Camel supports Message Router using the choice node. For more details see the
ActiveMQ, Tomcat, OSGi, or as standalone. Camels Bean Content Based router pattern.
Integration let you define loose coupling allowing you to fully
separate your business logic from the integration logic. Camel
Are you using Apache Camel, Apache ActiveMQ,
is based on a modular architecture allowing you to plugin your
Apache ServiceMix, or Apache CXF?
own component or data format, so they seamlessly blend in
with existing modules. Camel provides a test kit for unit and Progress FUSE products are Apache-licensed,
integration testing with strong mock and assertion capabilities. certified releases based on these Apache SOA
projects.
Essential Patterns
 Synchronized with Apache projects
This group consists of the most essential patterns that anyone  Enterprise support by Apache committers
working with integration must know.  Online and on-site training
Pipes and Filters
Register for a FREE webinar & learn
How can we perform complex processing on a message while maintaining how to build & deploy integration
independence and flexibility? flows, web services & RESTful
services with Apache Camel, Apache
Pipe Pipe Pipe Pipe CXF, and Apache ServiceMix
Decrypt Authenticate De-Dup

Incoming Filter Filter Filter ‘Clean’

Click here to register
Order Order

DZone, Inc. | www.dzone.com

 2
Enterprise Integration Patterns

Content-Based Router Camel Camel supports the message translator using the processor, bean or
transform nodes.
How do we handle a situation where the implementation of a single logical
function (e.g., inventory check) is spread across multiple physical systems?
TIP: Camel routes the message as a chain of processor nodes.

Java DSL Processor


Widget
public class OrderTransformProcessor
Inventory
implements Processor {
public void process(Exchange exchange)
throws
Exception {
Gadget // do message translation here
New Order Router Inventory 
 }

}

Problem How do we ensure a Message is sent to the correct recipient based on from(“direct:transformOrder”)
information from its content? .process(new OrderTransformProcessor());

Solution Use a Content-Based Router to route each message to the correct recipient Bean
based on the message content. Instead of the processor we can use Bean (POJO). An advantage of using a
Bean over Processor is the fact that we do not have to implement or use any
Camel Camel has extensive support for Content-Based Routing. Camel supports Camel specific interfaces or types. This allows you to fully decouple your beans
content based routing based on choice, filter, or any other expression. from Camel.
Java DSL Choice
 public class OrderTransformerBean {
from(“jms:queue:order”) public StringtransformOrder(String body) {
.choice() 
 // do message translation here
.when(header(“type”).in(“widget”,“wiggy”)) 
 }

.to(“jms:queue:order:widget”) }
.when(header(“type”).isEqualTo(“gadget”))
.to(“jms:queue:order:gadget”) Object transformer = new OrderTransformerBean();
.otherwise().to(“jms:queue:order:misc”) from(“direct:transformOrder”).bean(transformer);
.end();
TIP: In the route above end() can be omitted as its the last node and we do not TIP: Camel can create an instance of the bean automatically; you can just refer
route the message to a new destination after the choice. to the class type.
TIP: You can continue routing after the choice ends.
from(“direct:transformOrder”)
Spring Choice .bean(OrderTransformerBean.class);
DSL <route>

<from uri=”jms:queue:order”/>
 TIP: Camel will try to figure out which method to invoke on the bean in
<choice> case there are multiple methods. In case of ambiguity you can specify which
<when> methods to invoke by the method parameter:

<simple>${header.type} in ‘widget,wiggy’</simple>

<to uri=”jms:queue:order:widget”/>
 from(“direct:transformOrder”)
</when> .bean(OrderTransformerBean.class, “transformOrder”);
<when>
<simple>${header.type} == ‘gadget’</simple> Transform
<to uri=”jms:queue:order:gadget”/>
 Transform is a particular processor allowing you to set a response to be
</when>
 returned to the original caller. We use transform to return a constant ACK
<otherwise>
 response to the TCP listener after we have copied the message to the JMS
<to uri=”jms:queue:order:misc”/>
 queue. Notice we use a constant to build an “ACK” string as response.
</otherwise>
</choice> from(“mina:tcp://localhost:8888?textline=true”)
</route> .to(“jms:queue:order:in”)

.transform(constant(“ACK”));
TIP: In Spring DSL you cannot invoke code, as opposed to the Java DSL that is
100% Java. To express the predicates for the choices we need to use a language.
We will use simple language that uses a simple expression parser that supports Spring DSL Processor
a limited set of operators. You can use any of the more powerful languages <route>
supported in Camel such as: JavaScript, Groovy, Unified EL and many others. <from uri=”direct:transformOrder”/>

<process ref=”transformer”/>

TIP: You can also use a method call to invoke a method on a bean to evaluate the </route>
predicate. Lets try that:

<bean id=”transformer” class=”com.mycompany.
<when> OrderTransformProcessor”/>
<method bean=”myBean” method=”isGadget”/>

... In Spring DSL Camel will look up the processor or POJO/Bean in the registry
</when> based on the id of the bean.

Bean
<bean id=”myBean” class=”com.mycomapany.MyBean”/>
 <route>
<from uri=”direct:transformOrder”/>
public boolean isGadget(@Header(name = “type”) String <bean ref=”transformer”/>

type) {
 </route>
return type.equals(“Gadget”);

} <bean id=”tramsformer”
Notice how we use Bean Parameter Binding to instruct Camel to invoke this class=”com.mycompany.OrderTransformBean”/>
method and pass in the type header as the String parameter. This allows your
Transform
code to be fully decoupled from any Camel API so its easy to read, write and
<route>
unit test.
<from uri=”mina:tcp://localhost:8888?textline=true”/>
<to uri=”jms:queue:order:in”/>

Message Translator <transform>
<constant>ACK</constant>

How can systems using different data formats communicate with each other </transform>
using messaging? </route>

Translator Annotation You can also use the @Consume annotation for transformations. For
DSL example in the method below we consume from a JMS queue and do
the transformation in regular Java code. Notice that the input and output
parameters of the method is String. Camel will automatically coerce the
payload to the expected type defined by the method. Since this is a JMS
example the response will be sent back to the JMS reply-to destination.

Incoming Message Translated Message @Consume(uri=”jms:queue:order:transform”)


public String transformOrder(String body) {

 // do message translation
Problem Each application uses its own data format, so we need to translate the }
message into the data format the application supports.
TIP: You can use Bean Parameter Binding to help Camel coerce the Message
Solution Use a special filter, a messae translator, between filters or applications to into the method parameters. For instance you can use @Body, @Headers
translate one data format into another. parameter annotations to bind parameters to the body and headers.

DZone, Inc. | www.dzone.com

 3
Enterprise Integration Patterns

Message Filter Annotation TIP: Notice how we used Bean Parameter Binding to bind the parameters to
DSL, the route method based on an @XPath expression on the XML payload of the
How can a component avoid receiving unwanted messages? continued JMS message. This allows us to extract the customer id as a string parameter.
@Header wil bind a JMS property with the key location. Document is the XML
payload of the JMS message.

TIP: Camel uses its strong type converter feature to convert the payload to the
type of the method parameter. We could use String and Camel will convert
the body to a String instead. You can register your own type converters as well
Widget Gadget Widget Message Widget Widget using the @Converter annotation at the class and method level.
Quote Quote Quote Filter Quote Quote

Problem How do you discard unwanted messages?

Recipient List
How do we route a message to a list of statically or dynamically specified
Solution Use a special kind of Message Router, a Message Filter, to eliminate undesired recipients?
messages from a channel based on a set of criteria.
Recipient Channel
Camel Camel has support for Message Filter using the filter node. The filter evaluates
a predicate whether its true or false; only allowing the true condition to pass the A
filter, where as the false condition will silently be ignored.
B
Java DSL We want to discard any test messages so we only route non-test messages to the
order queue.
C
from(“jms:queue:inbox”) Recipient
.filter(header(“test”).isNotEqualTo(“true”))
 List D
.to(“jms:queue:order”);

Spring For the Spring DSL we use XPath to evaluate the predicate. The $test is a special Problem How can we route messages based on a static or dynamic list of
DSL shorthand in Camel to refer to the header with the given name. So even if the destinations?
payload is not XML based we can still use XPath to evaluate predicates.
Solution Define a channel for each recipient. Then use a Recipient List to inspect an
<route> incoming message, determine the list of desired recipients and forward the
<from uri=”jms:queue:inbox”/> message to all channels associated with the recipients in the list.
<filter>
<xpath>$test = ‘false’</xpath> Camel Camel supports the static Recipient List using the multicast node, and the
<to uri=”jms:queue:inbox”/> dynamic Recipient List using the recipientList node.
</filter>
</route> Java DSL Static
In this route we route to a static list of two recipients, that will receive a copy
Dynamic Router of the same message simultaneously.
from(“jms:queue:inbox”)
How can you avoid the dependency of the router on all possible destinations .multicast().to(“file://backup”, “seda:inbox”);
while maintaining its efficiency?
Dynamic
Dynamic Router Output Channel In this route we route to a dynamic list of recipients defined in the message
A header [mails] containing a list of recipients as endpoint URLs. The bean
Message Router processMails is used to add the header[mails] to the message.
Input Channel Output Channel
from(“seda:confirmMails”).beanRef(processMails)
B .recipientList(“destinations”);
Output Channel And in the process mails bean we use @Headers Bean Parameter Binding to
provide a java.util.Map to store the recipients.
C public void confirm(@Headers Map headers, @Body String
body} {
Dynamic 
 String[] recipients = ...
Rule Base 
 headers.put(“destinations”, recipients);

}
Control Channel
Spring DSL Static
Problem How can we route messages based on a dynamic list of destinations? <route>
<from uri=”jms:queue:inbox/>

Solution Use a Dynamic Router, a router that can self-configure based on special
<multicast>
configuration messages from participating destinations.
<to uri=”file://backup”/>

Camel Camel has support for Dynamic Router using the Dynamic Recipient List <to uri=”seda:inbox”/>
combined with a data store holding the list of destinations. </multicast>
</route>
Java DSL We use a Processor as the dynamic router to determine the destinations. We
could also have used a Bean instead. Dynamic
from(“jms:queue:order”) In this example we invoke a method call on a Bean to provide the dynamic
.processRef(myDynamicRouter)
 list of recipients.
.recipientList(“destinations”); <route>

<from uri=”jms:queue:inbox/>

public class MyDynamicRouter implements Processor { <recipientList>
public void process(Exchange exchange) {
 <method bean=”myDynamicRouter” method=”route”/>
// query a data store to find the best match of the </recipientList>
// endpoint and return the destination(s) in the </route>
// header exchange.getIn()
// .setHeader(“destinations”, list); <bean id=”myDynamicRouter”

 }
 class=”com.mycompany.MyDynamicRouter”/>
} public class myDynamicRouter {
public String[] route(String body) {
Spring DSL <route> return new String[] { “file://backup”, .... }

<from uri=”jms:queue:order”/> }
<process ref=”myDynamicRouter”/>
 }
<recipientList>
<header>destinations</destinations> Annotation In the CustomerService class we annoate the whereTo method with
</recipientList> DSL @RecipientList, and return a single destination based on the customer id.
</route> Notice the flexibility of Camel as it can adapt accordingly to how you define
what your methods are returning: a single element, a list, an iterator, etc.
Annotation public class MyDynamicRouter {
DSL @Consume(uri = “jms:queue:order”) public class CustomerService {
@RecipientList @RecipientList
public List<String> route(@XPath(“/customer/id”) public String whereTo(@Header(“customerId”) id) {
String customerId, @Header(“location”) String location, return “jms:queue:customer:” + id;
Document body) { }

// query data store, find best match for the }
//endpoint and return destination (s) And then we can route to the bean and it will act as a dynamic recipient list.

 } from(“jms:queue:inbox”)
} .bean(CustomerService.class, “whereTo”);

DZone, Inc. | www.dzone.com

 4
Enterprise Integration Patterns

Splitter Java Stock quote example

DSL We want to update a website every five minutes with the latest stock quotes. The
How can we process a message if it contains multiple elements, each of which quotes are received on a JMS topic. As we can receive multiple quotes for the
may have to be processed in a different way? same stock within this time period we only want to keep the last one as its the
most up to date. We can do this with the aggregator:
from(“jms:topic:stock:quote”)
.aggregate().xpath(“/quote/@symbol”)
.batchTimeout(5 * 60 * 1000).to(“seda:quotes”);
As the correlation expression we use XPath to fetch the stock symbol from the
Order Order Order message body. As the aggregation strategy we use the default provided by
New Order Splitter Item 1 Item 2 Item 3 Camel that picks the latest message, and thus also the most up to date. The time
period is set as a timeout value in milliseconds.
Loan broker example
Problem How can we split a single message into pieces to be routed individually? We aggregate responses from various banks for their quote for a given loan
request. We want to pick the bank with the best quote (the cheapest loan),
Solution Use a Splitter to break out the composite message into a series of individual therefore we need to base our aggregation strategy to pick the best quote.
messages, each containing data related to one item.
from(“jms:topic:loan:quote”)
Camel Camel has support for Splitter using the split node. .aggregate().header(“loanId”)
.aggregationStrategy(bestQuote)
Java DSL In this route we consume files from the inbox folder. Each file is then split into .completionPredicate(header(Exchange.AGGREGATED_SIZE)
a new message. We use a tokenizer to split the file content line by line based .isGreaterThan(2))
on line breaks. .to(“seda:bestLoanQuote”);
from(“file://inbox”)
.split(body().tokenize(“\n”)) We use a completion predicate that signals when we have received more than 2
.to(“seda:orderLines”); quotes for a given loan, giving us at least 3 quotes to pick among. The following
shows the code snippet for the aggregation strategy we must implement to pick
TIP: Camel also supports splitting streams using the streaming node. We can the best quote:
split the stream by using a comma: public class BestQuoteStrategy implements
.split(body().tokenize(“,”)).streaming().to(“seda:parts”); AggregationStrategy {
public Exchange aggregate(Exchange oldExchange,
TIP: In the routes above each individual split message will be executed in
Exchange newExchange) {
sequence. Camel also supports parallel execution using the parallelProcessing
double oldQuote = oldExchange.getIn().getBody(Double.
node.
class);
.split(body().tokenize(“,”)).streaming() 
 double newQuote = newExchange.getIn().getBody(Double.
.parallelProcessing().to(“seda:parts”); class);
// return the “winner” that has the lowest quote
Spring DSL In this route we use XPath to split XML payloads received on the JMS order 
 return newQuote < oldQuote ? newExchange : oldExchange;
queue. 
 }

<route> }
<from uri=”jms:queue:order”/>
<split> Spring Loan Broker Example
<xpath>/invoice/lineItems</xpath> DSL <route>
<to uri=”seda:processOrderLine”/> <from uri=”jms:topic:loan:qoute”/>
</split>
 <aggregate strategyRef=”bestQuote”>
</route> <correlationExpression>
<header>loanId</header>
And in this route we split the messages using a regular expression </correlationExpression>
<route> <completionPredicate>
<from uri=”jms:queue:order”/> <simple>${header.CamelAggregatedSize} > 2</simple>
<split> </completionPredicate>
<tokenizer token=”([A-Z|0-9]*);” regex=”true”/> </aggregate>
<to uri=”seda:processOrderLine”/> <to uri=”seda:bestLoanQuote”/>
</split> </route>
</route>
<bean id=”bestQuote”
TIP: Split evaluates an org.apahce.camel.Expression to provide class=”com.mycompany.BestQuoteStrategy”/>
something that is iterable to produce each individual new message. This allows TIP: We use the simple language to declare the completion predicate. Simple
you to provide any kind of expression such as a Bean invoked as a method call. is a basic language that supports a primitive set of operators. ${header.
<split> CamelAggregatedSize} will fetch a header holding the number of messages
<method bean=”mySplitter” method=”splitMe”/> aggregated.
<to uri=”seda:processOrderLine”/>
</split>
TIP: If the completed predicate is more complex we can use a method call to
<bean id=”mySplitter” class=”com.mycompany.MySplitter”/> invoke a Bean so we can do the evaluation in pure Java code:
public List splitMe(String body) { <completionPredicate>
// split using java code and return a List <method bean=”quoteService” method=”isComplete”/>
List parts = ... </compledtionPrediacate>
return parts;
public boolean isComplete(@Header(Exchange.AGGREGATED_SIZE)
}
int count, String body) {

 return body.equals(“STOP”);

Aggregator }

How do we combine the results of individual, but related messages so that they Notice how we can use Bean Binding Parameter to get hold of the aggregation
can be processed as a whole? size as a parameter, instead of looking it up in the message.

Resequencer
How can we get a stream of related but out-of-sequence messages back into the
Inventory Inventory correct order?
Inventory
Item 1 Item 2 Item 3 Inventory
Aggregator Order

Problem How do we combine multiple messages into a single combined message?

Solution Use a stateful filter, an Aggregator, to collect and store individual messages until it
receives a complete set of related messages to be published.
Resequencer
Camel Camel has support for the Aggregator using the aggregate node. Camel uses a
stateful batch processor that is capable of aggregating related messaged into a Problem How do we ensure ordering of messages?
single combined message. A correlation expression is used to determine which
messages should be aggregated. An aggregation strategy is used to combine Solution Use a stateful filter, a Resequencer, to collect and reorder messages so that they
aggregated messages into the result message. Camel’s aggregator also supports can be published in a specified order.
a completion predicate allowing you to signal when the aggregation is complete.
Camel also supports other completion signals based on timeout and/or a number Camel Camel has support for the Resequencer using the resequence node. Camel uses
of messages already aggregated. a stateful batch processor that is capable of reordering related messages. Camel

DZone, Inc. | www.dzone.com

 5
Enterprise Integration Patterns

Camel, supports two resequencing algorithms: Java Global scope

continued DSL errorHandler(deadLetterChannel(“jms:queue:error”)
- batch = collects messages into a batch, sorts the messages and publish the
.maximumRedeliveries(3));

messages
- stream = re-orders, continuously, message streams based on detection of gaps
from(...)
between messages.
Route scope
Batch is similar to the aggregator but with sorting. Stream is the traditional
from(“jms:queue:event”)
Resequencer pattern with gap detection. Stream requires usage of number
.errorHandler(deadLetterChannel()
(longs) as sequencer numbers, enforced by the gap detection, as it must be able
.maximumRedeliveries(5))
to compute if gaps exist. A gap is detected if a number in a series is missing, e.g.
.multicast().to(“log:event”, “seda:handleEvent”);
3, 4, 6 with number 5 missing. Camel will back off the messages until number 5
arrives. In this route we override the global scope to use up to five redeliveries, where
as the global only has three. You can of course also set a different error queue
Java DSL Batch: destination:
We want to process received stock quotes, once a minute, ordered by their stock
symbol. We use XPath as the expression to select the stock symbol, as the value deadLetterChannel(“log:badEvent”).maximumRedeliveries(5)
used for sorting.
from(“jms:topic:stock:quote”) Spring The error handler is configured very differently in the Java DSL vs. the Spring DSL.
.resequence().xpath(“/quote/@symbol”) DSL The Spring DSL relies more on standard Spring bean configuration whereas the
.timeout(60 * 1000) Java DSL uses fluent builders.
.to(“seda:quotes”); Global scope
Camel will default the order to ascending. You can provide your own comparison The Global scope error handler is configured using the errorHandlerRef attribute
for sorting if needed. on the camelContext tag.

<camelContext errorHandlerRef=”myDeadLetterChannel”>
Stream:
...

Suppose we continuously poll a file directory for inventory updates, and its
</camelContext>
important they are processed in sequence by their inventory id. To do this we
enable streaming and use one hour as the timeout. Route scope
Route scoped is configured using the errorHandlerRef attribute on the route tag.
from(“file://inventory”)
<route errorHandlerRef=”myDeadLetterChannel”>
.resequence().xpath(“/inventory/@id”)
...

.stream().timeout(60 * 60 * 1000)
</route>
.to(“seda:inventoryUpdates”);
For both the error handler itself is configured using a regular Spring bean
Spring Batch: <bean id=”myDeadLetterChannel” class=”org.apache.camel.
DSL <route> builder.DeadLetterChannelBuilder”>
<from uri=”jms:topic:stock:quote”/> <property name=”deadLetterUri” value=”jms:queue:error”/>
<resequence> <property name=”redeliveryPolicy”
<xpath>/quote/@symbol</xpath> ref=”myRedeliveryPolicy”/>
<batch-config batchTimeout=”60000”/> </bean>
</resequence>
<bean id=”myRedeliverPolicy”
<to uri=”seda:quotes”/>
class=”org.apache.camel.processor.RedeliverPolicy”>
</route>
<property name=”maximumRedeliveries” value=”5”/>
Stream: 
 <property name=”delay” value=”5000”/>
<route> </bean>
<from uri=”file://inventory”/>
<resequence>
<xpath>/inventory/@id</xpath>
<stream-config timeout=”3600000”/>
</resequence>
<to uri=”seda:quotes”/> Wire Tap
</route>
How do you inspect messages that travel on a point-to-point channel?
Notice that you can enable streaming by specifying <stream-config> instead
of <batch-config>.

Dead Letter Channel Source Destination

What will the messaging system do with a message it cannot deliver?

Delivery Fails

Problem How do you tap messages while they are routed?

Sender Message Channel Intended Solution Insert a Wire Tap into the channel, that publishes each incoming message to the
Receiver main channel as well as to a secondary channel.

Camel Camel has support for Wire Tap using the wireTap node, that supports two
Reroute Delivery modes: traditional and new message. The traditional mode sends a copy of the
original message, as opposed to sending a new message. All messages are sent
as Event Message and runs in parallel with the original message.

Dead Dead Letter

Message Channel Java Traditional
DSL The route uses the traditional mode to send a copy of the original message to the
seda tapped queue, while the original message is routed to its destination, the
Problem The messaging system cannot deliver a message process order bean.
Solution When a message cannot be delivered it should be moved to a Dead Letter from(“jms:queue:order”)
Channel .wireTap(“seda:tappedOrder”)

 .to(“bean:processOrder”);
Camel Camel has extensive support for Dead Letter Channel by its error handler and
exception clauses. Error handler supports redelivery policies to decide how many New message
times to try redelivering a message, before moving it to a Dead Letter Channel. In this route we tap the high priority orders and send a new message containing
a body with the from part of the order.
Tip: As Camel uses an Expression for
The default Dead Letter Channel will log the message at ERROR level and
evaluation you can use other functions than xpath, for instance to send a fixed
perform up to 6 redeliveries using a one second delay before each retry.
String you can use constant.
Error handler has two scopes: global and per route
TIP: See Exception Clause in the Camel documentation for selective interception from(“jms:queue:order”)
of thrown exception. This allows you to route certain exceptions differently or even .choice()
reset the failure by marking it as handled. 
 .when(“/order/priority = ‘high’”)

.wireTap(“seda:from”, xpath(“/order/from”))
TIP: DeadLetterChannel supports processing the message before it gets 
 .to(“bean:processHighOrder”);
redelivered using onRedelivery. This allows you to alter the message beforehand 
 .otherwise()
(i.e. to set any custom headers). 
 .to(“bean:processOrder”);

DZone, Inc. | www.dzone.com

 6
Enterprise Integration Patterns

Spring Traditional
DSL <route> Conclusion
<from uri=”jms:queue:order”/>
<wireTap uri=”seda:tappedOrder”/> The twelve patterns in this Refcard cover the most used
<to uri=”bean:processOrder”/>

</route>
patterns in the integration space, together with two of the
most complex such as the Aggregator and the Dead Letter
New Message
<route> Channel. In the second part of this series we will take a further
<choice> look at common patterns and transations.
<when>
<xpath>/order/priority = ‘high’</xpath> Get More Information
<wireTap uri=”seda:from”>
Camel Website The home of the Apache Camel project. Find downloads,
<body><xpath>/order/from</xpath></body> tutorials, examples, getting started guides, issue tracker,
</wireTap> http://camel.apache.org
roadmap, mailing lists, irc chat rooms, and how to get
<to uri=”bean:processHighOrder”/> help.
</when>
<otherwise> FuseSource Website The home of the FuseSource company, the professional
company behind Apache Camel with enterprise offerings,
<to uri=”bean:processOrder”/> http://fusesource.com
support, consulting and training.
</otherwise>
</choice> About Author The personal blog of the author of this reference card.
</route> http://davsclaus.blogspot.com

A BOUT TH E A UTHOR R E C OMM E N D E D BOO K

Claus Ibsen is a passionate open-source Utilizing years of practical experience,
enthusiast who specializes in the integration seasoned experts Gregor Hohpe and
space. As an engineer in the Progress FUSE Bobby Woolf show how asynchronous
open source team he works full time on messaging has proven to be the best
Apache Camel, FUSE Mediation Router strategy for enterprise integration
(based on Apache Camel) and related success. However, building and deploying
projects. Claus is very active in the Apache messaging solutions presents a number
Camel and FUSE communities, writing blogs, twittering, of problems for developers. Enterprise
assisting on the forums irc channels and is driving the Integration Patterns provides an
Apache Camel roadmap. invaluable catalog of sixty-five patterns,
with real-world solutions that demonstrate the formidable of
A BOUT P r o g r e s s f u s e messaging and help you to design effective messaging solutions
FUSE products are standards-based, open source for your enterprise.
enterprise integration tools based on Apache SOA
projects, and are productized and supported by the BUY NOW
people who wrote the code. books.dzone.com/books/enterprise-integration-patterns

Bro
ugh
t to
you
by...
Professional Cheat Sheets You Can Trust
tt erns “Exactly what busy developers need:
n Pa
ld
ona

sig son
McD
simple, short, and to the point.”
De
Ja
By

#8
ired
Insp e
by th
GoF ller con
tinu
ed
ndle
r doe
sn’t
have
to

James Ward, Adobe Systems

ity,
r
E: e ha ndle
d th
LUD Best
se
ns ibil st an ith th
e ha

Upcoming Titles Most Popular

IN C que st w
ility spo
re
TS e le a req
ue
ome.
EN nsib
of R
nd le a
ay ha outc
NT spo sm hand tial hen
an
CO f Re in ject le to oten
Cha
o . le p .W
le ob bject be ab tern ethod
m

in tab
Cha d ultip ecific o should cep pat
this if the m up the
man
n M
an ac
z.co

n
sp s ents
be a ject ime. d is see passed

Download Now
Com reter of ob at runt handle plem ks to de to

RichFaces Spring Configuration

n
Use se t im ec b e co
rp
n A ined ges ch ld til t
Inte Whe
n
erm being ngua ime shou peats un paren
not e la the runt or if it
tor det s re ore
a rd

...
n
uest som tion proces e no m
Itera tor ore req
n A g in metho
d
cep
dm ndlin
e e ar

Agile Software Development jQuery Selectors

dia e ex ack th
n
a ther
Me rver d an the n ha rown in ndle th ll st until
re f c

tho e to ptio th
Exce ion is sm to ha up th tered or
e ca
n

Ob
se Me S renc ral

Refcardz.com
plate RN refe listed in mp
le ce pt ni
echa n pa ssed co un avio
Beh
TTE
n
ex
is en
ick
BIRT Windows Powershell
am
Tem Exa he .
A s has ack. W tion uest to ject
NP a qu s, a ct- cep Ob
it

n
st q
IG e s e rn b je call e ex e re
vid patt able O le th nd th
DES
! V is

pro s, hand s to ha
UT ard ign us ram .
des diag
JSF 2.0 Dependency Injection with EJB 3
ct
ABO refc oF) f Re le obje
erns ts o lass exa
mp oke
r
Patt ur (G lemen es c Inv
arz

n F o d rl d h
Des
ig go
f s: E inclu al w
o suc
Th is G a n
l 23 sign Pa
tt e rn e rn
patt , and a
re je ts
t ob mentin
c g AN
D
Adobe AIR Netbeans IDE JavaEditor
c

a h c M M
ef

in c u
orig kD
e
re.
Ea tion ons
tr ple CO ma
nd
boo Softwa rma to c their im om
BPM&BPMN Getting Started with Eclipse
re R

the info ed Clie

nt
cre
teC
d
ente on, us
age : Us d from Con nd
Ori r ns ct () ma
ti atte uple bje cute Com )
lana al P e deco eo +exe
Flex 3 Components Very First Steps in Flex
s
Mo

( low
e x p o n la rg cute is al ch
ati an b rm ts. +exe . Th
bject nship
s su
Cre y c fo je c an o
t th
e
ed
to ob ms, d as ed rela
tio
Get

tha : Us arate rith eate as

s te m.
tt e r ns n y disp
g e algo je c ts. e r
be tr ject b
it to lly ob
sy Pa a b g
ana
iv
ral en m en o Rece
win
allo traditi
ona
to m betwe
s.
ctu twe sed
uest
req ndled in nt or
der
Stru s be
stru
cture ttern
l Pa d respo
s: U
nsib
ilitie
s

nsh
ips
that
can psu
Enca quest
the
re
late
sa

and
e ha
to b llbacks
ca
.

nalit
y.
riant
times
or in
varia

ling
the
invo
catio

ing
n.
DZone, Inc. ISBN-13: 978-1-934238-50-9
ra o pose uing nctio led at va hand
io n ti ct cess be
av ,a la P ur
as q
ue
ack
fu je pro
Beh nships t re
1251 NW Maynard
ob

rela
tio
with
ob je c
s th
at c
a n b e
ed
You ne s need
st
callb
to
que
b
nd
e ha eded.
ne
sts is couple n
d fro m the

e th
ynch
e as the fu
ro nous nality
nctio
itho
to
y ne
ut an is
ed
ISBN-10: 1-934238-50-3
eals
it
ship Reque y of re de ar
ld be litat pattern ssing w tation articul
e: D tion faci

50795
or
e. Use
n

A hist shou d ce en p
ed to mman for pro implem ents its ting.
cop runtim rela type
ker
Cary, NC 27513
n
S s Whe invo y us
n
s co al m pec
jec t at cla Pro
to Th e
w id el th e ue ue
ac tu
d im
p le ex
are utilizing a job q of the ue is
Ob ged with
n
C ues ueue e que
han eals me.
y dge enq
que s. B en to th
e c : D P roxy Job orithm be giv knowle that is terface
b e ti
cop
g n ct
pile r S in
rato er mp
le of al ed ca to have d obje of the
ss S at com serv
888.678.0399
Exa ut
Deco nes
an
.com

Ob exec e queue comm

Cla d S B th e confi
nge de leto
n for
king
. Th
ithin
the
cha tory Faca od Sing invo hm w

DZone communities deliver over 4 million pages each month to ract

Fac S
Meth C algo
rit

919.678.0300
one

Abst tory
C C
Fac
B
State
t
pte
r eigh y
teg
Ada Flyw Stra od
z

Meth
more than 2 million software developers, architects and decision
S S r B
w. d

e rp rete plate
ridg
Refcardz Feedback Welcome
B B
Inte Tem
S B
er tor or
ww

Build Itera Visit

$7.95

C B r B

makers. DZone offers something for everyone, including news, diato

f
in o ral
[email protected]
ty Me
Cha nsibili avio
B o B
ento Beh
Resp m ject
d Me Ob
m man B

tutorials, cheatsheets, blogs, feature articles, source code and more.

C o

NSIB
ILIT
Y B

S
Com
po si te

P O succ
ess
or Sponsorship Opportunities 9 781934 238509
RES
“DZone is a developer’s dream,” says PC Magazine.
F
CH
AIN
O
ace
>> [email protected]
terf r
<<in andle
H st ( )

Copyright © 2009 DZone, Inc. All rights reserved.

Clie
nt
No part of this publication
dle
r2
d lere
que
may be reproduced, stored in a retrieval system, or transmitted, in any form or by means electronic, mechanical,
+ha
n
Version 1.0
Han
photocopying, or otherwise, without prior written permission Cof the
oncr
ete publisher.
que
st ( ) Reference: Enterprise Integration Patterns, Gregor Hohpe, Addison-Wesley, 2003
s

re
ndle
+ha
ern

1 ki ng
ler by lin .c o
m
and uest one
teH req z
cre () le a w.d
Con uest hand | ww