Package com.microsoft.azure.servicebus

Class Message

    • Constructor Detail

      • Message

        public Message()
        Creates an empty message with an empty byte array as body.

      • Message

        public Message​(String content)
        Creates a message from a string. For backward compatibility reasons, the string is converted to a byte array and message body type is set to binary.
        Parameters:
        content - content of the message.

      • Message

        public Message​(byte[] content)
        Creates a message from a byte array. Message body type is set to binary.
        Parameters:
        content - content of the message

      • Message

        public Message​(MessageBody body)
        Creates a message from message body.
        Parameters:
        body - message body

      • Message

        public Message​(String content,
               String contentType)
        Creates a message from a string. For backward compatibility reasons, the string is converted to a byte array and message body type is set to binary.
        Parameters:
        content - content of the message
        contentType - content type of the message

      • Message

        public Message​(byte[] content,
               String contentType)
        Creates a message from a byte array. Message body type is set to binary.
        Parameters:
        content - content of the message
        contentType - content type of the message

      • Message

        public Message​(MessageBody body,
               String contentType)
        Creates a message from message body.
        Parameters:
        body - message body
        contentType - content type of the message

      • Message

        public Message​(String messageId,
               String content,
               String contentType)
        Creates a message from a string. For backward compatibility reasons, the string is converted to a byte array and message body type is set to binary.
        Parameters:
        messageId - id of the message
        content - content of the message
        contentType - content type of the message

      • Message

        public Message​(String messageId,
               byte[] content,
               String contentType)
        Creates a message from a byte array. Message body type is set to binary.
        Parameters:
        messageId - id of the message
        content - content of the message
        contentType - content type of the message

      • Message

        public Message​(String messageId,
               MessageBody body,
               String contentType)
        Creates a message from message body.
        Parameters:
        messageId - id of the message
        body - message body
        contentType - content type of the message

    • Method Detail

      • getDeliveryCount

        public long getDeliveryCount()
        Description copied from interface: IMessage
        Gets the number of the times this message was delivered to clients. The count is incremented when a message lock expires, or the message is explicitly abandoned by the receiver. This property is read-only.
        Specified by:
        getDeliveryCount in interface IMessage
        Returns:
        delivery count of this message.
        See Also:
        Message transfers, locks, and settlement.

      • getMessageId

        public String getMessageId()
        Description copied from interface: IMessage
        Gets the Id of this message. The message identifier is an application-defined value that uniquely identifies the message and its payload. The identifier is a free-form string and can reflect a GUID or an identifier derived from the application context. If enabled, the duplicate detection feature identifies and removes second and further submissions of messages with the same MessageId.
        Specified by:
        getMessageId in interface IMessage
        Returns:
        Id of this message

      • getTimeToLive

        public Duration getTimeToLive()
        Description copied from interface: IMessage
        Gets the duration before this message expires. This value is the relative duration after which the message expires, starting from the instant the message has been accepted and stored by the broker, as captured in getEnqueuedTimeUtc. When not set explicitly, the assumed value is the DefaultTimeToLive set for the respective queue or topic. A message-level TimeToLive value cannot be longer than the entity's DefaultTimeToLive setting and it is silently adjusted if it does.
        Specified by:
        getTimeToLive in interface IMessage
        Returns:
        Time to Live duration of this message
        See Also:
        Message Expiration

      • setTimeToLive

        public void setTimeToLive​(Duration timeToLive)
        Description copied from interface: IMessage
        Sets the duration of time before this message expires.
        Specified by:
        setTimeToLive in interface IMessage
        Parameters:
        timeToLive - Time to Live duration of this message
        See Also:
        IMessage.getTimeToLive()

      • getContentType

        public String getContentType()
        Description copied from interface: IMessage
        Gets the content type of this message. Optionally describes the payload of the message, with a descriptor following the format of RFC2045, Section 5, for example "application/json". Note that content type is not same as message body type.
        Specified by:
        getContentType in interface IMessage
        Returns:
        content type of this message

      • getExpiresAtUtc

        public Instant getExpiresAtUtc()
        Description copied from interface: IMessage
        Gets the instant at which this message will expire. The value is the UTC instant for when the message is scheduled for removal and will no longer available for retrieval from the entity due to expiration. Expiry is controlled by the TimeToLive property. This property is computed from EnqueuedTimeUtc+TimeToLive.
        Specified by:
        getExpiresAtUtc in interface IMessage
        Returns:
        instant at which this message expires
        See Also:
        Message Expiration

      • getLockedUntilUtc

        public Instant getLockedUntilUtc()
        Description copied from interface: IMessage
        Gets the instant at which the lock of this message expires. For messages retrieved under a lock (peek-lock receive mode, not pre-settled) this property reflects the UTC instant until which the message is held locked in the queue/subscription. When the lock expires, the DeliveryCount is incremented and the message is again available for retrieval. This property is read-only.
        Specified by:
        getLockedUntilUtc in interface IMessage
        Returns:
        the instant at which the lock of this message expires if the message is received using PEEKLOCK mode. Otherwise it returns null.
        See Also:
        Message transfers, locks, and settlement

      • setLockedUntilUtc

        public void setLockedUntilUtc​(Instant lockedUntilUtc)

      • getEnqueuedTimeUtc

        public Instant getEnqueuedTimeUtc()
        Description copied from interface: IMessage
        Gets the instant at which this message was enqueued in Azure Service Bus. The UTC instant at which the message has been accepted and stored in the entity. For scheduled messages, this reflects the time when the message was activated. This value can be used as an authoritative and neutral arrival time indicator when the receiver does not want to trust the sender's clock. This property is read-only.
        Specified by:
        getEnqueuedTimeUtc in interface IMessage
        Returns:
        the instant at which the message was enqueued in Azure Service Bus
        See Also:
        Message Sequencing and Timestamps

      • getSequenceNumber

        public long getSequenceNumber()
        Description copied from interface: IMessage
        Gets the unique number assigned to a message by Service Bus. The sequence number is a unique 64-bit integer assigned to a message as it is accepted and stored by the broker and functions as its true identifier. For partitioned entities, the topmost 16 bits reflect the partition identifier. Sequence numbers monotonically increase and are gapless. They roll over to 0 when the 48-64 bit range is exhausted. This property is read-only.
        Specified by:
        getSequenceNumber in interface IMessage
        Returns:
        sequence number of this message
        See Also:
        Message Sequencing and Timestamps

      • getSessionId

        public String getSessionId()
        Description copied from interface: IMessage
        Gets the session identifier for a session-aware entity. For session-aware entities, this application-defined value specifies the session affiliation of the message. Messages with the same session identifier are subject to summary locking and enable exact in-order processing and demultiplexing. For session-unaware entities, this value is ignored.
        Specified by:
        getSessionId in interface IMessage
        Returns:
        session id of this message
        See Also:
        Message Sessions

      • setSessionId

        public void setSessionId​(String sessionId)
        Description copied from interface: IMessage
        Sets the session identifier for a session-aware entity.
        Specified by:
        setSessionId in interface IMessage
        Parameters:
        sessionId - session id of this message
        See Also:
        IMessage.getSessionId()

      • getProperties

        public Map<String,​Object> getProperties()
        Description copied from interface: IMessage
        Gets the map of user application properties of this message. Client applications can set user properties (headers) on the message using this map.
        Specified by:
        getProperties in interface IMessage
        Returns:
        the map of user application properties of this message
        See Also:
        Messages, payloads, and serialization

      • setProperties

        public void setProperties​(Map<String,​Object> properties)
        Description copied from interface: IMessage
        Sets the map of user application properties of this message. Client applications can set user properties on the message using this map.
        Specified by:
        setProperties in interface IMessage
        Parameters:
        properties - the map of user application properties of this message
        See Also:
        IMessage.getProperties()

      • getCorrelationId

        public String getCorrelationId()
        Description copied from interface: IMessage
        Gets a correlation identifier. Allows an application to specify a context for the message for the purposes of correlation, for example reflecting the MessageId of a message that is being replied to.
        Specified by:
        getCorrelationId in interface IMessage
        Returns:
        correlation Id of this message
        See Also:
        Message Routing and Correlation

      • getTo

        public String getTo()
        Description copied from interface: IMessage
        Gets the "to" address.
        Specified by:
        getTo in interface IMessage
        Returns:
        To property value of this message

      • setTo

        public void setTo​(String to)
        Description copied from interface: IMessage
        Sets the "to" address. This property is reserved for future use in routing scenarios and presently ignored by the broker itself. Applications can use this value in rule-driven auto-forward chaining scenarios to indicate the intended logical destination of the message.
        Specified by:
        setTo in interface IMessage
        Parameters:
        to - To property value of this message

      • getReplyTo

        public String getReplyTo()
        Description copied from interface: IMessage
        Gets the address of an entity to send replies to. This optional and application-defined value is a standard way to express a reply path to the receiver of the message. When a sender expects a reply, it sets the value to the absolute or relative path of the queue or topic it expects the reply to be sent to.
        Specified by:
        getReplyTo in interface IMessage
        Returns:
        ReplyTo property value of this message
        See Also:
        Message Routing and Correlation

      • setReplyTo

        public void setReplyTo​(String replyTo)
        Description copied from interface: IMessage
        Sets the address of an entity to send replies to.
        Specified by:
        setReplyTo in interface IMessage
        Parameters:
        replyTo - ReplyTo property value of this message
        See Also:
        IMessage.getReplyTo()

      • getLabel

        public String getLabel()
        Description copied from interface: IMessage
        Gets the application specific message label. This property enables the application to indicate the purpose of the message to the receiver in a standardized fashion, similar to an email subject line. The mapped AMQP property is "subject".
        Specified by:
        getLabel in interface IMessage
        Returns:
        Label property value of this message

      • setLabel

        public void setLabel​(String label)
        Description copied from interface: IMessage
        Sets an application specific message label.
        Specified by:
        setLabel in interface IMessage
        Parameters:
        label - Label property value of this message
        See Also:
        IMessage.getLabel()

      • getReplyToSessionId

        public String getReplyToSessionId()
        Description copied from interface: IMessage
        Gets or sets a session identifier augmenting the ReplyTo address. This value augments the ReplyTo information and specifies which SessionId should be set for the reply when sent to the reply entity.
        Specified by:
        getReplyToSessionId in interface IMessage
        Returns:
        ReplyToSessionId property value of this message
        See Also:
        Message Routing and Correlation

      • setReplyToSessionId

        public void setReplyToSessionId​(String replyToSessionId)
        Description copied from interface: IMessage
        Gets or sets a session identifier augmenting the ReplyTo address.
        Specified by:
        setReplyToSessionId in interface IMessage
        Parameters:
        replyToSessionId - ReplyToSessionId property value of this message

      • getScheduledEnqueuedTimeUtc

        @Deprecated
