io.cloudevents.protobuf

Class ProtobufFormat

java.lang.Object

io.cloudevents.protobuf.ProtobufFormat

All Implemented Interfaces:

EventFormat

public class ProtobufFormat
extends Object
implements EventFormat

An implemmentation of EventFormat for the protobuf format. This format is resolvable with EventFormatProvider using the content type PROTO_CONTENT_TYPE. The data payload in the CloudEvent can also be a protobuf; in this case, you must wrap the data in Any and set the "datacontenttype" to PROTO_DATA_CONTENT_TYPE.

This EventFormat only works for SpecVersion.V1, as that was the first version the protobuf format was defined for.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROTO_CONTENT_TYPE The content type for transports sending cloudevents in the protocol buffer format.
static String	PROTO_DATA_CONTENT_TYPE The content type to set for the "datacontenttype" attribute if the data is stored in protocol buffer format.

Constructor Summary

Constructors

Constructor and Description
ProtobufFormat()

Method Summary

Modifier and Type	Method and Description
io.cloudevents.CloudEvent	deserialize(byte[] bytes, io.cloudevents.rw.CloudEventDataMapper<? extends io.cloudevents.CloudEventData> mapper)
byte[]	serialize(io.cloudevents.CloudEvent event)
String	serializedContentType()

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, deserialize

Field Detail

PROTO_CONTENT_TYPE

public static final String PROTO_CONTENT_TYPE

The content type for transports sending cloudevents in the protocol buffer format.

See Also:

Constant Field Values

PROTO_DATA_CONTENT_TYPE

public static final String PROTO_DATA_CONTENT_TYPE

The content type to set for the "datacontenttype" attribute if the data is stored in protocol buffer format. Note that if this content type is used, the stored data must be wrapped in Any as specified by the protobuf format spec.

See Also:

Constant Field Values

Constructor Detail

ProtobufFormat

public ProtobufFormat()

Method Detail

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,
                                             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