com.microsoft.azure.sdk.iot.device.transport.https

Class HttpsBatchMessage

java.lang.Object

com.microsoft.azure.sdk.iot.device.transport.https.HttpsBatchMessage

All Implemented Interfaces:

HttpsMessage

public final class HttpsBatchMessage
extends Object
implements HttpsMessage

Builds a batched IoT Hub request body as a JSON array. The batched message has a maximum size of 256 kb.

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	BATCH_CHARSET The charset used to encode IoT Hub messages.
protected String	batchBody The current batched message body.
static String	HTTPS_BATCH_CONTENT_TYPE The value for the "content-type" header field in a batched HTTPS request.
protected int	numMsgs The current number of messages in the batch.
static int	SERVICEBOUND_MESSAGE_MAX_SIZE_BYTES

Fields inherited from interface com.microsoft.azure.sdk.iot.device.transport.https.HttpsMessage

HTTPS_APP_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor and Description
HttpsBatchMessage() Constructor.

Method Summary

Modifier and Type	Method and Description
protected static String	addJsonObjToArray(String jsonObj, String jsonArray) Adds a JSON object to a JSON array.
void	addMessage(HttpsSingleMessage msg) Adds a message to the batch.
byte[]	getBody() Returns the current batch body as a UTF-8 encoded byte array.
String	getContentType() Returns the message content-type as 'application/vnd.microsoft.iothub.json'.
MessageProperty[]	getProperties() Returns an empty list of properties for the batched message.
protected static String	msgToJson(HttpsSingleMessage msg) Converts a service-bound message to a JSON object with the correct format.
int	numMessages() Returns the number of messages currently in the batch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVICEBOUND_MESSAGE_MAX_SIZE_BYTES

public static final int SERVICEBOUND_MESSAGE_MAX_SIZE_BYTES

See Also:

Constant Field Values

HTTPS_BATCH_CONTENT_TYPE

public static String HTTPS_BATCH_CONTENT_TYPE

The value for the "content-type" header field in a batched HTTPS request.

BATCH_CHARSET

public static Charset BATCH_CHARSET

The charset used to encode IoT Hub messages. The server will interpret the JSON array using UTF-8 by default according to RFC4627.

batchBody

protected String batchBody

The current batched message body.

numMsgs

protected int numMsgs

The current number of messages in the batch.

Constructor Detail

HttpsBatchMessage

public HttpsBatchMessage()

Constructor. Initializes the batch body as an empty JSON array.

Method Detail

addMessage

public void addMessage(HttpsSingleMessage msg)
                throws SizeLimitExceededException

Adds a message to the batch.

Parameters:

msg - the message to be added.

Throws:

SizeLimitExceededException - if adding the message causes the batched message to exceed 256 kb in size. The batched message will remain as if the message was never added.

getBody

public byte[] getBody()

Returns the current batch body as a UTF-8 encoded byte array.

Specified by:

getBody in interface HttpsMessage

Returns:

the current batch body as a UTF-8 encoded byte array.

getContentType

public String getContentType()

Returns the message content-type as 'application/vnd.microsoft.iothub.json'.

Specified by:

getContentType in interface HttpsMessage

Returns:

the message content-type as 'application/vnd.microsoft.iothub.json'.

getProperties

public MessageProperty[] getProperties()

Returns an empty list of properties for the batched message.

Specified by:

getProperties in interface HttpsMessage

Returns:

an empty list of properties for the batched message.

numMessages

public int numMessages()

Returns the number of messages currently in the batch.

Returns:

the number of messages currently in the batch.

msgToJson

protected static String msgToJson(HttpsSingleMessage msg)

Converts a service-bound message to a JSON object with the correct format.

Parameters:

msg - the message to be converted to a corresponding JSON object.

Returns:

the JSON string representation of the message.

addJsonObjToArray

protected static String addJsonObjToArray(String jsonObj,
                                          String jsonArray)

Adds a JSON object to a JSON array.

Parameters:

jsonObj - the object to be added to the JSON array.

jsonArray - the JSON array.

Returns:

the JSON string representation of the JSON array with the object added.