com.microsoft.azure.servicebus.Message Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-servicebus Show documentation
Java library for Azure Service Bus
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.azure.servicebus;

import java.io.Serializable;
import java.nio.charset.Charset;
import java.time.Duration;
import java.time.Instant;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

public final class Message implements Serializable, IMessage {
    private static final long serialVersionUID = 7849508139219590863L;
    private static final Charset DEFAULT_CHAR_SET = Charset.forName("UTF-8");
    private static final String DEFAULT_CONTENT_TYPE = null;

    private static final MessageBody DEFAULT_CONTENT = Utils.fromBinay(new byte[0]);

    private long deliveryCount;

    private String messageId;

    private Duration timeToLive;

    private MessageBody messageBody;

    private String contentType;

    private String sessionId;

    private long sequenceNumber;

    private Instant enqueuedTimeUtc;

    private Instant scheduledEnqueueTimeUtc;

    private Instant lockedUntilUtc;

    private Map properties;

    private String correlationId;

    private String replyToSessionId;

    private String label;

    private String to;

    private String replyTo;

    private String partitionKey;

    private String viaPartitionKey;

    private String deadLetterSource;

    private UUID lockToken;

    private byte[] deliveryTag;

    /**
     * Creates an empty message with an empty byte array as body.
     */
    public Message() {
        this(DEFAULT_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.
     * @param content content of the message.
     */
    public Message(String content) {
        this(content.getBytes(DEFAULT_CHAR_SET));
    }

    /**
     * Creates a message from a byte array. Message body type is set to binary.
     * @param content content of the message
     */
    public Message(byte[] content) {
        this(Utils.fromBinay(content));
    }

    /**
     * Creates a message from message body.
     * @param body message body
     */
    public Message(MessageBody body) {
        this(body, DEFAULT_CONTENT_TYPE);
    }

    /**
     * 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.
     * @param content content of the message
     * @param contentType content type of the message
     */
    public Message(String content, String contentType) {
        this(content.getBytes(DEFAULT_CHAR_SET), contentType);
    }

    /**
     * Creates a message from a byte array. Message body type is set to binary.
     * @param content content of the message
     * @param contentType content type of the message
     */
    public Message(byte[] content, String contentType) {
        this(Utils.fromBinay(content), contentType);
    }

    /**
     * Creates a message from message body.
     * @param body message body
     * @param contentType content type of the message
     */
    public Message(MessageBody body, String contentType) {
        this(UUID.randomUUID().toString(), body, 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.
     * @param messageId id of the message
     * @param content content of the message
     * @param contentType content type of the message
     */
    public Message(String messageId, String content, String contentType) {
        this(messageId, content.getBytes(DEFAULT_CHAR_SET), contentType);
    }

    /**
     * Creates a message from a byte array. Message body type is set to binary.
     * @param messageId id of the message
     * @param content content of the message
     * @param contentType content type of the message
     */
    public Message(String messageId, byte[] content, String contentType) {
        this(messageId, Utils.fromBinay(content), contentType);
    }

    /**
     * Creates a message from message body.
     * @param messageId id of the message
     * @param body message body
     * @param contentType content type of the message
     */
    public Message(String messageId, MessageBody body, String contentType) {
        this.messageId = messageId;
        this.messageBody = body;
        this.contentType = contentType;
        this.properties = new HashMap<>();
    }

    @Override
    public long getDeliveryCount() {
        return deliveryCount;
    }

    void setDeliveryCount(long deliveryCount) {
        this.deliveryCount = deliveryCount;
    }

    @Override
    public String getMessageId() {
        return messageId;
    }

    @Override
    public void setMessageId(String messageId) {
        this.messageId = messageId;
    }

    @Override
    public Duration getTimeToLive() {
        return timeToLive;
    }

    @Override
    public void setTimeToLive(Duration timeToLive) {
    	if (timeToLive.isZero() || timeToLive.isNegative()) {
    		throw new IllegalArgumentException("timeToLive must be positive duration.");
    	}
        this.timeToLive = timeToLive;
    }

    @Override
    public String getContentType() {
        return this.contentType;
    }

    @Override
    public void setContentType(String contentType) {
        this.contentType = contentType;
    }

    @Override
    public Instant getExpiresAtUtc() {
    	if (this.enqueuedTimeUtc == null) {
    		return null;
    	} 
    	else if (this.timeToLive == null) {
    		return this.enqueuedTimeUtc;
    	} 
    	else {
    		return this.enqueuedTimeUtc.plus(this.timeToLive);
    	}
    }

    @Override
    public Instant getLockedUntilUtc() {
        return this.lockedUntilUtc;
    }

    public void setLockedUntilUtc(Instant lockedUntilUtc) {
        this.lockedUntilUtc = lockedUntilUtc;
    }

    @Override
    public Instant getEnqueuedTimeUtc() {
        return this.enqueuedTimeUtc;
    }

    void setEnqueuedTimeUtc(Instant enqueuedTimeUtc) {
        this.enqueuedTimeUtc = enqueuedTimeUtc;
    }

    @Override
    public long getSequenceNumber() {
        return this.sequenceNumber;
    }

    void setSequenceNumber(long sequenceNumber) {
        this.sequenceNumber = sequenceNumber;
    }

    @Override
    public String getSessionId() {
        return this.sessionId;
    }

    @Override
    public void setSessionId(String sessionId) {
        this.sessionId = sessionId;
        this.partitionKey = sessionId;
    }

    @Override
    public Map getProperties() {
        return this.properties;
    }

    @Override
    public void setProperties(Map properties) {
        this.properties = properties;
    }

    @Override
    public String getCorrelationId() {
        return this.correlationId;
    }

    @Override
    public void setCorrelationId(String correlationId) {
        this.correlationId = correlationId;
    }

    @Override
    public String getTo() {
        return this.to;
    }

    @Override
    public void setTo(String to) {
        this.to = to;
    }

    @Override
    public String getReplyTo() {
        return this.replyTo;
    }

    @Override
    public void setReplyTo(String replyTo) {
        this.replyTo = replyTo;
    }

    @Override
    public String getLabel() {
        return this.label;
    }

    @Override
    public void setLabel(String label) {
        this.label = label;
    }

    @Override
    public String getReplyToSessionId() {
        return this.replyToSessionId;
    }

    @Override
    public void setReplyToSessionId(String replyToSessionId) {
        this.replyToSessionId = replyToSessionId;
    }

    @Deprecated
    @Override
    public Instant getScheduledEnqueuedTimeUtc() {
        return this.getScheduledEnqueueTimeUtc();
    }

    @Deprecated
    @Override
    public void setScheduledEnqueuedTimeUtc(Instant scheduledEnqueueTimeUtc) {
        this.setScheduledEnqueueTimeUtc(scheduledEnqueueTimeUtc);
    }

    @Override
    public Instant getScheduledEnqueueTimeUtc() {
        return this.scheduledEnqueueTimeUtc;
    }

    @Override
    public void setScheduledEnqueueTimeUtc(Instant scheduledEnqueueTimeUtc) {
        this.scheduledEnqueueTimeUtc = scheduledEnqueueTimeUtc;
    }

    @Override
    public String getPartitionKey() {
        return this.partitionKey;
    }

    @Override
    public void setPartitionKey(String partitionKey) {
    	if (this.sessionId != null && !this.sessionId.equals(partitionKey))
    	{
    		// SessionId is set. Then partition key must be same as session id.
    		throw new IllegalArgumentException("PartitionKey:" + partitionKey +" is not same as SessionId:" + this.sessionId);
    	}
        this.partitionKey = partitionKey;
    }

    @Override
    public String getViaPartitionKey() {
        return this.viaPartitionKey;
    }

    @Override
    public void setViaPartitionKey(String partitionKey) {
        this.viaPartitionKey = partitionKey;
    }

    @Override
    public String getDeadLetterSource() {
        return this.deadLetterSource;
    }

    void setDeadLetterSource(String deadLetterSource) {
        this.deadLetterSource = deadLetterSource;
    }

    @Override
    public UUID getLockToken() {
        return this.lockToken;
    }

    void setLockToken(UUID lockToken) {
        this.lockToken = lockToken;
    }

    byte[] getDeliveryTag() {
        return this.deliveryTag;
    }

    void setDeliveryTag(byte[] deliveryTag) {
        this.deliveryTag = deliveryTag;
    }

    @Override
    @Deprecated
    public byte[] getBody() {
        return Utils.getDataFromMessageBody(this.messageBody);
    }

    @Override
    @Deprecated
    public void setBody(byte[] body) {
        this.messageBody = Utils.fromBinay(body);
    }

    @Override
    public MessageBody getMessageBody() {
        return this.messageBody;
    }

    @Override
    public void setMessageBody(MessageBody body) {
        this.messageBody = body;
    }

    @Override
    public IMessage createCopy() {
        Message copy = new Message(this.getMessageBody(), this.getContentType());
        copy.setProperties(this.getProperties()); // Retain the same properties

        copy.setMessageId(this.getMessageId());
        copy.setCorrelationId(this.getCorrelationId());
        copy.setTo(this.getTo());
        copy.setReplyTo(this.getReplyTo());
        copy.setLabel(this.getLabel());
        copy.setReplyToSessionId(this.getReplyToSessionId());
        copy.setSessionId(this.getSessionId());
        copy.setScheduledEnqueueTimeUtc(this.getScheduledEnqueueTimeUtc());
        copy.setPartitionKey(this.getPartitionKey());
        copy.setTimeToLive(this.getTimeToLive());

        return copy;
    }
}