Package com.azure.core.amqp

Enum AmqpMessageConstant

java.lang.Object
java.lang.Enum<AmqpMessageConstant>
com.azure.core.amqp.AmqpMessageConstant
All Implemented Interfaces:
Serializable, Comparable<AmqpMessageConstant>, java.lang.constant.Constable
public enum AmqpMessageConstant extends Enum<AmqpMessageConstant>
Reserved well-known constants from AMQP protocol.
See Also:

  • Enum Constant Details

    • MESSAGE_ID

      public static final AmqpMessageConstant MESSAGE_ID
      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.

    • USER_ID

      public static final AmqpMessageConstant USER_ID
      The identity of the user responsible for producing the message. The client sets this value, and it MAY be authenticated by intermediaries.

    • TO

      public static final AmqpMessageConstant TO
      The to field 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.

    • SUBJECT

      public static final AmqpMessageConstant SUBJECT
      A common field for summary information about the message content and purpose.

    • REPLY_TO

      public static final AmqpMessageConstant REPLY_TO
      The address of the node to send replies to.

    • CORRELATION_ID

      public static final AmqpMessageConstant CORRELATION_ID
      This is a client-specific id that can be used to mark or identify messages between clients.

    • CONTENT_TYPE

      public static final AmqpMessageConstant CONTENT_TYPE
      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"'.

    • CONTENT_ENCODING

      public static final AmqpMessageConstant CONTENT_ENCODING
      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.

    • ABSOLUTE_EXPIRY_TIME

      public static final AmqpMessageConstant ABSOLUTE_EXPIRY_TIME
      An absolute time when this message is considered to be expired.

    • CREATION_TIME

      public static final AmqpMessageConstant CREATION_TIME
      An absolute time when this message was created.

    • GROUP_ID

      public static final AmqpMessageConstant GROUP_ID
      Identifies the group the message belongs to.

    • GROUP_SEQUENCE

      public static final AmqpMessageConstant GROUP_SEQUENCE
      The relative position of this message within its group.

    • REPLY_TO_GROUP_ID

      public static final AmqpMessageConstant REPLY_TO_GROUP_ID
      This is a client-specific id that is used so that client can send replies to this message to a specific group.

    • OFFSET_ANNOTATION_NAME

      public static final AmqpMessageConstant OFFSET_ANNOTATION_NAME
      The offset of a message within a given partition.

    • ENQUEUED_TIME_UTC_ANNOTATION_NAME

      public static final AmqpMessageConstant ENQUEUED_TIME_UTC_ANNOTATION_NAME
      The date and time, in UTC, that a message was enqueued.

    • PARTITION_KEY_ANNOTATION_NAME

      public static final AmqpMessageConstant PARTITION_KEY_ANNOTATION_NAME
      The identifier associated with a given partition.

    • SEQUENCE_NUMBER_ANNOTATION_NAME

      public static final AmqpMessageConstant SEQUENCE_NUMBER_ANNOTATION_NAME
      The sequence number assigned to a message.

    • PUBLISHER_ANNOTATION_NAME

      public static final AmqpMessageConstant PUBLISHER_ANNOTATION_NAME
      The name of the entity that published a message.

    • SCHEDULED_ENQUEUE_UTC_TIME_NAME

      public static final AmqpMessageConstant SCHEDULED_ENQUEUE_UTC_TIME_NAME
      The name representing scheduled enqueue time.

    • VIA_PARTITION_KEY_ANNOTATION_NAME

      public static final AmqpMessageConstant VIA_PARTITION_KEY_ANNOTATION_NAME
      The identifier associated with a given via-partition.

    • LOCKED_UNTIL_KEY_ANNOTATION_NAME

      public static final AmqpMessageConstant LOCKED_UNTIL_KEY_ANNOTATION_NAME
      The identifier for locked until.

    • DEAD_LETTER_SOURCE_KEY_ANNOTATION_NAME

      public static final AmqpMessageConstant DEAD_LETTER_SOURCE_KEY_ANNOTATION_NAME
      The identifier for deadletter source.

    • ENQUEUED_SEQUENCE_NUMBER_ANNOTATION_NAME

      public static final AmqpMessageConstant ENQUEUED_SEQUENCE_NUMBER_ANNOTATION_NAME
      The name representing enqueue sequence number. This one appears to always be 0, but is always returned with each message.

    • DEAD_LETTER_DESCRIPTION_ANNOTATION_NAME

      public static final AmqpMessageConstant DEAD_LETTER_DESCRIPTION_ANNOTATION_NAME
      The identifier for deadletter description.

    • DEAD_LETTER_REASON_ANNOTATION_NAME

      public static final AmqpMessageConstant DEAD_LETTER_REASON_ANNOTATION_NAME
      The identifier for deadletter reason.

    • MESSAGE_STATE_ANNOTATION_NAME

      public static final AmqpMessageConstant MESSAGE_STATE_ANNOTATION_NAME
      The state of message.

  • Method Details

    • values

      public static AmqpMessageConstant[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static AmqpMessageConstant valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public String getValue()
      Gets the AMQP messaging header value.
      Returns:
      The AMQP header value for this messaging constant.

    • fromString

      public static AmqpMessageConstant fromString(String value)
      Parses an header value to its message constant.
      Parameters:
      value - the messaging header value to parse.
      Returns:
      the parsed MessageConstant object, or null if unable to parse.
      Throws:
      NullPointerException - if constant is null.