THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
As of Camel 2.10, Camel supports direct, bi-directional JSON <=> XML conversions via the camel-xmljson data format, which is documented separately.
Using JSON Data Format With the XStream Library
...
...
Using JSON Data Format With the Jackson Library
...
...
Using JSON Data Format With the GSON Library
...
...
Using JSON in Spring DSL
When using Data Format in Spring DSL you need to declare the data formats first. This is done in the DataFormats XML tag.
...
...
And then you can refer to this id in the route:
...
...
Excluding POJO Fields From Marshalling
...
First create one or more marker classes:Wiki Markup @JsonView annotation to include/exclude certain fields. The annotation also works on getters:Wiki Markup JacksonDataFormat to marshal the above POJO to JSON.Wiki Markup
...
...
The GSON library supports a similar feature through the notion of ExclusionStrategies:Wiki Markup GsonDataFormat accepts an ExclusionStrategy in its constructor:Wiki Markup @ExcludeAge when marshaling to JSON.
...
We may have this JSON string
...
Which we want to map to a POJO that has getter/setters as:
...
...
Then we can configure the org.apache.camel.component.gson.GsonDataFormat in a Spring XML files as shown below. Notice we use fieldNamingPolicy property to set the field mapping. This property is an enum from GSon com.google.gson.FieldNamingPolicy which has a number of predefined mappings.
If you need full control you can use the property FieldNamingStrategy and implement a custom com.google.gson.FieldNamingStrategy where you can control the mapping.
...
And use it in Camel routes by referring to its bean id as shown:
...
...
Include/Exclude Fields Using the jsonView Attribute With JacksonDataFormat
...
As an example of using this attribute you can instead of:
...
Directly specify your JSON view inside the Java DSL as:
...
...
And the same in XML DSL:
...
...
Setting Serialization Include Option for Jackson Marshal
...
If you want to marshal a POJO to JSON, and the POJO has some fields with null values. And you want to skip these null values, then you need to set either an annotation on the POJO,
...
...
But this requires you to include that annotation in your POJO source code. You can also configure the Camel JsonDataFormat to set the include option, as shown below:
...
...
Or from XML DSL you configure this as
...
as
...
Unmarshaling from JSON to POJO with Dynamic Class Name
...
For JMS end users there is the JMSType header from the JMS spec that indicates that also. To enable support for JMSType you would need to turn that on, on the Jackson data format as shown:
...
...
Or from XML DSL you configure this as
...
...
Unmarshaling From JSON to List<Map> or List<pojo>
...
For example, with Java you can do as shown below:
...
...
And if you use XML DSL then you configure to use list using useList attribute as shown below:
...
...
And you can specify the pojo type also
...
...
Using Custom Jackson's ObjectMapper
...
You can use custom Jackson ObjectMapper instance, can be configured as shown below.
...
...
Where myMapper is the id of the custom instance that Camel will lookup in the Registry.
...
You can use custom Jackson modules by specifying the class names of those using the moduleClassNames option as shown below.
...
...
When using moduleClassNames then the custom Jackson modules are not configured, by created using default constructor and used as-is. If a custom module needs any custom configuration, then an instance of the module can be created and configured, and then use modulesRefs to refer to the module as shown below:
...
...
Multiple modules can be specified separated by comma, such as moduleRefs="myJacksonModule,myOtherModule".
...
Jackson has a number of features you can enable or disable, which its ObjectMapper uses. For example to disable failing on unknown properties when marshaling, you can configure this using the disableFeatures:
...
...
You can disable multiple features by separating the values using comma. The values for the features must be the name of the enums from Jackson from the following enum classes
...
From Java code you can use the type safe methods from camel-jackson module:
...
...
Converting Maps to POJO Using Jackson
Available since Camel 2.16. Jackson ObjectMapper can be used to convert maps to POJO objects. Jackson component comes with the data converter that can be used to convert java.util.Map instance to non-String, non-primitive and non-Number objects.
...
...
If there is a single ObjectMapper instance available in the Camel registry, it will used by the converter to perform the conversion. Otherwise the default mapper will be used.
...
Using the prettyPrint option one can output a well formatted JSON while marshaling:
...
...
And in Java DSL:
...
...
Please note that as of Camel 2.16 there are five different overloaded json() DSL methods which support the prettyPrint option in combination with other settings for JsonLibrary, unmarshalType, jsonView etc.
...
The camel-jackson module allows to integrate Jackson as a Type Converter in the Camel registry. This works in similar ways that camel-jaxb integrates with the type converter as well. However camel-jackson must be explicit enabled, which is done by setting some options on the CamelContext properties, as shown below:
...
...
The camel-jackson type converter integrates with JAXB which means you can annotate POJO class with JAXB annotations that Jackson can leverage.
...
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).
...
...
Dependencies for Jackson
To use JSON in your camel routes you need to add the a dependency on camel-jackson which implements this data format.
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).
...
...
Dependencies for GSON
To use JSON in your camel routes you need to add the a dependency on camel-gson which implements this data format.
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).
...
...