Red Hat SummitChapter 5. Adding a Content-Based Router
This tutorial shows how to add a Content-Based Router (CBR) and logging to a route.
A CBR routes a message to a destination based on its content. In this tutorial, the CBR that you create routes messages to different folders based on the value of each message’s quantity field (the number of animals in the order). The maximum value of animals for each order is 10. The CBR routes the messages to different folders, depending on whether the quantity is greater than 10.
Goals
In this tutorial you complete the following tasks:
- Add a Content-Based Router to your route
Configure the Content-Based Router:
- Add a log endpoint to each output branch of the content-based router
- Add a Set Header EIP after each log endpoint
- Add an Otherwise branch to the content-based router
Prerequisites
To start this tutorial, you need the ZooOrderApp project resulting from one of the following:
Completing the Chapter 4, Running a Route tutorial.
or
-
Completing the Chapter 2, Setting up your environment tutorial and replacing your project’s
blueprint.xmlfile with the providedblueprintContexts/blueprint1.xmlfile, as described in the section called “About the resource files”.
Adding and configuring a Content-Based Router
To add and configure a Content-Based Router for your route:
-
In Project Explorer, double-click
ZooOrderApp/src/main/resources/OSGI-INF/blueprint/blueprint.xmlto open it in the Editor view. -
On the Design canvas, select the
To_Receivednode and then select the trash can icon to delete it. In the Palette, open the Routing drawer and drag a Choice (
) pattern to the canvas and drop it in the Route_route1container.The
Route_route1container expands to accommodate theChoice_choice1node. The error icon indicates that theChoice_choice1node requires a child node, which you add next.From the Routing drawer, drag a When (
) pattern to the canvas and drop it on the Choice_choice1node:The
Choice_choice1container expands to accommodate theWhen_when1node. The
decorating the When_when1node indicates that one or more required property values must be set.NoteThe tooling prevents you from dropping a pattern onto an invalid drop point in a Route container.
On the canvas, select the
When_when1node, to open its properties in the Properties view:-
Click the
button in the Language field to open the list of available languages.
Select xpath (for the XML query language) because the test messages are written in XML.
NoteOnce you select the expression Language, the Properties view displays its properties in an indented list directly below the Language field. The Id property in this list sets the ID of the expression. The Id property following the Description field sets the ID of the
Whennode.In the Expression field, type:
/order/orderline/quantity/text() > 10This expression specifies that only messages in which the value of the quantity field is greater than 10 travel this path in the route (to the invalidOrders folder).
Leave each of the remaining properties as they are.
NoteEnabling Trim removes any leading or trailing white spaces and line breaks from the message.
In the
Route_route1container, select theFrom_from1node and drag its connector arrow over theChoice_choice1node, then release it:-
On the menu bar, click File
Save to save the routing context file. Click the Source tab to view the XML for the route:
Adding and configuring logging
Adding logging to a route allows you to track the activity of the route.
To add logging to your CBR route:
-
In the Palette, open the Components drawer and select a Log (
) component.
Drag the Log component to the canvas and drop it on the
When_when1node.The
When_when1container expands to accommodate theLog_log1node:-
On the canvas, select the
Log_log1node to open its properties in the Properties view. In the Message field, type:
The quantity requested exceeds the maximum allowed - contact customer.
Leave each of the remaining properties as they are.
+
The tooling auto-generates a log node id value. In the Fuse Integration perspective’s Messages view, the tooling inserts the contents of the log node’s Id field in the Trace Node Id column for message instances, when tracing is enabled on the route (see the Chapter 8, Tracing a message through a route tutorial). In the Console, it adds the contents of the log node’s Message field to the log data whenever the route runs.
-
On the menu bar, click File
Save to save the routing context file.
Adding and configuring message headers
A message header contains information to process a message.
To add and configure message headers:
-
In the Palette, open the Transformation drawer and select a Set Header (
) pattern.
Drag the Set Header pattern to the canvas and drop it in the
When_when1container.The
When_when1container expands to accommodate theSetHeader_setHeader1node.On the canvas, select the
Log_log1node and drag its connector arrow over theSetHeader_setHeader1node, and then release it:On the canvas, select the
SetHeader_setHeader1node to open its properties in the Properties view:-
Click the
button in the Language field to open the list of available languages, and select constant:
-
In the Expression field, type
Invalid. -
In the Header Name field, type
Destination. Leave each of the remaining properties as they are.
-
In the Palette, open the Components drawer and select the File (
) component.
Drag the File component to the canvas and drop it in the
When_when1container.The
When_when1container expands to accommodate theTo_to1node.On the canvas, select the
SetHeader_setHeader1node and drag its connector arrow over theTo_to1node, and then release it:On the canvas, select the
To_to1node to open its properties in the Properties view:On the Details tab, replace directoryName with
target/messages/invalidOrdersin the Uri field, and type_Invalidin the Id field:-
On the menu bar, click File
Save to save the routing context file. Click the Source tab to view the XML for the route:
Adding and configuring a branch to handle valid orders
So far, the CBR handles messages that contain invalid orders.
To add and configure an otherwise branch of your route to handle valid orders:
-
In the Palette, open the Routing drawer and select the Otherwise (
) pattern.
Drag the Otherwise pattern to the canvas and drop it into the
Choice_choice1container:The
Choice_choice1container expands to accommodate theOtherwise_otherwise1node.-
On the canvas, select the
Otherwise_otherwise1node to open its properties in the Properties view. In the Id field, type
_elseValid:NoteThe
elseValidnode will route to the terminalfilenode (file:target/messages/validOrders) any message that does not match the XPath expression set for theWhen_when1node.-
In the Palette, open the Components drawer and select the Log (
) component.
Drag the Log component to the canvas and drop it on the
Otherwise_elseValidnode:The
Otherwise-elseValidcontainer expands to accommodate theLog_log2node.-
On the canvas, select the
Log_log2node to open its properties in the Properties view. In the Message field, type
This is a valid order - OK to process.Leave the remaining properties as they are.
- In the Palette, open the Transformation drawer and select the Set Header pattern.
Drag the Set Header pattern to the canvas and drop it into the
Otherwise_elseValidcontainer.The
Otherwise_elseValidcontainer expands to accommodate theSetHeader_setHeader2node.On the canvas, select the
Log_log2node and drag its connector arrow over theSetHeader_setHeader2node, and then release it:NoteYou can collapse containers to free up space when the diagram becomes congested. To do so, select the container you want to collapse, and then click its
button:
To reopen the container, select it and then click its
button:
Collapsing and expanding containers in the Design tab does not affect the routing context file. It remains unchanged.
-
On the canvas, select the
SetHeader_setHeader2node to open its properties in the Properties view. -
Click the
button in the Language field to open the list of available languages, and select constant.
-
In the Expression field, type
ReadyForDispatcher. -
In the Header Name field, type
Destination. Leave the remaining properties as they are.
-
In the Palette, open the Components drawer and select the File (
) component.
Drag the File component to the canvas and drop it into the
Otherwise_elseValidcontainer.The
Otherwise_elseValidcontainer expands to accommodate theTo_to1node.On the canvas, select the
SetHeader_setHeader2node, and drag its connector arrow over theTo_to1node and then release it:-
On the canvas, select the
To_to1node to open its properties in the Properties view. In the URI field, replace directoryName with
target/messages/validOrders, and in the Id field, type_Valid.Save the routing context file.
Here is the completed content-based router with logs and message headers:
Click the Source tab at the bottom, left of the canvas to display the XML for the route.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verifying the CBR
You can run the new route as described in the the section called “Running the route” tutorial.
After you run it, to verify whether the route executed properly you can check the target destination folders in Project Explorer:
-
Select
ZooOrderApp. - Right-click it to open the context menu, and then select Refresh.
Under the project root node (
ZooOrderApp), locate thetarget/messages/folder and expand it.Check that the
target/messages/invalidOrdersfolder containsmessage1.xmlandmessage3.xml.In these messages, the value of the
quantityelement exceeds 10.Check that the
target/messages/validOrdersfolder contains the four message files that contain valid orders:message2.xml,message4.xml,message5.xmlandmessage6.xml.In these messages, the value of the
quantityelement is less than or equal to 10.NoteTo view message content, double-click each message to open it in the route editor’s XML editor.
Next steps
In the next tutorial, Chapter 6, Adding another route to the routing context, you add a second route that further processes valid order messages.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}