Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 245. OGNL Language

Available as of Camel version 1.1

Camel allows OGNL to be used as an Expression or Predicate the DSL or Xml Configuration.

You could use OGNL to create an Predicate in a Message Filter or as an Expression for a Recipient List

You can use OGNL dot notation to invoke operations. If you for instance have a body that contains a POJO that has a getFamilyName method then you can construct the syntax as follows: 

"request.body.familyName"
   // or
"getRequest().getBody().getFamilyName()"
Copy to Clipboard Toggle word wrap

245.1. OGNL Options
Copy link

The OGNL language supports 1 options, which are listed below.

Expand
NameDefaultJava TypeDescription

trim

true

Boolean

Whether to trim the value to remove leading and trailing whitespaces and line breaks

245.2. Spring Boot Auto-Configuration
Copy link

The component supports 2 options, which are listed below.

Expand
NameDescriptionDefaultType

camel.language.ognl.enabled

Enable ognl language

true

Boolean

camel.language.ognl.trim

Whether to trim the value to remove leading and trailing whitespaces and line breaks

true

Boolean

245.3. Variables
Copy link

Expand
VariableTypeDescription

this

Exchange

the Exchange is the root object

exchange

Exchange

the Exchange object

exception

Throwable

the Exchange exception (if any)

exchangeId

String

the exchange id

fault

Message

the Fault message (if any)

request

Message

the exchange.in message

response

Message

the exchange.out message (if any)

properties

Map

the exchange properties

property(name)

Object

the property by the given name

property(name, type)

Type

the property by the given name as the given type

245.4. Samples
Copy link

For example you could use OGNL inside a Message Filter in XML 

<route>
  <from uri="seda:foo"/>
  <filter>
    <ognl>request.headers.foo == 'bar'</ognl>
    <to uri="seda:bar"/>
  </filter>
</route>
Copy to Clipboard Toggle word wrap

And the sample using Java DSL: 

   from("seda:foo").filter().ognl("request.headers.foo == 'bar'").to("seda:bar");
Copy to Clipboard Toggle word wrap

245.5. Loading script from external resource
Copy link

Available as of Camel 2.11

You can externalize the script and have Camel load it from a resource such as "classpath:", "file:", or "http:".
This is done using the following syntax: "resource:scheme:location", eg to refer to a file on the classpath you can do: 

.setHeader("myHeader").ognl("resource:classpath:myognl.txt")
Copy to Clipboard Toggle word wrap

245.6. Dependencies
Copy link

To use OGNL in your camel routes you need to add the a dependency on camel-ognl which implements the OGNL language.

If you use maven you could just add the following to your pom.xml, substituting the version number for the latest & greatest release (see the download page for the latest versions). 

<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-ognl</artifactId>
  <version>x.x.x</version>
</dependency>
Copy to Clipboard Toggle word wrap

Otherwise, you’ll also need OGNL

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat