Camel Components

JSON Gson

Since Camel 2.10

Gson is a Data Format that uses the Gson Library

  • Java

  • XML

  • YAML

from("activemq:My.Queue")
    .marshal().json(JsonLibrary.Gson)
    .to("mqseries:Another.Queue");
<route>
  <from uri="activemq:My.Queue"/>
  <marshal><json library="Gson"/></marshal>
  <to uri="mqseries:Another.Queue"/>
</route>
- route:
    from:
      uri: activemq:My.Queue
      steps:
        - marshal:
            json:
              library: Gson
        - to:
            uri: mqseries:Another.Queue

Gson Options

The JSON Gson dataformat supports the following options which are listed below.

Name Default Java Type Description

prettyPrint (common)

false

Boolean

To enable pretty printing output nicely formatted. Is by default false.

unmarshalType (common)

String

Class name of the java type to use when unmarshalling.

contentTypeHeader (common)

true

Boolean

Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON.

dateFormatPattern (common)

String

To configure the date format while marshall or unmarshall Date fields in JSON using Gson.

A body that is already JSON

A body that already is the JSON text is written as it is, not serialized as a Java object: a file, an InputStream, a byte[], and a String whose text is a JSON object or array (it starts with { and ends with }, or [ and ]). So marshal: json after reading a JSON file, or after building the JSON with a template or a Simple expression, sends that JSON unchanged. Any other String is written as a JSON string, and POJOs, maps and lists are marshalled as usual. All the JSON data formats of Camel do the same.

Dependencies

To use Gson in your camel routes, you need to add the dependency on camel-gson which implements this data format.

If you use maven, you could add the following to your pom.xml, substituting the version number for the latest & greatest release.

<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-gson</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>