Avro Jackson

Since Camel 3.10

Jackson Avro is a Data Format which uses the Jackson library with the Avro extension to unmarshal an Avro payload into Java objects or to marshal Java objects into an Avro payload.

If you are familiar with Jackson, this Avro data format behaves in the same way as its JSON counterpart, and thus can be used with classes annotated for JSON serialization/deserialization.

 
from("kafka:topic").
  unmarshal().avro(JsonNode.class).
  to("log:info");

Avro Jackson Options

The Avro Jackson dataformat supports 18 options, which are listed below.

Name Default Java Type Description

objectMapper (advanced)

String

Lookup and use the existing ObjectMapper with the given id when using Jackson.

useDefaultObjectMapper (common)

true

Boolean

Whether to lookup and use default Jackson ObjectMapper from the registry.

unmarshalType (common)

String

Class name of the java type to use when unmarshalling.

jsonView (common)

String

When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations.

include (common)

String

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, you can set this option to NON_NULL.

allowJmsType (advanced)

false

Boolean

Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.

collectionType (advanced)

String

Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default.

useList (common)

false

Boolean

To unmarshal to a List of Map or a List of Pojo.

moduleClassNames (advanced)

String

To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma.

moduleRefs (advanced)

String

To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma.

enableFeatures (common)

String

Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma.

disableFeatures (common)

String

Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma.

allowUnmarshallType (common)

false

Boolean

If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used.

timezone (advanced)

String

If set then Jackson will use the Timezone when marshalling/unmarshalling.

autoDiscoverObjectMapper (advanced)

false

Boolean

If set to true then Jackson will lookup for an objectMapper into the registry.

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.

schemaResolver (advanced)

Object

Optional schema resolver used to lookup schemas for the data in transit.

autoDiscoverSchemaResolver (advanced)

true

Boolean

When not disabled, the SchemaResolver will be looked up into the registry.

Usage

Configuring the SchemaResolver

Since Avro serialization is schema-based, this data format requires that you provide a SchemaResolver object that is able to look up the schema for each exchange that is going to be marshalled/unmarshalled.

You can add a single SchemaResolver to the registry, and it will be looked up automatically. Or you can explicitly specify the reference to a custom SchemaResolver.

Using custom AvroMapper

You can configure JacksonAvroDataFormat to use a custom AvroMapper in case you need more control of the mapping configuration.

If you set up a single AvroMapper in the registry, then Camel will automatic lookup and use this AvroMapper.

Dependencies

To use Avro Jackson in your Camel routes, you need to add the dependency on camel-jackson-avro, 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-jackson-avro</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

Spring Boot Auto-Configuration

When using avroJackson with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

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

The component supports 19 options, which are listed below.

Name Description Default Type

camel.dataformat.avro-jackson.allow-jms-type

Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.

false

Boolean

camel.dataformat.avro-jackson.allow-unmarshall-type

If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used.

false

Boolean

camel.dataformat.avro-jackson.auto-discover-object-mapper

If set to true then Jackson will lookup for an objectMapper into the registry.

false

Boolean

camel.dataformat.avro-jackson.auto-discover-schema-resolver

When not disabled, the SchemaResolver will be looked up into the registry.

true

Boolean

camel.dataformat.avro-jackson.collection-type

Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default.

String

camel.dataformat.avro-jackson.content-type-header

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.

true

Boolean

camel.dataformat.avro-jackson.disable-features

Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma.

String

camel.dataformat.avro-jackson.enable-features

Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma.

String

camel.dataformat.avro-jackson.enabled

Whether to enable auto configuration of the avroJackson data format. This is enabled by default.

Boolean

camel.dataformat.avro-jackson.include

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, you can set this option to NON_NULL.

String

camel.dataformat.avro-jackson.json-view

When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations.

String

camel.dataformat.avro-jackson.module-class-names

To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma.

String

camel.dataformat.avro-jackson.module-refs

To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma.

String

camel.dataformat.avro-jackson.object-mapper

Lookup and use the existing ObjectMapper with the given id when using Jackson.

String

camel.dataformat.avro-jackson.schema-resolver

Optional schema resolver used to lookup schemas for the data in transit. The option is a org.apache.camel.component.jackson.SchemaResolver type.

String

camel.dataformat.avro-jackson.timezone

If set then Jackson will use the Timezone when marshalling/unmarshalling.

String

camel.dataformat.avro-jackson.unmarshal-type

Class name of the java type to use when unmarshalling.

String

camel.dataformat.avro-jackson.use-default-object-mapper

Whether to lookup and use default Jackson ObjectMapper from the registry.

true

Boolean

camel.dataformat.avro-jackson.use-list

To unmarshal to a List of Map or a List of Pojo.

false

Boolean
Back to top