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

Class HttpsIotHubConnection

java.lang.Object

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

All Implemented Interfaces:

IotHubTransportConnection

public class HttpsIotHubConnection
extends java.lang.Object
implements IotHubTransportConnection

An HTTPS connection between a device and an IoT Hub. Contains functionality for synchronously connecting to the different IoT Hub resource URIs.

Constructor Summary

Constructors

Constructor and Description
HttpsIotHubConnection(ClientConfiguration config) Constructs an instance from the given ClientConfiguration object.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the transport connection.
java.lang.String	getConnectionId() Gives the UUID associated with this connection instance.
void	open() Opens the transport connection object
IotHubTransportMessage	receiveMessage() Receives an IotHubTransportMessage, if one exists.
HttpsResponse	sendHttpsMessage(HttpsMessage httpsMessage, HttpsMethod httpsMethod, java.lang.String httpsPath, java.util.Map<java.lang.String,java.lang.String> additionalHeaders) Sends an generic https message.
IotHubStatusCode	sendMessage(Message message) Sends an event message.
boolean	sendMessageResult(IotHubTransportMessage message, IotHubMessageResult result) Sends the message result for the previously received message.
void	setListener(IotHubListener listener) Sets a listener into the Transport Connection object.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpsIotHubConnection

public HttpsIotHubConnection(ClientConfiguration config)

Constructs an instance from the given ClientConfiguration object.

Parameters:

config - the client configuration.

Method Detail

sendMessage

public IotHubStatusCode sendMessage(Message message)
                             throws TransportException

Sends an event message.

Specified by:

sendMessage in interface IotHubTransportConnection

Parameters:

message - the event message.

Returns:

the IotHubStatusCode from sending the event message.

Throws:

TransportException - if the IoT Hub could not be reached.

sendHttpsMessage

public HttpsResponse sendHttpsMessage(HttpsMessage httpsMessage,
                                      HttpsMethod httpsMethod,
                                      java.lang.String httpsPath,
                                      java.util.Map<java.lang.String,java.lang.String> additionalHeaders)
                               throws TransportException

Sends an generic https message.

Parameters:

httpsMessage - the message to send.

httpsMethod - the https method (GET, POST, PUT, DELETE).

httpsPath - the path that will be added at the end of the URI with `/`.

additionalHeaders - any extra headers to be included in the http request

Returns:

the ResponseMessage including status code and payload from sending message.

Throws:

TransportException - if the IoT Hub could not be reached.

receiveMessage

public IotHubTransportMessage receiveMessage()
                                      throws TransportException

Receives an IotHubTransportMessage, if one exists.

Returns:

an IotHubTransportMessage, or null if none exists.

Throws:

TransportException - if the IoT Hub could not be reached.

open

public void open()

Description copied from interface: IotHubTransportConnection

Opens the transport connection object

Specified by:

open in interface IotHubTransportConnection

setListener

public void setListener(IotHubListener listener)

Description copied from interface: IotHubTransportConnection

Sets a listener into the Transport Connection object. This listener updates the Transport layer of connection status updates, message arrivals, and message acknowledgements

Specified by:

setListener in interface IotHubTransportConnection

Parameters:

listener - the listener for connection status updates, message arrivals, and message acknowledgements

close

public void close()

Description copied from interface: IotHubTransportConnection

Closes the transport connection.

Specified by:

close in interface IotHubTransportConnection

sendMessageResult

public boolean sendMessageResult(IotHubTransportMessage message,
                                 IotHubMessageResult result)
                          throws TransportException

Sends the message result for the previously received message.

Specified by:

sendMessageResult in interface IotHubTransportConnection

Parameters:

message - the message that was received from the service to send the result of

result - the message result (one of IotHubMessageResult.COMPLETE, IotHubMessageResult.ABANDON, or IotHubMessageResult.REJECT).

Returns:

true if the acknowledgement was sent successfully, and false otherwise

Throws:

TransportException - if sendMessageResult is called before receiveMessage() is called.

TransportException - if the IoT Hub could not be reached.

getConnectionId

public java.lang.String getConnectionId()

Description copied from interface: IotHubTransportConnection

Gives the UUID associated with this connection instance. This string is used in conjunction with the callbacks with connection status updates to ensure that all connection status updates are relevant to this connection object

Specified by:

getConnectionId in interface IotHubTransportConnection

Returns:

the UUID associated with this connection instance