The Message Filter from the EIP patterns allows you to filter messages
The following example shows how to create a Message Filter route consuming messages from an endpoint called
queue:a, which if the Predicate is true will be dispatched to
Using the Fluent Builders
You can, of course, use many different Predicate
languages such as XPath
or various Scripting Languages
. Here is an XPath example
Here's another example of using a bean to define the filter behavior:
Using the Spring XML Extensions
You can also use a method call expression (to call a method on a bean) in the Message Filter, as shown below:
Filtered Endpoint Required Inside </filter> Tag
Ensure you put the endpoint you want to filter
<to uri="seda:b"/> before the closing
</filter> tag or the filter will not be applied. From Camel 2.8: omitting this will result in an error.
For further examples of this pattern in use you could look at the junit test case
Stop is a bit different than a message filter as it will filter out all messages and end the route entirely (filter only applies to its child processor). Stop is convenient to use in a Content Based Router when you for example need to stop further processing in one of the predicates.
In the example below we do not want to route messages any further that has the word
Bye in the message body. Notice how we prevent this in the
when() predicate by using the
How To Determine If An Exchange Was Filtered
Available as of Camel 2.5
The Message Filter EIP will add a property on the Exchange that states if it was filtered or not.
The property has the key
Exchange.FILTER_MATCHED, which has the String value of
CamelFilterMatched. Its value is a
false. If the value is
true then the Exchange was routed in the filter block. This property will be visible within the Message Filter block who's Predicate matches (value set to
true), and to the steps immediately following the Message Filter with the value set based on the results of the last Message Filter Predicate evaluated.
Using This Pattern
If you would like to use this EIP Pattern then please read the Getting Started, you may also find the Architecture useful particularly the description of Endpoint and URIs. Then you could try out some of the Examples first before trying this pattern out.