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

Class IotHubTransportMessage

java.lang.Object

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

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

public class IotHubTransportMessage
extends Message

Extends Message, adding transport artifacts.

Field Summary

Fields inherited from class com.microsoft.azure.sdk.iot.device.Message

DEFAULT_IOTHUB_MESSAGE_CHARSET

Constructor Summary

Constructors

Constructor and Description
IotHubTransportMessage(byte[] data, MessageType messageType) Constructor with binary data and message type
IotHubTransportMessage(byte[] data, MessageType messageType, java.lang.String messageId, java.lang.String correlationId, MessageProperty[] messageProperties)
IotHubTransportMessage(java.lang.String body) Constructor.

Method Summary

Modifier and Type	Method and Description
DeviceOperations	getDeviceOperationType() Getter for the device operation type
HttpsMethod	getIotHubMethod() Getter for the HTTPS method
MessageCallback	getMessageCallback()
java.lang.Object	getMessageCallbackContext()
java.lang.String	getMethodName() Getter for the method name of device method operation
java.lang.String	getRequestId() Getter for the request id
java.lang.String	getStatus() Getter for the request status
java.lang.String	getUriPath() Getter for the URI path
int	getVersion() Getter for the message version
boolean	isMessageAckNeeded(IotHubClientProtocol protocol)
void	setDeviceOperationType(DeviceOperations deviceOperationType) Setter for the device operation type
void	setIotHubMethod(HttpsMethod iotHubMethod) Setter for the IoT Hub method
void	setMessageCallback(MessageCallback messageCallback)
void	setMessageCallbackContext(java.lang.Object messageCallbackContext)
void	setMethodName(java.lang.String methodName) Setter for the method name of device method operation
void	setRequestId(java.lang.String id) Setter for the message id
void	setStatus(java.lang.String status) Setter for the status
void	setUriPath(java.lang.String uriPath) Setter for the URI path
void	setVersion(int version) Setter for the message version
java.lang.String	toString()

Methods inherited from class com.microsoft.azure.sdk.iot.device.Message

getBodyStream, getBytes, getConnectionDeviceId, getConnectionModuleId, getContentEncoding, getContentType, getCorrelatingMessageCallback, getCorrelatingMessageCallbackContext, getCorrelationId, getCreationTimeUTC, getCreationTimeUTCString, getDeliveryAcknowledgement, getInputName, getIotHubConnectionString, getMessageId, getMessageType, getOutputName, getProperties, getProperty, getTo, getUserId, isExpired, isSecurityMessage, setAbsoluteExpiryTime, setAsSecurityMessage, setConnectionDeviceId, setConnectionModuleId, setContentEncoding, setContentType, setCorrelatingMessageCallback, setCorrelatingMessageCallbackContext, setCorrelationId, setCreationTimeUTC, setExpiryTime, setInputName, setIotHubConnectionString, setMessageId, setMessageType, setOutputName, setProperty, setUserId

Methods inherited from class java.lang.Object

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

Constructor Detail

IotHubTransportMessage

public IotHubTransportMessage(byte[] data,
                              MessageType messageType)

Constructor with binary data and message type

Parameters:

data - The byte array of the message.

messageType - The messageType of the message.

IotHubTransportMessage

public IotHubTransportMessage(java.lang.String body)

Constructor.

Parameters:

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

IotHubTransportMessage

public IotHubTransportMessage(byte[] data,
                              MessageType messageType,
                              java.lang.String messageId,
                              java.lang.String correlationId,
                              MessageProperty[] messageProperties)

Method Detail

getMessageCallback

public MessageCallback getMessageCallback()

setMessageCallback

public void setMessageCallback(MessageCallback messageCallback)

getMessageCallbackContext

public java.lang.Object getMessageCallbackContext()

setMessageCallbackContext

public void setMessageCallbackContext(java.lang.Object messageCallbackContext)

setVersion

public void setVersion(int version)

Setter for the message version

Parameters:

version - The String containing the version.

getVersion

public int getVersion()

Getter for the message version

Returns:

the String containing the version.

setRequestId

public void setRequestId(java.lang.String id)

Setter for the message id

Parameters:

id - The String containing the id.

getRequestId

public java.lang.String getRequestId()

Getter for the request id

Returns:

the String containing the request id.

setStatus

public void setStatus(java.lang.String status)

Setter for the status

Parameters:

status - The String containing the status.

getStatus

public java.lang.String getStatus()

Getter for the request status

Returns:

the String containing the request status.

setDeviceOperationType

public void setDeviceOperationType(DeviceOperations deviceOperationType)

Setter for the device operation type

Parameters:

deviceOperationType - The DeviceOperations enum value.

getDeviceOperationType

public DeviceOperations getDeviceOperationType()

Getter for the device operation type

Returns:

the DeviceOperations eum value with the current operation type.

isMessageAckNeeded

public boolean isMessageAckNeeded(IotHubClientProtocol protocol)

setMethodName

public void setMethodName(java.lang.String methodName)

Setter for the method name of device method operation

Parameters:

methodName - The String containing the method name of device method operation.

getMethodName

public java.lang.String getMethodName()

Getter for the method name of device method operation

Returns:

the methodName of device method operation.

setIotHubMethod

public void setIotHubMethod(HttpsMethod iotHubMethod)

Setter for the IoT Hub method

Parameters:

iotHubMethod - The HTTPS method.

setUriPath

public void setUriPath(java.lang.String uriPath)

Setter for the URI path

Parameters:

uriPath - The string with the URI path.

getIotHubMethod

public HttpsMethod getIotHubMethod()

Getter for the HTTPS method

Returns:

the IoT Hub method (POST, GET).

getUriPath

public java.lang.String getUriPath()

Getter for the URI path

Returns:

the string with the URI path.

toString

public java.lang.String toString()

Overrides:

toString in class Message