com.microsoft.azure.sdk.iot.service

Class Message

java.lang.Object

com.microsoft.azure.sdk.iot.service.Message

public class Message
extends Object

IotHub specific message container

Field Summary

Fields

Modifier and Type	Field and Description
String	correlationId Used in message responses and feedback

Constructor Summary

Constructors

Constructor and Description
Message() Basic constructor
Message(byte[] byteArray) byteArray: a byte array containing the body of the message
Message(ByteArrayInputStream stream) stream: a stream containing the body of the message
Message(String string)

Method Summary

Modifier and Type	Method and Description
void	clearCustomProperties()
ByteArrayOutputStream	getBodyStream() The stream content of the body.
byte[]	getBytes() The byte content of the body.
String	getCorrelationId()
DeliveryAcknowledgement	getDeliveryAcknowledgement()
Date	getExpiryTimeUtc()
String	getLockToken()
String	getMessageId()
Map<String,String>	getProperties()
String	getTo()
String	getUserId()
void	setCorrelationId(String correlationId)
void	setDeliveryAcknowledgement(DeliveryAcknowledgement deliveryAcknowledgement) Deprecated. as of service-client version 1.15.1, please use setDeliveryAcknowledgementFinal(DeliveryAcknowledgement)
void	setDeliveryAcknowledgementFinal(DeliveryAcknowledgement deliveryAcknowledgement)
void	setExpiryTimeUtc(Date expiryTimeUtc)
void	setMessageId(String messageId)
void	setProperties(Map<String,String> properties)
void	setTo(String deviceId)
void	setUserId(String userId)

Methods inherited from class java.lang.Object

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

Field Detail

correlationId

public String correlationId

Used in message responses and feedback

Constructor Detail

Message

public Message()

Basic constructor

Message

public Message(ByteArrayInputStream stream)

stream: a stream containing the body of the message

Parameters:

stream - The stream containing the message body

Message

public Message(byte[] byteArray)

byteArray: a byte array containing the body of the message

Parameters:

byteArray - The byte array containing the message body

Message

public Message(String string)
        throws UnsupportedEncodingException

Parameters:

string - - a string containing the body of the message. Important: If a string is passed, the HttpBatch.SerializeAsString is set to true, and the internal byte representation is serialized as UTF-8, with HttpBatch.Encoding set to UTF-8.

Throws:

UnsupportedEncodingException - This exception is thrown if unsupported encoding used

Method Detail

getMessageId

public String getMessageId()

setMessageId

public void setMessageId(String messageId)

getTo

public String getTo()

setTo

public void setTo(String deviceId)

getExpiryTimeUtc

public Date getExpiryTimeUtc()

setExpiryTimeUtc

public void setExpiryTimeUtc(Date expiryTimeUtc)

getLockToken

public String getLockToken()

getCorrelationId

public String getCorrelationId()

setCorrelationId

public void setCorrelationId(String correlationId)

getUserId

public String getUserId()

setUserId

public void setUserId(String userId)

getBodyStream

public ByteArrayOutputStream getBodyStream()

The stream content of the body.

Returns:

The ByteArrayOutputStream object containing the message body

getBytes

public byte[] getBytes()

The byte content of the body.

Returns:

The byte array of the message body

getDeliveryAcknowledgement

public DeliveryAcknowledgement getDeliveryAcknowledgement()

setDeliveryAcknowledgement

@Deprecated
public void setDeliveryAcknowledgement(DeliveryAcknowledgement deliveryAcknowledgement)

Deprecated. as of service-client version 1.15.1, please use setDeliveryAcknowledgementFinal(DeliveryAcknowledgement)

Parameters:

deliveryAcknowledgement - the delivery acknowledgement to set

setDeliveryAcknowledgementFinal

public final void setDeliveryAcknowledgementFinal(DeliveryAcknowledgement deliveryAcknowledgement)

Parameters:

deliveryAcknowledgement - the delivery acknowledgement to set

getProperties

public Map<String,String> getProperties()

setProperties

public void setProperties(Map<String,String> properties)

clearCustomProperties

public void clearCustomProperties()