io.cloudevents.jackson

Class JsonFormat

java.lang.Object

io.cloudevents.jackson.JsonFormat

All Implemented Interfaces:

EventFormat

public final class JsonFormat
extends Object
implements EventFormat

Implementation of EventFormat for JSON event format using Jackson. This format is resolvable with EventFormatProvider using the content type CONTENT_TYPE.

If you want to use the CloudEvent serializers/deserializers directly in your mapper, you can use getCloudEventJacksonModule() or getCloudEventJacksonModule(boolean, boolean) to get a SimpleModule to register in your ObjectMapper instance.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE Content type associated with the JSON event format

Constructor Summary

Constructors

Constructor and Description
JsonFormat() Create a new instance of this class with default serialization configuration
JsonFormat(boolean forceDataBase64Serialization, boolean forceStringSerialization) Create a new instance of this class customizing the serialization configuration.
JsonFormat(JsonFormatOptions options) Create a new instance of this class customizing the serialization configuration.

Method Summary

Modifier and Type	Method and Description
io.cloudevents.CloudEvent	deserialize(byte[] bytes)
io.cloudevents.CloudEvent	deserialize(byte[] bytes, io.cloudevents.rw.CloudEventDataMapper<? extends io.cloudevents.CloudEventData> mapper)
static SimpleModule	getCloudEventJacksonModule()
static SimpleModule	getCloudEventJacksonModule(boolean forceDataBase64Serialization, boolean forceStringSerialization)
static SimpleModule	getCloudEventJacksonModule(JsonFormatOptions options)
byte[]	serialize(io.cloudevents.CloudEvent event)
String	serializedContentType()
JsonFormat	withForceExtensionNameLowerCaseDeserialization()
JsonFormat	withForceIgnoreInvalidExtensionNameDeserialization()
JsonFormat	withForceJsonDataToBase64()
JsonFormat	withForceNonJsonDataToString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.cloudevents.core.format.EventFormat

deserializableContentTypes

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

Content type associated with the JSON event format

See Also:

Constant Field Values

Constructor Detail

JsonFormat

public JsonFormat(boolean forceDataBase64Serialization,
                  boolean forceStringSerialization)

Create a new instance of this class customizing the serialization configuration.

Parameters:

forceDataBase64Serialization - force json base64 encoding for data

forceStringSerialization - force string serialization for non json data field

See Also:

withForceJsonDataToBase64(), withForceNonJsonDataToString()

JsonFormat

public JsonFormat(JsonFormatOptions options)

Create a new instance of this class customizing the serialization configuration.

Parameters:

options - json serialization / deserialization options

JsonFormat

public JsonFormat()

Create a new instance of this class with default serialization configuration

Method Detail

withForceJsonDataToBase64

public JsonFormat withForceJsonDataToBase64()

Returns:

a copy of this JsonFormat that serialize events with json data with Base64 encoding

withForceNonJsonDataToString

public JsonFormat withForceNonJsonDataToString()

Returns:

a copy of this JsonFormat that serialize events with non-json data as string

withForceExtensionNameLowerCaseDeserialization

public JsonFormat withForceExtensionNameLowerCaseDeserialization()

Returns:

a copy of this JsonFormat that deserialize events with converting extension name lower case.

withForceIgnoreInvalidExtensionNameDeserialization

public JsonFormat withForceIgnoreInvalidExtensionNameDeserialization()

Returns:

a copy of this JsonFormat that deserialize events with ignoring invalid extension name

serialize

public byte[] serialize(io.cloudevents.CloudEvent event)
                 throws EventSerializationException

Specified by:

serialize in interface EventFormat

Throws:

EventSerializationException

deserialize

public io.cloudevents.CloudEvent deserialize(byte[] bytes)
                                      throws EventDeserializationException

Specified by:

deserialize in interface EventFormat

Throws:

EventDeserializationException

deserialize

public io.cloudevents.CloudEvent deserialize(byte[] bytes,
                                             io.cloudevents.rw.CloudEventDataMapper<? extends io.cloudevents.CloudEventData> mapper)
                                      throws EventDeserializationException

Specified by:

deserialize in interface EventFormat

Throws:

EventDeserializationException

serializedContentType

public String serializedContentType()

Specified by:

serializedContentType in interface EventFormat

getCloudEventJacksonModule

public static SimpleModule getCloudEventJacksonModule()

Returns:

a SimpleModule with CloudEvent serializer/deserializer configured using default values.

getCloudEventJacksonModule

public static SimpleModule getCloudEventJacksonModule(boolean forceDataBase64Serialization,
                                                      boolean forceStringSerialization)

Parameters:

forceDataBase64Serialization - force json base64 encoding for data

forceStringSerialization - force string serialization for non json data field

Returns:

a JacksonModule with CloudEvent serializer/deserializer customizing the data serialization.

See Also:

withForceJsonDataToBase64(), withForceNonJsonDataToString()

getCloudEventJacksonModule

public static SimpleModule getCloudEventJacksonModule(JsonFormatOptions options)

Parameters:

options - json serialization / deserialization options

Returns:

a JacksonModule with CloudEvent serializer/deserializer customizing the data serialization.