Package io.vertx.mutiny.amqp

Class AmqpMessage

java.lang.Object
io.vertx.mutiny.amqp.AmqpMessage
All Implemented Interfaces:
MutinyDelegate
public class AmqpMessage extends Object implements MutinyDelegate
Represents an AMQP message.

Reference about the different metadata can be found on AMQP message properties.

Note that the body is retrieved using body* method depending on the expected type.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

See Also:
  • AmqpMessage

  • Field Details

  • Constructor Details

    • AmqpMessage

      public AmqpMessage(io.vertx.amqp.AmqpMessage delegate)
      Create a new instance of AmqpMessage delegating to the given (non-null) instance of AmqpMessage.

    • AmqpMessage

      public AmqpMessage(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.amqp.AmqpMessage getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • create

      public static AmqpMessageBuilder create()
      Returns:
      a builder to create an AmqpMessage.

    • create

      public static AmqpMessageBuilder create(AmqpMessage existing)
      Creates a builder to create a new AmqpMessage copying the metadata from the passed message.
      Parameters:
      existing - an existing message, must not be null.
      Returns:
      a builder to create an AmqpMessage.

    • isDurable

      public boolean isDurable()
      Returns:
      whether or not the message is durable.
      See Also:

    • isFirstAcquirer

      public boolean isFirstAcquirer()
      Returns:
      if true, then this message has not been acquired by any other link. If false, then this message MAY have previously been acquired by another link or links.
      See Also:

    • priority

      public int priority()
      Returns:
      the relative message priority. Higher numbers indicate higher priority messages. Messages with higher priorities MAY be delivered before those with lower priorities.
      See Also:

    • deliveryCount

      public int deliveryCount()
      Returns:
      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.
      See Also:

    • ttl

      public long ttl()
      Returns:
      the duration in milliseconds for which the message is to be considered "live".
      See Also:

    • id

      public String id()
      Returns:
      the message id
      See Also:

    • address

      public String address()
      Returns:
      the message address, also named to field
      See Also:

    • replyTo

      public String replyTo()
      Returns:
      The address of the node to send replies to, if any.
      See Also:

    • correlationId

      public String correlationId()
      Returns:
      The client-specific id that can be used to mark or identify messages between clients.
      See Also:

    • isBodyNull

      public boolean isBodyNull()
      Returns:
      whether the body is null. This method returns true is the message does not contain a body or if the message contain a null AMQP value as body.

    • bodyAsBoolean

      public boolean bodyAsBoolean()
      Returns:
      the boolean value contained in the body. The value must be passed as AMQP value.

    • bodyAsByte

      public byte bodyAsByte()
      Returns:
      the byte value contained in the body. The value must be passed as AMQP value.

    • bodyAsShort

      public short bodyAsShort()
      Returns:
      the short value contained in the body. The value must be passed as AMQP value.

    • bodyAsInteger

      public int bodyAsInteger()
      Returns:
      the integer value contained in the body. The value must be passed as AMQP value.

    • bodyAsLong

      public long bodyAsLong()
      Returns:
      the long value contained in the body. The value must be passed as AMQP value.

    • bodyAsFloat

      public float bodyAsFloat()
      Returns:
      the float value contained in the body. The value must be passed as AMQP value.

    • bodyAsDouble

      public double bodyAsDouble()
      Returns:
      the double value contained in the body. The value must be passed as AMQP value.

    • bodyAsChar

      public char bodyAsChar()
      Returns:
      the character value contained in the body. The value must be passed as AMQP value.

    • bodyAsTimestamp

      public Instant bodyAsTimestamp()
      Returns:
      the timestamp value contained in the body. The value must be passed as AMQP value.

    • bodyAsUUID

      public UUID bodyAsUUID()
      Returns:
      the UUID value contained in the body. The value must be passed as AMQP value.

    • bodyAsBinary

      public io.vertx.core.buffer.Buffer bodyAsBinary()
      Returns:
      the bytes contained in the body. The value must be passed as AMQP data.

    • bodyAsString

      public String bodyAsString()
      Returns:
      the string value contained in the body. The value must be passed as AMQP value.

    • bodyAsSymbol

      public String bodyAsSymbol()
      Returns:
      the symbol value contained in the body. The value must be passed as AMQP value.

    • bodyAsList

      public <T> List<T> bodyAsList()
      Returns:
      the list of values contained in the body. The value must be passed as AMQP value.

    • bodyAsJsonObject

      public io.vertx.core.json.JsonObject bodyAsJsonObject()
      Returns:
      the JSON object contained in the body. The value must be passed as AMQP data.

    • bodyAsJsonArray

      public io.vertx.core.json.JsonArray bodyAsJsonArray()
      Returns:
      the JSON array contained in the body. The value must be passed as AMQP data.

    • subject

      public String subject()

    • contentType

      public String contentType()

    • contentEncoding

      public String contentEncoding()

    • expiryTime

      public long expiryTime()

    • creationTime

      public long creationTime()

    • groupId

      public String groupId()

    • replyToGroupId

      public String replyToGroupId()

    • groupSequence

      public long groupSequence()

    • applicationProperties

      public io.vertx.core.json.JsonObject applicationProperties()
      Returns:
      the message properties as JSON object.

    • accepted

      public AmqpMessage accepted()
      When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message. It marks the message as delivered with the accepted status.
      Returns:
      the current AmqpMessage object
      Throws:
      is - the current message is not a received message.

    • rejected

      public AmqpMessage rejected()
      When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message as rejected.
      Returns:
      the current AmqpMessage object
      Throws:
      is - the current message is not a received message.

    • released

      public AmqpMessage released()
      When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message as released.
      Returns:
      the current AmqpMessage object
      Throws:
      is - the current message is not a received message.

    • modified

      public AmqpMessage modified(boolean deliveryFailed, boolean undeliverableHere)
      When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message as modified.
      Parameters:
      deliveryFailed - pass true to increase the failed delivery count
      undeliverableHere - pass true to prevent re-delivery of this message to the same consumer
      Returns:
      the current AmqpMessage object
      Throws:
      is - the current message is not a received message.

    • newInstance

      public static AmqpMessage newInstance(io.vertx.amqp.AmqpMessage delegate)
      Creates a new instance of the AmqpMessage.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object