public Instant getScheduledEnqueuedTimeUtc()
        Deprecated.
        Description copied from interface: IMessage
        Gets the scheduled enqueue time of this message. This value is used for delayed message availability. The message is safely added to the queue, but is not considered active and therefore not retrievable until the scheduled enqueue time. Mind that the message may not be activated (enqueued) at the exact given instant; the actual activation time depends on the queue's workload and its state.
        Specified by:
        getScheduledEnqueuedTimeUtc in interface IMessage
        Returns:
        the instant at which the message will be enqueued in Azure Service Bus
        See Also:
        Message Sequencing and Timestamps

      • getScheduledEnqueueTimeUtc

        public Instant getScheduledEnqueueTimeUtc()
        Description copied from interface: IMessage
        Gets the scheduled enqueue time of this message. This value is used for delayed message availability. The message is safely added to the queue, but is not considered active and therefore not retrievable until the scheduled enqueue time. Mind that the message may not be activated (enqueued) at the exact given instant; the actual activation time depends on the queue's workload and its state.
        Specified by:
        getScheduledEnqueueTimeUtc in interface IMessage
        Returns:
        the instant at which the message will be enqueued in Azure Service Bus
        See Also:
        Message Sequencing and Timestamps

      • getPartitionKey

        public String getPartitionKey()
        Description copied from interface: IMessage
        Gets the partition key for sending a message to a partitioned entity. For partitioned entities, setting this value enables assigning related messages to the same internal partition, so that submission sequence order is correctly recorded. The partition is chosen by a hash function over this value and cannot be chosen directly. For session-aware entities, the SessionId property overrides this value.
        Specified by:
        getPartitionKey in interface IMessage
        Returns:
        partition key of this message
        See Also:
        Partitioned entities

      • setPartitionKey

        public void setPartitionKey​(String partitionKey)
        Description copied from interface: IMessage
        Sets a partition key for sending a message to a partitioned entity
        Specified by:
        setPartitionKey in interface IMessage
        Parameters:
        partitionKey - partition key of this message
        See Also:
        IMessage.getPartitionKey()

      • getViaPartitionKey

        public String getViaPartitionKey()
        Description copied from interface: IMessage
        Gets the partition key for sending a message to a entity via another partitioned transfer entity. If a message is sent via a transfer queue in the scope of a transaction, this value selects the transfer queue partition: This is functionally equivalent to IMessage.getPartitionKey() and ensures that messages are kept together and in order as they are transferred.
        Specified by:
        getViaPartitionKey in interface IMessage
        Returns:
        partition key on the via queue.
        See Also:
        Transfers and Send Via

      • setViaPartitionKey

        public void setViaPartitionKey​(String partitionKey)
        Description copied from interface: IMessage
        Sets a via-partition key for sending a message to a destination entity via another partitioned entity
        Specified by:
        setViaPartitionKey in interface IMessage
        Parameters:
        partitionKey - via-partition key of this message
        See Also:
        IMessage.getViaPartitionKey()

      • getDeadLetterSource

        public String getDeadLetterSource()
        Description copied from interface: IMessage
        Gets the name of the queue or subscription that this message was enqueued on, before it was deadlettered. This value is only set in messages that have been dead-lettered and subsequently auto-forwarded from the dead-letter queue to another entity. Indicates the entity in which the message was dead-lettered. This property is read-only.
        Specified by:
        getDeadLetterSource in interface IMessage
        Returns:
        dead letter source of this message
        See Also:
        Dead-letter queues

      • getLockToken

        public UUID getLockToken()
        Description copied from interface: IMessage
        Gets the lock token for the current message. The lock token is a reference to the lock that is being held by the broker in PEEKLOCK mode. Locks are used to explicitly settle messages as explained in the product documentation in more detail. The token can also be used to pin the lock permanently through the Deferral API and, with that, take the message out of the regular delivery state flow. This property is read-only.
        Specified by:
        getLockToken in interface IMessage
        Returns:
        lock token of this message.
        See Also:
        Message transfers, locks, and settlement

      • setBody

        @Deprecated
public void setBody​(byte[] body)
        Deprecated.
        Description copied from interface: IMessage
        Sets the body of this message as a byte array.
        Specified by:
        setBody in interface IMessage
        Parameters:
        body - body of this message
        See Also:
        IMessage.getBody()

      • createCopy

        public IMessage createCopy()
        Description copied from interface: IMessage
        Creates a shallow copy of this message.
        Specified by:
        createCopy in interface IMessage
        Returns:
        copy of this message