Chapter 33. XQuery


XQuery was originally devised as a query language for data stored in XML form in a database. The XQuery language enables you to select parts of the current message, when the message is in XML format. XQuery is a superset of the XPath language; hence, any valid XPath expression is also a valid XQuery expression.

Java syntax

You can pass an XQuery expression to xquery() in several ways. For simple expressions, you can pass the XQuery expressions as a string (java.lang.String). For longer XQuery expressions, you might prefer to store the expression in a file, which you can then reference by passing a argument or a argument to the overloaded xquery() method. The XQuery expression implicitly acts on the message content and returns a node set as the result. Depending on the context, the return value is interpreted either as a predicate (where an empty node set is interpreted as false) or as an expression.

Adding the Saxon module

To use XQuery in your routes you need to add a dependency on camel-saxon to your project as shown in Example 33.1, “Adding the camel-saxon dependency”.

Example 33.1. Adding the camel-saxon dependency

<!-- Maven POM File -->

Camel on EAP deployment

The camel-saxon component is supported by the Camel on EAP (Wildfly Camel) framework, which offers a simplified deployment model on the Red Hat JBoss Enterprise Application Platform (JBoss EAP) container.

Static import

To use the xquery() static method in your application code, include the following import statement in your Java source files:

import static org.apache.camel.component.xquery.XQueryBuilder.xquery;


Table 33.1, “XQuery variables” lists the variables that are accessible when using XQuery.

Table 33.1. XQuery variables




The current Exchange



The body of the IN message



The body of the OUT message



The IN message header whose key is key



The OUT message header whose key is key



The Exchange property whose key is key


Example 33.2, “Route using XQuery” shows a route that uses XQuery.

Example 33.2. Route using XQuery

    <from uri="activemq:MyQueue"/>
      <language langauge="xquery">/foo:person[@name='James']</language>
      <to uri="mqseries:SomeOtherQueue"/>