HttpsMessage Interface

Package:

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

Maven Artifact:

com.microsoft.azure.sdk.iot:iot-device-client:1.30.1

public interface HttpsMessage

An HTTPS message. An HTTPS message is distinguished from a plain IoT Hub message by its property names, which are prefixed with 'iothub-app-'; and by the explicit specification of a content-type.

Field Summary

Modifier and Type	Field and Description
static final java.lang.String	HTTPS_APP_PROPERTY_PREFIX The prefix to be added to an HTTPS application-defined property.
static final java.lang.String	HTTPS_SYSTEM_PROPERTY_PREFIX The prefix to be added to an HTTPS system-defined property.

Method Summary

Modifier and Type	Method and Description
abstract byte[]	getBody() Gets the message body.
abstract java.lang.String	getContentType() Gets the message content type.
abstract MessageProperty[]	getProperties() Gets the collection of message properties.
abstract java.util.Map<java.lang.String,java.lang.String>	getSystemProperties() Gets the collection of system message properties.

Field Details

HTTPS_APP_PROPERTY_PREFIX

public static final String HTTPS_APP_PROPERTY_PREFIX

The prefix to be added to an HTTPS application-defined property.

HTTPS_SYSTEM_PROPERTY_PREFIX

public static final String HTTPS_SYSTEM_PROPERTY_PREFIX

The prefix to be added to an HTTPS system-defined property.

Method Details

getBody

public abstract byte[] getBody()

Gets the message body.

Returns:

Returns the message body.

getContentType

public abstract String getContentType()

Gets the message content type.

Returns:

Returns the message content-type.

getProperties

public abstract MessageProperty[] getProperties()

Gets the collection of message properties.

Returns:

Returns the message properties.

getSystemProperties

public abstract Map getSystemProperties()

Gets the collection of system message properties.

Returns:

Returns the system message properties.