Available as of Camel 2.16
Jackson XML is a Data Format which uses the Jackson library with the XMLMapper extension to unmarshal an XML payload into Java objects or to marshal Java objects into an XML payload.
If you are familiar with Jackson, this XML data format behaves in the same way as its JSON counterpart, and thus can be used with classes annotated for JSON serialization/deserialization.
This extension also mimics JAXB's "Code first" approach.
This data format relies on Woodstox (especially for features like pretty printing), a fast and efficient XML processor.
Using Jackson XML 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
When marshalling a POJO to XML you might want to exclude certain fields from the XML output. With Jackson you can use JSON views to accomplish this. First create one or more marker classes.
Use the marker classes with the
annotation to include/exclude certain fields. The annotation also works on getters.
Finally use the Camel
to marshall the above POJO to XML.
Note that the weight field is missing in the resulting XML:
Include/Exclude fields using the
jsonView attribute with
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
If you want to marshal a pojo to XML, 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 JacksonXMLDataFormat to set the include option, as shown below:
Or from XML DSL you configure this as
Unmarshalling from XML to POJO with dynamic class name
If you use jackson to unmarshal XML to POJO, then you can now specify a header in the message that indicate which class name to unmarshal to.
The header has key
CamelJacksonUnmarshalType if that header is present in the message, then Jackson will use that as FQN for the POJO class to unmarshal the XML payload as.
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
Unmarshalling from XML to List<Map> or List<pojo>
If you are using Jackson to unmarshal XML to a list of map/pojo, you can now specify this by setting
useList="true" or use the
org.apache.camel.component.jacksonxml.ListJacksonXMLDataFormat. 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 modules
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"
Enabling or disable features using Jackson
Jackson has a number of features you can enable or disable, which its ObjectMapper uses. For example to disable failing on unknown properties when marshalling, 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
To enable a feature use the enableFeatures options instead.
From Java code you can use the type safe methods from camel-jackson module:
Converting Maps to POJO using 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.
Formatted XML marshalling (pretty-printing)
prettyPrint option one can output a well formatted XML while marshalling:
And in Java DSL:
Please note that there are 5 different overloaded
jacksonxml() DSL methods which support the
prettyPrint option in combination with other settings for
To use Jackson XML in your camel routes you need to add the dependency on camel-jacksonxml 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).