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

Class HttpsSingleMessage

java.lang.Object

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

All Implemented Interfaces:

HttpsMessage

public final class HttpsSingleMessage
extends Object
implements HttpsMessage

A single HTTPS message.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	base64Encoded
protected byte[]	body
static String	HTTPS_SINGLE_MESSAGE_CONTENT_TYPE
protected MessageProperty[]	properties

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

HTTPS_APP_PROPERTY_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpsSingleMessage()

Method Summary

Modifier and Type	Method and Description
byte[]	getBody() Returns a copy of the message body.
String	getBodyAsString() Returns the message body as a string.
String	getContentType() Returns the message content-type as 'binary/octet-stream'.
MessageProperty[]	getProperties() Returns a copy of the message properties.
protected static String	httpsAppPropertyToAppProperty(String httpsAppProperty) Returns an application-defined property name with the prefix 'iothub-app' removed.
boolean	isBase64Encoded() Returns whether the message is Base64-encoded.
protected static boolean	isValidHttpsAppProperty(String name, String value) Returns whether the property name and value constitute a valid HTTPS application property.
static HttpsSingleMessage	parseHttpsMessage(HttpsResponse response) Returns the HTTPS message represented by the HTTPS response.
static HttpsSingleMessage	parseHttpsMessage(Message message) Returns the HTTPS message represented by the service-bound message.
Message	toMessage() Returns the Iot Hub message represented by the HTTPS message.

Methods inherited from class java.lang.Object

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

Field Detail

HTTPS_SINGLE_MESSAGE_CONTENT_TYPE

public static final String HTTPS_SINGLE_MESSAGE_CONTENT_TYPE

See Also:

Constant Field Values

body

protected byte[] body

base64Encoded

protected boolean base64Encoded

properties

protected MessageProperty[] properties

Constructor Detail

HttpsSingleMessage

protected HttpsSingleMessage()

Method Detail

parseHttpsMessage

public static HttpsSingleMessage parseHttpsMessage(Message message)

Returns the HTTPS message represented by the service-bound message.

Parameters:

message - the service-bound message to be mapped to its HTTPS message equivalent.

Returns:

the HTTPS message represented by the service-bound message.

parseHttpsMessage

public static HttpsSingleMessage parseHttpsMessage(HttpsResponse response)

Returns the HTTPS message represented by the HTTPS response.

Parameters:

response - the HTTPS response.

Returns:

the HTTPS message represented by the HTTPS response.

toMessage

public Message toMessage()

Returns the Iot Hub message represented by the HTTPS message.

Returns:

the IoT Hub message represented by the HTTPS message.

getBody

public byte[] getBody()

Returns a copy of the message body.

Specified by:

getBody in interface HttpsMessage

Returns:

a copy of the message body.

getBodyAsString

public String getBodyAsString()

Returns the message body as a string. The body is encoded using charset UTF-8.

Returns:

the message body as a string.

getContentType

public String getContentType()

Returns the message content-type as 'binary/octet-stream'.

Specified by:

getContentType in interface HttpsMessage

Returns:

the message content-type as 'binary/octet-stream'.

isBase64Encoded

public boolean isBase64Encoded()

Returns whether the message is Base64-encoded.

Returns:

whether the message is Base64-encoded.

getProperties

public MessageProperty[] getProperties()

Returns a copy of the message properties.

Specified by:

getProperties in interface HttpsMessage

Returns:

a copy of the message properties.

isValidHttpsAppProperty

protected static boolean isValidHttpsAppProperty(String name,
                                                 String value)

Returns whether the property name and value constitute a valid HTTPS application property. The property is valid if it is a valid application property and its name begins with 'iothub-app-'.

Parameters:

name - the property name.

value - the property value.

Returns:

whether the property is a valid HTTPS property.

httpsAppPropertyToAppProperty

protected static String httpsAppPropertyToAppProperty(String httpsAppProperty)

Returns an application-defined property name with the prefix 'iothub-app' removed. If the prefix is not present, the property name is left untouched.

Parameters:

httpsAppProperty - the HTTPS property name.

Returns:

the property name with the prefix 'iothub-app' removed.