io.cloudevents.amqp.impl

Class ProtonAmqpBinaryMessageReader

java.lang.Object

io.cloudevents.core.message.impl.BaseBinaryMessageReader

io.cloudevents.core.message.impl.BaseGenericBinaryMessageReaderImpl<String,Object>

io.cloudevents.amqp.impl.ProtonAmqpBinaryMessageReader

All Implemented Interfaces:

MessageReader, StructuredMessageReader, io.cloudevents.rw.CloudEventReader

public final class ProtonAmqpBinaryMessageReader
extends BaseGenericBinaryMessageReaderImpl<String,Object>

An AMQP 1.0 message reader that can be read as a CloudEvent.

This reader reads sections of an AMQP message to construct a CloudEvent representation by doing the following:

• If the content-type property is set for an AMQP message, the value of the property is represented as a cloud event datacontenttype attribute.
• If the (mandatory) application-properties of the AMQP message contains attributes and/or extentions, this reader will represent each property/extension as a cloud event attribute.

Constructor Summary

Constructors

Constructor and Description
ProtonAmqpBinaryMessageReader(io.cloudevents.SpecVersion version, ApplicationProperties applicationProperties, String contentType, byte[] payload) Create an instance of an AMQP message reader.

Method Summary

Modifier and Type	Method and Description
protected void	forEachHeader(BiConsumer<String,Object> fn) Visits the content-type message property and all application-properties of this message reader.
protected boolean	isCloudEventsHeader(String key) Tests whether the given attribute key is prefixed with cloudEvents:
protected boolean	isContentTypeHeader(String key)
protected String	toCloudEventsKey(String key) Gets the cloud event attribute key without the preceding prefix.
protected String	toCloudEventsValue(Object value) Gets the cloud event representation of the value.

Methods inherited from class io.cloudevents.core.message.impl.BaseGenericBinaryMessageReaderImpl

read

Methods inherited from class io.cloudevents.core.message.impl.BaseBinaryMessageReader

getEncoding, read

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.message.MessageReader

read, read, toEvent, toEvent

Methods inherited from interface io.cloudevents.core.message.StructuredMessageReader

from, from

Constructor Detail

ProtonAmqpBinaryMessageReader

public ProtonAmqpBinaryMessageReader(io.cloudevents.SpecVersion version,
                                     ApplicationProperties applicationProperties,
                                     String contentType,
                                     byte[] payload)

Create an instance of an AMQP message reader.

Parameters:

version - The version of the cloud event message.

applicationProperties - The application properties of the AMQP message that contains the cloud event metadata (i.e attributes and extensions). The applicationProperties MUST not be null.

contentType - The content-type property of the AMQP message or null if the message content type is unknown.

payload - The message payload or null if the message does not contain any payload.

Throws:

NullPointerException - if the applicationPropereties is null.

Method Detail

isContentTypeHeader

protected boolean isContentTypeHeader(String key)

Specified by:

isContentTypeHeader in class BaseGenericBinaryMessageReaderImpl<String,Object>

isCloudEventsHeader

protected boolean isCloudEventsHeader(String key)

Tests whether the given attribute key is prefixed with cloudEvents:

Specified by:

isCloudEventsHeader in class BaseGenericBinaryMessageReaderImpl<String,Object>

Parameters:

key - The key to test for the presence of the prefix.

Returns:

True if the specified key starts with the prefix or false otherwise.

toCloudEventsKey

protected String toCloudEventsKey(String key)

Gets the cloud event attribute key without the preceding prefix.

Specified by:

toCloudEventsKey in class BaseGenericBinaryMessageReaderImpl<String,Object>

Parameters:

key - The key containing the AMQP specific prefix.

Returns:

The key without the prefix.

forEachHeader

protected void forEachHeader(BiConsumer<String,Object> fn)

Visits the content-type message property and all application-properties of this message reader.

This method only visits properties containing a name and value which are not null.

Specified by:

forEachHeader in class BaseGenericBinaryMessageReaderImpl<String,Object>

Parameters:

fn - A callback to consume this reader's application-properties and content-type property.

toCloudEventsValue

protected String toCloudEventsValue(Object value)

Gets the cloud event representation of the value.

This method simply returns the string representation of the type of value passed as argument.

Specified by:

toCloudEventsValue in class BaseGenericBinaryMessageReaderImpl<String,Object>

Parameters:

value - The value of a CloudEvent attribute or extension.

Returns:

The string representation of the specified value.