io.smallrye.reactive.messaging.amqp

Class IncomingAmqpMetadata

java.lang.Object

io.smallrye.reactive.messaging.amqp.IncomingAmqpMetadata

public class IncomingAmqpMetadata
extends Object

Constructor Summary

Constructors

Constructor and Description
IncomingAmqpMetadata(io.vertx.amqp.AmqpMessage message)

Method Summary

Modifier and Type	Method and Description
String	getAddress() The AMQP address of the message.
String	getContentEncoding() The content-encoding property is used as a modifier to the content-type.
String	getContentType() The RFC-2046 MIME type for the message's application-data section (body).
String	getCorrelationId() This is a client-specific id that can be used to mark or identify messages between clients.
long	getCreationTime() An absolute time when this message was created.
org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations	getDeliveryAnnotations() The delivery annotations.
int	getDeliveryCount() The number of unsuccessful previous attempts to deliver this message.
long	getExpirationTime() Deprecated. Use getExpiryTime() instead
long	getExpiryTime() An absolute time when this message is considered to be expired.
org.apache.qpid.proton.amqp.messaging.Footer	getFooter() Transport footers for a message.
String	getGroupId() Identifies the group the message belongs to.
long	getGroupSequence() The relative position of this message within its group.
String	getId() The message-id, if set, uniquely identifies a message within the message system.
org.apache.qpid.proton.amqp.messaging.MessageAnnotations	getMessageAnnotations() The message annotations.
short	getPriority() This priority field contains the relative message priority.
io.vertx.core.json.JsonObject	getProperties() The application-properties section is a part of the bare message used for structured application data.
String	getReplyTo() The address of the node to send replies to.
String	getReplyToGroupId() This is a client-specific id that is used so that client can send replies to this message to a specific group.
String	getSubject() A common field for summary information about the message content and purpose.
long	getTtl() Duration in milliseconds for which the message is to be considered "live".
String	getUserId() The identity of the user responsible for producing the message.
boolean	isDurable() Whether the message is durable.
boolean	isFirstAcquirer() If this value is true, then this message has not been acquired by any other link.

Methods inherited from class java.lang.Object

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

Constructor Detail

IncomingAmqpMetadata

public IncomingAmqpMetadata(io.vertx.amqp.AmqpMessage message)

Method Detail

getAddress

public String getAddress()

The AMQP address of the message.

The address is stored in the to field which identifies the node that is the intended destination of the message. On any given transfer this might not be the node at the receiving end of the link.

Stored in the message properties.

Returns:

the address

getProperties

public io.vertx.core.json.JsonObject getProperties()

The application-properties section is a part of the bare message used for structured application data. Routers and brokers can use the data within this structure for the purposes of filtering or routing.

The keys of this map are restricted to be of type string and the values are restricted to be of simple types only, that is, excluding map, list, and array types.

API Note:

http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#type-application-properties

Returns:

the application properties

getContentType

public String getContentType()

The RFC-2046 MIME type for the message's application-data section (body). As per RFC-2046 this can contain a charset parameter defining the character encoding used: e.g., 'text/plain; charset="utf-8"'.

If the payload is known to be truly opaque binary data, the content-type should be set to application/octet-stream.

Stored in the message properties.

getContentEncoding

public String getContentEncoding()

The content-encoding property is used as a modifier to the content-type. When present, its value indicates what additional content encodings have been applied to the application-data, and thus what decoding mechanisms need to be applied in order to obtain the media-type referenced by the content-type header field.

Stored in the message properties.

Returns:

the content-encoding

getCreationTime

public long getCreationTime()

An absolute time when this message was created.

Stored in the message properties.

getDeliveryCount

public int getDeliveryCount()

The number of unsuccessful previous attempts to deliver this message. If this value is non-zero it can be taken as an indication that the delivery might be a duplicate. On first delivery, the value is zero. It is incremented upon an outcome being settled at the sender, according to rules defined for each outcome.

Stored in the message header

Returns:

the delivery count

getExpiryTime

public long getExpiryTime()

An absolute time when this message is considered to be expired.

Stored in the message properties.

Returns:

the expiry time, 0 is none

getGroupId

public String getGroupId()

Identifies the group the message belongs to.

Stored in the message properties.

Returns:

the group id if set

getGroupSequence

public long getGroupSequence()

The relative position of this message within its group.

Stored in the message properties.

Returns:

the sequence number, 0 if not set

getId

public String getId()

