Package org.apache.qpid.proton.message

Interface Message

All Known Subinterfaces:
ProtonJMessage
All Known Implementing Classes:
MessageImpl
public interface Message
Represents a Message within Proton. Create instances of Message using Message.Factory.

  • Field Details

  • Method Details

    • isDurable

      boolean isDurable()

    • getDeliveryCount

      long getDeliveryCount()

    • getPriority

      short getPriority()

    • isFirstAcquirer

      boolean isFirstAcquirer()

    • getTtl

      long getTtl()

    • setDurable

      void setDurable(boolean durable)

    • setTtl

      void setTtl(long ttl)

    • setDeliveryCount

      void setDeliveryCount(long deliveryCount)

    • setFirstAcquirer

      void setFirstAcquirer(boolean firstAcquirer)

    • setPriority

      void setPriority(short priority)

    • getMessageId

      Object getMessageId()

    • getGroupSequence

      long getGroupSequence()

    • getReplyToGroupId

      String getReplyToGroupId()

    • getCreationTime

      long getCreationTime()

    • getAddress

      String getAddress()

    • getUserId

      byte[] getUserId()

    • getReplyTo

      String getReplyTo()

    • getGroupId

      String getGroupId()

    • getContentType

      String getContentType()

    • getExpiryTime

      long getExpiryTime()

    • getCorrelationId

      Object getCorrelationId()

    • getContentEncoding

      String getContentEncoding()

    • getSubject

      String getSubject()

    • setGroupSequence

      void setGroupSequence(long groupSequence)

    • setUserId

      void setUserId(byte[] userId)

    • setCreationTime

      void setCreationTime(long creationTime)

    • setSubject

      void setSubject(String subject)

    • setGroupId

      void setGroupId(String groupId)

    • setAddress

      void setAddress(String to)

    • setExpiryTime

      void setExpiryTime(long absoluteExpiryTime)

    • setReplyToGroupId

      void setReplyToGroupId(String replyToGroupId)

    • setContentEncoding

      void setContentEncoding(String contentEncoding)

    • setContentType

      void setContentType(String contentType)

    • setReplyTo

      void setReplyTo(String replyTo)

    • setCorrelationId

      void setCorrelationId(Object correlationId)

    • setMessageId

      void setMessageId(Object messageId)

    • getHeader

      Header getHeader()

    • getDeliveryAnnotations

      DeliveryAnnotations getDeliveryAnnotations()

    • getMessageAnnotations

      MessageAnnotations getMessageAnnotations()

    • getProperties

      Properties getProperties()

    • getApplicationProperties

      ApplicationProperties getApplicationProperties()

    • getBody

      Section getBody()

    • getFooter

      Footer getFooter()

    • setHeader

      void setHeader(Header header)

    • setDeliveryAnnotations

      void setDeliveryAnnotations(DeliveryAnnotations deliveryAnnotations)

    • setMessageAnnotations

      void setMessageAnnotations(MessageAnnotations messageAnnotations)

    • setProperties

      void setProperties(Properties properties)

    • setApplicationProperties

      void setApplicationProperties(ApplicationProperties applicationProperties)

    • setBody

      void setBody(Section body)

    • setFooter

      void setFooter(Footer footer)

    • decode

      int decode(byte[] data, int offset, int length)
      TODO describe what happens if the data does not represent a complete message. Currently this appears to leave the message in an unknown state.

    • decode

      void decode(ReadableBuffer buffer)
      Decodes the Message from the given ReadableBuffer.

      If the buffer given does not contain the fully encoded Message bytes for decode this method will throw an exception to indicate the buffer underflow condition and the message object will be left in an undefined state.

      Parameters:
      buffer - A ReadableBuffer that contains the complete message bytes.

    • encode

      int encode(byte[] data, int offset, int length)
      Encodes up to length bytes of the message into the provided byte array, starting at position offset. TODO describe what happens if length is smaller than the encoded form, Currently Proton-J throws an exception. What does Proton-C do?
      Returns:
      the number of bytes written to the byte array

    • encode

      int encode(WritableBuffer buffer)
      Encodes the current Message contents into the given WritableBuffer instance.

      This method attempts to encode all message data into the WritableBuffer and if the buffer has insufficient space it will throw an exception to indicate the buffer overflow condition. If successful the method returns the number of bytes written to the provided buffer to fully encode the message.

      Parameters:
      buffer - The WritableBuffer instance to encode the message contents into.
      Returns:
      the number of bytes written to fully encode the message.

    • clear

      void clear()

    • getError

      MessageError getError()