com.microsoft.azure.sdk.iot.device

Class Message

java.lang.Object

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

Direct Known Subclasses:

BatchMessage, IotHubTransportMessage, ResponseMessage

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() The stream content of the body.
byte[]	getBytes() The byte content of the body.
String	getConnectionDeviceId()
String	getConnectionModuleId()
String	getContentEncoding() Returns this message's content encoding.
String	getContentType() Return the message's content type.
String	getCorrelationId() Getter for the correlationId property
Date	getCreationTimeUTC()
String	getCreationTimeUTCString() Returns the iot hub accepted format for the creation time utc ex: oct 1st, 2018 yields 2008-10-01T17:04:32.0000000
String	getDeliveryAcknowledgement() Getter for the delivery acknowledgement system property
String	getInputName()
IotHubConnectionString	getIotHubConnectionString() Getter for the iotHubConnectionString property
String	getMessageId() Getter for the messageId property
MessageType	getMessageType() Getter for the Message type
String	getOutputName()
MessageProperty[]	getProperties() Returns a copy of the message properties.
String	getProperty(String name) Gets the values of user-defined properties of this Message.
String	getTo() Getter for the To system property
String	getUserId() Getter for the User ID system property
boolean	isExpired() Verifies whether the message is expired or not
boolean	isSecurityMessage()
void	setAbsoluteExpiryTime(long absoluteTimeout) Setter for the expiryTime property using absolute time
void	setAsSecurityMessage()
void	setConnectionDeviceId(String connectionDeviceId)
void	setConnectionModuleId(String connectionModuleId)
void	setContentEncoding(String contentEncoding) Set the content encoding of this message.
void	setContentType(String contentType) Deprecated. as of device-client version 1.14.1, please use setContentTypeFinal(String)
void	setContentTypeFinal(String contentType) Set the content type of this message.
void	setCorrelationId(String correlationId) Setter for the correlationId property
void	setCreationTimeUTC(Date creationTimeUTC)
void	setExpiryTime(long timeOut) Setter for the expiryTime property.
void	setInputName(String inputName) Set the input name of the message, used in routing for module communications
void	setIotHubConnectionString(IotHubConnectionString iotHubConnectionString) Setter for the iotHubConnectionString type
void	setMessageId(String messageId) Setter for the messageId property
void	setMessageType(MessageType type) Setter for the Message type
void	setOutputName(String outputName) Set the output channel name to send to.
void	setProperty(String name, String value) Adds or sets user-defined properties of this Message.
void	setUserId(String userId)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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()

The stream content of the body.

Returns:

always returns null.

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

setUserId

public void setUserId(String userId)

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. This setter uses relative time, not absolute time.

Parameters:

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

setAbsoluteExpiryTime

public void setAbsoluteExpiryTime(long absoluteTimeout)

Setter for the expiryTime property using absolute time

Parameters:

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

getMessageType

public MessageType getMessageType()

Getter for the Message type

Returns:

the Message type value

setConnectionDeviceId

public void setConnectionDeviceId(String connectionDeviceId)

setConnectionModuleId

public void setConnectionModuleId(String connectionModuleId)

setOutputName

public void setOutputName(String outputName)

Set the output channel name to send to. Used in routing for module communications

Parameters:

outputName - the output channel name to send to

setInputName

public void setInputName(String inputName)

Set the input name of the message, used in routing for module communications

Parameters:

inputName - the input channel the message was received from

setMessageType

public void setMessageType(MessageType type)

Setter for the Message type

Parameters:

type - The enum containing the Message type value

getTo

public String getTo()

Getter for the To system property

Returns:

the To value

getConnectionDeviceId

public String getConnectionDeviceId()

getConnectionModuleId

public String getConnectionModuleId()

getInputName

public String getInputName()

getOutputName

public String getOutputName()

getDeliveryAcknowledgement

public String getDeliveryAcknowledgement()

Getter for the delivery acknowledgement system property

Returns:

the delivery acknowledgement value

getUserId

public String getUserId()

Getter for the User ID system property

Returns:

the User ID value

getIotHubConnectionString

public IotHubConnectionString getIotHubConnectionString()

Getter for the iotHubConnectionString property

Returns:

the iotHubConnectionString value

setIotHubConnectionString

public void setIotHubConnectionString(IotHubConnectionString iotHubConnectionString)

Setter for the iotHubConnectionString type

Parameters:

iotHubConnectionString - The iotHubConnectionString value to set

getContentType

public String getContentType()

Return the message's content type. This value is null by default

Returns:

the message's content type

setContentType

@Deprecated
public void setContentType(String contentType)

Deprecated. as of device-client version 1.14.1, please use setContentTypeFinal(String)

Set the content type of this message. Used in message routing.

Parameters:

contentType - the content type of the message. May be null if you don't want to specify a content type.

setContentTypeFinal

public final void setContentTypeFinal(String contentType)

Set the content type of this message. Used in message routing.

Parameters:

contentType - the content type of the message. May be null if you don't want to specify a content type.

getContentEncoding

public String getContentEncoding()

Returns this message's content encoding. This value is null by default

Returns:

the message's content encoding.

setContentEncoding

public void setContentEncoding(String contentEncoding)

Set the content encoding of this message. Used in message routing.

Parameters:

contentEncoding - the content encoding of the message. May be null if you don't want to specify a content encoding.

getCreationTimeUTC

public Date getCreationTimeUTC()

getCreationTimeUTCString

public String getCreationTimeUTCString()

Returns the iot hub accepted format for the creation time utc ex: oct 1st, 2018 yields 2008-10-01T17:04:32.0000000

Returns:

the iot hub accepted format for the creation time utc

setCreationTimeUTC

public final void setCreationTimeUTC(Date creationTimeUTC)

setAsSecurityMessage

public void setAsSecurityMessage()

isSecurityMessage

public boolean isSecurityMessage()

toString

public String toString()

Overrides:

toString in class Object