The message-id, if set, uniquely identifies a message within the message system. The message producer is usually responsible for setting the message-id in such a way that it is assured to be globally unique. A broker may discard a message as a duplicate if the value of the message-id matches that of a previously received message sent to the same node.

Stored in the message properties.

Returns:

the id

getUserId

public String getUserId()

The identity of the user responsible for producing the message. The client sets this value, and it may be authenticated by intermediaries.

Stored in the message properties.

Returns:

the user id

isDurable

public boolean isDurable()

Whether the message is durable.

Durable messages must not be lost even if an intermediary is unexpectedly terminated and restarted. A target which is not capable of fulfilling this guarantee must not accept messages where the durable header is set to true: if the source allows the rejected outcome then the message should be rejected with the precondition-failed error, otherwise the link must be detached by the receiver with the same error.

Stored in the message header.

Returns:

whether the message is marked as durable

isFirstAcquirer

public boolean isFirstAcquirer()

If this value is true, then this message has not been acquired by any other link. If this value is false, then this message may have previously been acquired by another link or links.

Stored in the message header.

Returns:

whether this message has been acquired by another link before.

getPriority

public short getPriority()

This priority field contains the relative message priority. Higher numbers indicate higher priority messages. Messages with higher priorities may be delivered before those with lower priorities.

Stored in the message header.

Returns:

the priority

getSubject

public String getSubject()

A common field for summary information about the message content and purpose.

Stored in the message properties.

Returns:

the subject if any

getReplyTo

public String getReplyTo()

The address of the node to send replies to.

Stored in the message properties.

Returns:

the reply-to address

getReplyToGroupId

public String getReplyToGroupId()

This is a client-specific id that is used so that client can send replies to this message to a specific group.

Stored in the message properties.

Returns:

the reply-to address

getCorrelationId

public String getCorrelationId()

This is a client-specific id that can be used to mark or identify messages between clients.

Stored in the message properties.

Returns:

the reply-to address

getTtl

public long getTtl()

Duration in milliseconds for which the message is to be considered "live". If this is set then a message expiration time will be computed based on the time of arrival at an intermediary. Messages that live longer than their expiration time will be discarded (or dead lettered). When a message is transmitted by an intermediary that was received with a ttl, the transmitted message's header SHOULD contain a ttl that is computed as the difference between the current time and the formerly computed message expiration time, i.e., t he reduced ttl, so that messages will eventually die if they end up in a delivery loop.

Stored in the message header

Returns:

the ttl, 0 if not set

getExpirationTime

@Deprecated
public long getExpirationTime()

Deprecated. Use getExpiryTime() instead

Returns:

the expiry time

getDeliveryAnnotations

public org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations getDeliveryAnnotations()

The delivery annotations.

The delivery-annotations section is used for delivery-specific non-standard properties at the head of the message. Delivery annotations convey information from the sending peer to the receiving peer. If the recipient does not understand the annotation it cannot be acted upon and its effects (such as any implied propagation) cannot be acted upon. Annotations might be specific to one implementation, or common to multiple implementations. The capabilities negotiated on link attach and on the source and target should be used to establish which annotations a peer supports. A registry of defined annotations and their meanings is maintained.

The symbolic key "rejected" is reserved for the use of communicating error information regarding rejected messages. Any values associated with the "rejected" key must be of type error.

If the delivery-annotations section is omitted, it is equivalent to a delivery-annotations section containing an empty map of annotations.

API Note:

http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#type-delivery-annotations

getMessageAnnotations

public org.apache.qpid.proton.amqp.messaging.MessageAnnotations getMessageAnnotations()

The message annotations.

The message-annotations section is used for properties of the message which are aimed at the infrastructure and should be propagated across every delivery step. Message annotations convey information about the message. Intermediaries must propagate the annotations unless the annotations are explicitly augmented or modified (e.g., by the use of the modified outcome).

The capabilities negotiated on link attach and on the source and target can be used to establish which annotations a peer understands; however, in a network of AMQP intermediaries it might not be possible to know if every intermediary will understand the annotation. Note that for some annotations it might not be necessary for the intermediary to understand their purpose, i.e., they could be used purely as an attribute which can be filtered on.

A registry of defined annotations and their meanings is maintained.

If the message-annotations section is omitted, it is equivalent to a message-annotations section containing an empty map of annotations.

API Note:

http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#type-message-annotations

getFooter

public org.apache.qpid.proton.amqp.messaging.Footer getFooter()

Transport footers for a message. The footer section is used for details about the message or delivery which can only be calculated or evaluated once the whole bare message has been constructed or seen (for example message hashes, HMACs, signatures and encryption details).