com.microsoft.azure.sdk.iot.device

Class Message

java.lang.Object

com.microsoft.azure.sdk.iot.device.Message

public class Message
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_IOTHUB_MESSAGE_CHARSET

Constructor Summary

Constructors

Constructor and Description
Message() Constructor.
Message(byte[] body) Constructor.
Message(ByteArrayInputStream stream) Constructor.
Message(String body) Constructor.

Method Summary

Modifier and Type	Method and Description
ByteArrayOutputStream	getBodyStream()
byte[]	getBytes() The byte content of the body.
String	getCorrelationId() Getter for the correlationId property
String	getMessageId() Getter for the messageId property
MessageProperty[]	getProperties() Returns a copy of the message properties.
String	getProperty(String name) Gets the values of user-defined properties of this Message.
boolean	isExpired() Verifies whether the message is expired or not
void	setCorrelationId(String correlationId) Setter for the correlationId property
void	setExpiryTime(long timeOut) Setter for the expiryTime property
void	setMessageId(String messageId) Setter for the messageId property
void	setProperty(String name, String value) Adds or sets user-defined properties of this Message.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_IOTHUB_MESSAGE_CHARSET

public static final Charset DEFAULT_IOTHUB_MESSAGE_CHARSET

Constructor Detail

Message

public Message()

Constructor.

Message

public Message(ByteArrayInputStream stream)

Constructor.

Parameters:

stream - A stream to provide the body of the new Message instance.

Message

public Message(byte[] body)

Constructor.

Parameters:

body - The body of the new Message instance.

Message

public Message(String body)

Constructor.

Parameters:

body - The body of the new Message instance. It is internally serialized to a byte array using UTF-8 encoding.

Method Detail

getBodyStream

public ByteArrayOutputStream getBodyStream()

getBytes

public byte[] getBytes()

The byte content of the body.

Returns:

A copy of this Message body, as a byte array.

getProperty

public String getProperty(String name)

Gets the values of user-defined properties of this Message.

Parameters:

name - Name of the user-defined property to search for.

Returns:

The value of the property if it is set, or null otherwise.

setProperty

public void setProperty(String name,
                        String value)

Adds or sets user-defined properties of this Message.

Parameters:

name - Name of the property to be set.

value - Value of the property to be set.

Throws:

IllegalArgumentException - If any of the arguments provided is null.

getProperties

public MessageProperty[] getProperties()

Returns a copy of the message properties.

Returns:

a copy of the message properties.

isExpired

public boolean isExpired()

Verifies whether the message is expired or not

Returns:

true if the message is expired, false otherwise

getMessageId

public String getMessageId()

Getter for the messageId property

Returns:

The property value

setMessageId

public void setMessageId(String messageId)

Setter for the messageId property

Parameters:

messageId - The string containing the property value

getCorrelationId

public String getCorrelationId()

Getter for the correlationId property

Returns:

The property value

setCorrelationId

public void setCorrelationId(String correlationId)

Setter for the correlationId property

Parameters:

correlationId - The string containing the property value

setExpiryTime

public void setExpiryTime(long timeOut)

Setter for the expiryTime property

Parameters:

timeOut - The time out for the message, in milliseconds.