Class AvroDataFormat
- java.lang.Object
-
- org.apache.camel.model.IdentifiedType
-
- org.apache.camel.model.DataFormatDefinition
-
- org.apache.camel.model.dataformat.AvroDataFormat
-
@Metadata(firstVersion="2.14.0", label="dataformat,transformation", title="Avro") public class AvroDataFormat extends DataFormatDefinition
Serialize and deserialize messages using Apache Avro binary data format.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AvroDataFormat.Builder
Builder
is a specific builder forAvroDataFormat
.
-
Constructor Summary
Constructors Constructor Description AvroDataFormat()
AvroDataFormat(String instanceClassName)
AvroDataFormat(AvroLibrary library)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AvroDataFormat
allowUnmarshallType(boolean allowUnmarshallType)
AvroDataFormat
allowUnmarshallType(String allowUnmarshallType)
AvroDataFormat
autoDiscoverObjectMapper(boolean autoDiscoverObjectMapper)
AvroDataFormat
autoDiscoverObjectMapper(String autoDiscoverObjectMapper)
AvroDataFormat
collectionType(Class<?> collectionType)
AvroDataFormat
collectionType(String collectionType)
AvroDataFormat
disableFeatures(String disableFeatures)
AvroDataFormat
enableFeatures(String enableFeatures)
String
getAllowJmsType()
String
getAllowUnmarshallType()
String
getAutoDiscoverObjectMapper()
String
getAutoDiscoverSchemaResolver()
Class<?>
getCollectionType()
String
getCollectionTypeName()
String
getContentTypeHeader()
String
getDataFormatName()
String
getDisableFeatures()
String
getEnableFeatures()
String
getInclude()
String
getInstanceClassName()
Class<?>
getJsonView()
String
getJsonViewTypeName()
AvroLibrary
getLibrary()
String
getModuleClassNames()
String
getModuleRefs()
String
getObjectMapper()
Object
getSchema()
String
getSchemaResolver()
String
getTimezone()
Class<?>
getUnmarshalType()
String
getUnmarshalTypeName()
String
getUseDefaultObjectMapper()
String
getUseList()
AvroDataFormat
include(String include)
AvroDataFormat
jsonView(Class<?> jsonView)
AvroDataFormat
moduleClassNames(String moduleClassNames)
AvroDataFormat
moduleRefs(String moduleRefs)
AvroDataFormat
objectMapper(String objectMapper)
void
setAllowJmsType(String allowJmsType)
Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.void
setAllowUnmarshallType(String allowUnmarshallType)
If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling.void
setAutoDiscoverObjectMapper(String autoDiscoverObjectMapper)
If set to true then Jackson will lookup for an objectMapper into the registryvoid
setAutoDiscoverSchemaResolver(String autoDiscoverSchemaResolver)
When not disabled, the SchemaResolver will be looked up into the registryvoid
setCollectionType(Class<?> collectionType)
void
setCollectionTypeName(String collectionTypeName)
Refers to a custom collection type to lookup in the registry to use.void
setContentTypeHeader(String contentTypeHeader)
void
setDisableFeatures(String disableFeatures)
Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper.void
setEnableFeatures(String enableFeatures)
Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper.void
setInclude(String include)
If you want to marshal a pojo to JSON, and the pojo has some fields with null values.void
setInstanceClassName(String instanceClassName)
Class name to use for marshal and unmarshallingvoid
setJsonView(Class<?> jsonView)
When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output.void
setJsonViewTypeName(String jsonViewTypeName)
When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output.void
setLibrary(AvroLibrary library)
Which Avro library to use.void
setModuleClassNames(String moduleClassNames)
To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names.void
setModuleRefs(String moduleRefs)
To use custom Jackson modules referred from the Camel registry.void
setObjectMapper(String objectMapper)
Lookup and use the existing ObjectMapper with the given id when using Jackson.void
setSchema(Object schema)
void
setSchemaResolver(String schemaResolver)
Optional schema resolver used to lookup schemas for the data in transit.void
setTimezone(String timezone)
If set then Jackson will use the Timezone when marshalling/unmarshalling.void
setUnmarshalType(Class<?> unmarshalType)
Class of the java type to use when unmarshallingvoid
setUnmarshalTypeName(String unmarshalTypeName)
Class name of the java type to use when unmarshallingvoid
setUseDefaultObjectMapper(String useDefaultObjectMapper)
Whether to lookup and use default Jackson ObjectMapper from the registry.void
setUseList(String useList)
To unmarshal to a List of Map or a List of Pojo.AvroDataFormat
unmarshalType(Class<?> unmarshalType)
AvroDataFormat
unmarshalType(String unmarshalType)
AvroDataFormat
useDefaultObjectMapper(boolean useDefaultObjectMapper)
AvroDataFormat
useDefaultObjectMapper(String useDefaultObjectMapper)
AvroDataFormat
useList(boolean useList)
AvroDataFormat
useList(String useList)
-
Methods inherited from class org.apache.camel.model.DataFormatDefinition
getDataFormat, getShortName, setDataFormat, setDataFormatName
-
Methods inherited from class org.apache.camel.model.IdentifiedType
getId, setId
-
-
-
-
Constructor Detail
-
AvroDataFormat
public AvroDataFormat()
-
AvroDataFormat
public AvroDataFormat(AvroLibrary library)
-
AvroDataFormat
public AvroDataFormat(String instanceClassName)
-
-
Method Detail
-
getInstanceClassName
public String getInstanceClassName()
-
setInstanceClassName
public void setInstanceClassName(String instanceClassName)
Class name to use for marshal and unmarshalling
-
getSchema
public Object getSchema()
-
setSchema
public void setSchema(Object schema)
-
getLibrary
public AvroLibrary getLibrary()
-
setLibrary
public void setLibrary(AvroLibrary library)
Which Avro library to use.
-
getContentTypeHeader
public String getContentTypeHeader()
-
setContentTypeHeader
public void setContentTypeHeader(String contentTypeHeader)
-
getObjectMapper
public String getObjectMapper()
-
setObjectMapper
public void setObjectMapper(String objectMapper)
Lookup and use the existing ObjectMapper with the given id when using Jackson.
-
getUseDefaultObjectMapper
public String getUseDefaultObjectMapper()
-
setUseDefaultObjectMapper
public void setUseDefaultObjectMapper(String useDefaultObjectMapper)
Whether to lookup and use default Jackson ObjectMapper from the registry.
-
getUnmarshalTypeName
public String getUnmarshalTypeName()
-
setUnmarshalTypeName
public void setUnmarshalTypeName(String unmarshalTypeName)
Class name of the java type to use when unmarshalling
-
getUnmarshalType
public Class<?> getUnmarshalType()
-
setUnmarshalType
public void setUnmarshalType(Class<?> unmarshalType)
Class of the java type to use when unmarshalling
-
getJsonViewTypeName
public String getJsonViewTypeName()
-
setJsonViewTypeName
public void setJsonViewTypeName(String jsonViewTypeName)
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
-
getJsonView
public Class<?> getJsonView()
-
setJsonView
public void setJsonView(Class<?> jsonView)
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
-
getInclude
public String getInclude()
-
setInclude
public void setInclude(String 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
-
getAllowJmsType
public String getAllowJmsType()
-
setAllowJmsType
public void setAllowJmsType(String allowJmsType)
Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.
-
getCollectionTypeName
public String getCollectionTypeName()
-
setCollectionTypeName
public void setCollectionTypeName(String collectionTypeName)
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.
-
getCollectionType
public Class<?> getCollectionType()
-
setCollectionType
public void setCollectionType(Class<?> collectionType)
-
getUseList
public String getUseList()
-
setUseList
public void setUseList(String useList)
To unmarshal to a List of Map or a List of Pojo.
-
getModuleClassNames
public String getModuleClassNames()
-
setModuleClassNames
public void setModuleClassNames(String moduleClassNames)
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.
-
getModuleRefs
public String getModuleRefs()
-
setModuleRefs
public void setModuleRefs(String moduleRefs)
To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma.
-
getEnableFeatures
public String getEnableFeatures()
-
setEnableFeatures
public void setEnableFeatures(String enableFeatures)
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
-
getDisableFeatures
public String getDisableFeatures()
-
setDisableFeatures
public void setDisableFeatures(String disableFeatures)
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
-
getAllowUnmarshallType
public String getAllowUnmarshallType()
-
setAllowUnmarshallType
public void setAllowUnmarshallType(String allowUnmarshallType)
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.
-
getTimezone
public String getTimezone()
-
setTimezone
public void setTimezone(String timezone)
If set then Jackson will use the Timezone when marshalling/unmarshalling.
-
getAutoDiscoverObjectMapper
public String getAutoDiscoverObjectMapper()
-
setAutoDiscoverObjectMapper
public void setAutoDiscoverObjectMapper(String autoDiscoverObjectMapper)
If set to true then Jackson will lookup for an objectMapper into the registry
-
getDataFormatName
public String getDataFormatName()
- Overrides:
getDataFormatName
in classDataFormatDefinition
-
setSchemaResolver
public void setSchemaResolver(String schemaResolver)
Optional schema resolver used to lookup schemas for the data in transit.
-
getSchemaResolver
public String getSchemaResolver()
-
getAutoDiscoverSchemaResolver
public String getAutoDiscoverSchemaResolver()
-
setAutoDiscoverSchemaResolver
public void setAutoDiscoverSchemaResolver(String autoDiscoverSchemaResolver)
When not disabled, the SchemaResolver will be looked up into the registry
-
objectMapper
public AvroDataFormat objectMapper(String objectMapper)
-
useDefaultObjectMapper
public AvroDataFormat useDefaultObjectMapper(boolean useDefaultObjectMapper)
-
useDefaultObjectMapper
public AvroDataFormat useDefaultObjectMapper(String useDefaultObjectMapper)
-
unmarshalType
public AvroDataFormat unmarshalType(String unmarshalType)
-
unmarshalType
public AvroDataFormat unmarshalType(Class<?> unmarshalType)
-
jsonView
public AvroDataFormat jsonView(Class<?> jsonView)
-
include
public AvroDataFormat include(String include)
-
collectionType
public AvroDataFormat collectionType(String collectionType)
-
collectionType
public AvroDataFormat collectionType(Class<?> collectionType)
-
useList
public AvroDataFormat useList(boolean useList)
-
useList
public AvroDataFormat useList(String useList)
-
moduleClassNames
public AvroDataFormat moduleClassNames(String moduleClassNames)
-
moduleRefs
public AvroDataFormat moduleRefs(String moduleRefs)
-
enableFeatures
public AvroDataFormat enableFeatures(String enableFeatures)
-
disableFeatures
public AvroDataFormat disableFeatures(String disableFeatures)
-
allowUnmarshallType
public AvroDataFormat allowUnmarshallType(boolean allowUnmarshallType)
-
allowUnmarshallType
public AvroDataFormat allowUnmarshallType(String allowUnmarshallType)
-
autoDiscoverObjectMapper
public AvroDataFormat autoDiscoverObjectMapper(boolean autoDiscoverObjectMapper)
-
autoDiscoverObjectMapper
public AvroDataFormat autoDiscoverObjectMapper(String autoDiscoverObjectMapper)
-
-