Red Hat Summit Red Hat SummitApoyoConsolaDesarrolladoresIniciar una pruebaContacto

Este contenido no está disponible en el idioma seleccionado.

Chapter 60. JQ

Since Camel 3.18

Camel supports JQ to allow using Expression or Predicate on JSON messages.

60.1. Dependencies
Copiar enlace

When using jq with Red Hat build of Camel Spring Boot, use the following Maven dependency to have support for auto configuration: 

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-jq-starter</artifactId>
</dependency>

60.2. JQ Options
Copiar enlace

The JQ language supports 4 options, which are listed below.

Expand
NameDefaultJava TypeDescription

headerName

 

String

Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set.

propertyName

 

String

Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set.

resultType

 

String

Sets the class of the result type (type from output).

trim

true

Boolean

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

60.3. Examples
Copiar enlace

For example, you can use JQ in a Predicate with the Content Based Router EIP. 

from("queue:books.new")
  .choice()
    .when().jq(".store.book.price < 10)")
      .to("jms:queue:book.cheap")
    .when().jq(".store.book.price < 30)")
      .to("jms:queue:book.average")
    .otherwise()
      .to("jms:queue:book.expensive");

60.4. Message body types
Copiar enlace

Camel JQ leverages camel-jackson for type conversion. To enable camel-jackson POJO type conversion, refer to the Camel Jackson documentation.

60.5. Using header as input
Copiar enlace

By default, JQ uses the message body as the input source. However, you can also use a header as input by specifying the headerName option.

For example to count the number of books from a JSON document that was stored in a header named books you can do: 

from("direct:start")
    .setHeader("numberOfBooks")
        .jq(".store.books | length", int.class, "books")
    .to("mock:result");

60.6. Camel supplied JQ Functions
Copiar enlace

The camel-jq adds the following functions:

  • header - Allow to access the Message header in a JQ expression.

For example, to set the property foo with the value from the Message header `MyHeader': 

from("direct:start")
    .transform()
        .jq(".foo = header(\"MyHeader\")")
    .to("mock:result");

60.7. Spring Boot Auto-Configuration
Copiar enlace

The component supports 4 options, which are listed below.

Expand
NameDescriptionDefaultType

camel.language.jq.enabled

Whether to enable auto configuration of the jq language. This is enabled by default.

 

Boolean

camel.language.jq.header-name

Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set.

 

String

camel.language.jq.property-name

Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set.

 

String

camel.language.jq.trim

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

true

Boolean

Red Hat logoGithubredditYoutubeTwitter

Aprender

Pruebe, compre y venda

Comunidades

Acerca de la documentación de Red Hat

Ayudamos a los usuarios de Red Hat a innovar y alcanzar sus objetivos con nuestros productos y servicios con contenido en el que pueden confiar. Explore nuestras recientes actualizaciones.

Hacer que el código abierto sea más inclusivo

Red Hat se compromete a reemplazar el lenguaje problemático en nuestro código, documentación y propiedades web. Para más detalles, consulte el Blog de Red Hat.

Acerca de Red Hat

Ofrecemos soluciones reforzadas que facilitan a las empresas trabajar en plataformas y entornos, desde el centro de datos central hasta el perímetro de la red.

Theme

© 2026 Red HatVolver arriba