com.microsoft.azure.servicebus.MessageBody 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
There is a newer version: 3.6.7
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.azure.servicebus;

import java.io.Serializable;
import java.util.List;

/**
 * This class encapsulates the body of a message. Body types map to AMQP message body types.
 * It has getters and setters for multiple body types.
 * Client should test for body type before calling corresponding get method.
 * Get methods not corresponding to the type of the body return null.
 */
public class MessageBody implements Serializable {
    
    private static final long serialVersionUID = 7215009530928988502L;

    private MessageBodyType bodyType;
    private Object valueData;
    private List> sequenceData;
    private List binaryData;
    
    private MessageBody() { }
    
    /**
     * Creates message body of AMQPValue type.
     * @param value AMQPValue content of the message. It must be of a type supported by AMQP.
     * @return MessageBody instance wrapping around the value data.
     */
    public static MessageBody fromValueData(Object value) {
        if (value == null) {
            throw new IllegalArgumentException("Value data is null.");
        }

        MessageBody body = new MessageBody();
        body.bodyType = MessageBodyType.VALUE;
        body.valueData = value;
        body.sequenceData = null;
        body.binaryData = null;
        return body;
    }
    
    /**
     * Creates a message body from a list of AMQPSequence sections.Each AMQPSequence section is in turn a list of objects.
     * Please note that this version of the SDK supports only one AMQPSequence section in a message. It means only a list of exactly one sequence in it is accepted as message body.
     * @param sequenceData a list of AMQPSequence sections. Each AMQPSequence section is in turn a list of objects. Every object in each list must of a type supported by AMQP.
     * @return MessageBody instance wrapping around the sequence data.
     */
    public static MessageBody fromSequenceData(List> sequenceData) {
        if (sequenceData == null || sequenceData.size() == 0 || sequenceData.size() > 1) {
            throw new IllegalArgumentException("Sequence data is null or has more than one collection in it.");
        }

        MessageBody body = new MessageBody();
        body.bodyType = MessageBodyType.SEQUENCE;
        body.valueData = null;
        body.sequenceData = sequenceData;
        body.binaryData = null;
        return body;
    }
    
    /**
     * Creates a message body from a list of Data sections.Each Data section is a byte array.
     * Please note that this version of the SDK supports only one Data section in a message. It means only a list of exactly one byte array in it is accepted as message body.
     * @param binaryData a list of byte arrays.
     * @return MessageBody instance wrapping around the binary data.
     */
    public static MessageBody fromBinaryData(List binaryData) {
        if (binaryData == null || binaryData.size() == 0 || binaryData.size() > 1) {
            throw new IllegalArgumentException("Binary data is null or has more than one byte array in it.");
        }

        MessageBody body = new MessageBody();
        body.bodyType = MessageBodyType.BINARY;
        body.valueData = null;
        body.sequenceData = null;
        body.binaryData = binaryData;
        return body;
    }
    
    /**
     * Returns the content of message body.
     * @return value of message body only if the MessageBody is of Value type. Returns null otherwise.
     */
    public Object getValueData() {
        return valueData;
    }
    
    /**
     * Returns the content of message body.
     * @return a list of AMQPSequence sections only if the MessageBody is of Sequence type. Returns null otherwise. Each AMQPSequence section is in turn a list of objects.
     */
    public List> getSequenceData() {
        return sequenceData;
    }
    
    /**
     * Returns the content of message body.
     * @return message body as list of byte arrays only if the MessageBody is of Binary type. Returns null otherwise.
     */
    public List getBinaryData() {
        return binaryData;
    }
    
    /**
     * Return the type of content in this message body.
     * @return type of message content
     */
    public MessageBodyType getBodyType() {
        return bodyType;
    }
}