org.vatplanner.commons.amqp

Class MessageSupplements

java.lang.Object

org.vatplanner.commons.amqp.MessageSupplements

public class MessageSupplements
extends Object

Provides additional information and actions to MessageSubscriptionCreator.MessageHandlers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageSupplements.Builder Builder for MessageSupplements.

Method Summary

Modifier and Type	Method and Description
boolean	acknowledgeMessage() Acknowledges the message on AMQP (ACK confirmation); visible to sender.
static MessageSupplements.Builder	builder() Instantiates a new MessageSupplements.Builder to construct MessageSupplements.
com.rabbitmq.client.Envelope	getAmqpEnvelope() Returns the Envelope of the original AMQP message.
com.rabbitmq.client.AMQP.BasicProperties	getAmqpProperties() Returns the AMQP.BasicProperties of the original AMQP message.
Optional<byte[]>	getPayload() Returns the payload that was sent together with the message, if present.
Set<Long>	getVerifiedKeyIds() Returns the IDs of all keys related to the signature used for the Message as known to the MessageSubscriptionCreator's Cryptor instance at time of reception.

Methods inherited from class java.lang.Object

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

Method Detail

getAmqpEnvelope

public com.rabbitmq.client.Envelope getAmqpEnvelope()

Returns the Envelope of the original AMQP message.

Returns:

AMQP message envelope

getAmqpProperties

public com.rabbitmq.client.AMQP.BasicProperties getAmqpProperties()

Returns the AMQP.BasicProperties of the original AMQP message.

Returns:

AMQP message properties

getVerifiedKeyIds

public Set<Long> getVerifiedKeyIds()

Returns the IDs of all keys related to the signature used for the Message as known to the MessageSubscriptionCreator's Cryptor instance at time of reception.

An empty set indicates that the message either was not signed or the signature could not be verified. If IDs are present, the signature was verified for related keys.

Returns:

IDs related to keys the message was verified for; empty indicates an unsigned or unverified message

getPayload

public Optional<byte[]> getPayload()

Returns the payload that was sent together with the message, if present.

Returns:

payload; empty if only the message was received

acknowledgeMessage

public boolean acknowledgeMessage()

Acknowledges the message on AMQP (ACK confirmation); visible to sender.

Returns:

true if successful; false if the acknowledgement could not be sent

builder

public static MessageSupplements.Builder builder()

Instantiates a new MessageSupplements.Builder to construct MessageSupplements.

Returns:

new MessageSupplements.Builder to construct MessageSupplements