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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
JsonFormat()
JsonFormat(boolean forceDataBase64Serialization, boolean forceStringSerialization)

Method Summary

Modifier and Type	Method and Description
protected static boolean	dataIsJsonContentType(String contentType)
io.cloudevents.CloudEvent	deserialize(byte[] bytes)
static com.fasterxml.jackson.databind.module.SimpleModule	getCloudEventJacksonModule()
static com.fasterxml.jackson.databind.module.SimpleModule	getCloudEventJacksonModule(boolean forceDataBase64Serialization, boolean forceStringSerialization)
byte[]	serialize(io.cloudevents.CloudEvent event)
String	serializedContentType()
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

See Also:

Constant Field Values

Constructor Detail

JsonFormat

public JsonFormat(boolean forceDataBase64Serialization,
                  boolean forceStringSerialization)

JsonFormat

public JsonFormat()

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

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

serializedContentType

public String serializedContentType()

Specified by:

serializedContentType in interface EventFormat

getCloudEventJacksonModule

public static com.fasterxml.jackson.databind.module.SimpleModule getCloudEventJacksonModule()

Returns:

a JacksonModule with CloudEvent serializer/deserializer with default values

getCloudEventJacksonModule

public static com.fasterxml.jackson.databind.module.SimpleModule getCloudEventJacksonModule(boolean forceDataBase64Serialization,
                                                                                            boolean forceStringSerialization)

Returns:

a JacksonModule with CloudEvent serializer/deserializer customizing the data serialization. Look at withForceJsonDataToBase64() and withForceNonJsonDataToString() for more details.

dataIsJsonContentType

protected static boolean dataIsJsonContentType(String contentType)