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

Class AmqpsIotHubConnection

java.lang.Object

org.apache.qpid.proton.engine.BaseHandler

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

All Implemented Interfaces:

IotHubTransportConnection, org.apache.qpid.proton.engine.CoreHandler, org.apache.qpid.proton.engine.Handler

public final class AmqpsIotHubConnection
extends org.apache.qpid.proton.engine.BaseHandler
implements IotHubTransportConnection

An AMQPS IotHub connection between a device and an IoTHub or Edgehub. This class is responsible for reacting to connection level and reactor level events. It is also responsible for creating sessions and handlers for those sessions. An instance of this object may be reused after it has been closed. This class is used for both single-plexed and multiplexed connections.

Constructor Summary

Constructors

Constructor and Description
AmqpsIotHubConnection(ClientConfiguration config, java.lang.String transportUniqueIdentifier)
AmqpsIotHubConnection(java.lang.String hostName, java.lang.String transportUniqueIdentifier, boolean isWebsocketConnection, javax.net.ssl.SSLContext sslContext, ProxySettings proxySettings, int keepAliveInterval)

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	onAuthenticationFailed(java.lang.String deviceId, TransportException transportException) Executed when SAS based authentication fails for a device in this connection
void	onAuthenticationSessionOpened() Executed when the authentication session has successfully been opened.
void	onCBSSessionClosedUnexpectedly(org.apache.qpid.proton.amqp.transport.ErrorCondition errorCondition) Executed if the CBS session closes unexpectedly.
void	onConnectionBound(org.apache.qpid.proton.engine.Event event)
void	onConnectionInit(org.apache.qpid.proton.engine.Event event)
void	onConnectionLocalClose(org.apache.qpid.proton.engine.Event event)
void	onConnectionLocalOpen(org.apache.qpid.proton.engine.Event event)
void	onConnectionRemoteClose(org.apache.qpid.proton.engine.Event event)
void	onConnectionRemoteOpen(org.apache.qpid.proton.engine.Event event)
void	onDeviceSessionOpened(java.lang.String deviceId) Executed when a device's amqp session has successfully been opened.
void	onMessageAcknowledged(Message message, org.apache.qpid.proton.amqp.transport.DeliveryState deliveryState, java.lang.String deviceId) Executed when a message sent in this connection was acknowledged by the service.
void	onMessageReceived(IotHubTransportMessage message) Executed when a message was received by a session that this connection owns.
void	onReactorClosedUnexpectedly() Executed when the proton-j reactor closed unexpectedly.
void	onReactorFinal(org.apache.qpid.proton.engine.Event event)
void	onReactorInit(org.apache.qpid.proton.engine.Event event)
void	onSessionClosedAsExpected(java.lang.String deviceId) Executed if a session closes, but it was expected.
void	onSessionClosedUnexpectedly(org.apache.qpid.proton.amqp.transport.ErrorCondition errorCondition, java.lang.String deviceId) Executed if a session closes unexpectedly.
void	onTimerTask(org.apache.qpid.proton.engine.Event event)
void	onTransportError(org.apache.qpid.proton.engine.Event event)
void	open() Opens the transport connection object
void	registerMultiplexedDevice(ClientConfiguration config)
IotHubStatusCode	sendMessage(Message message) Send a single message to the IotHub over the Transport Connection
boolean	sendMessageResult(IotHubTransportMessage message, IotHubMessageResult result) Send an acknowledgement to the IotHub for a message that the Transport layer received
void	setListener(IotHubListener listener) Sets a listener into the Transport Connection object.
void	unregisterMultiplexedDevice(ClientConfiguration config, boolean willReconnect) Asynchronously unregister a multiplexed device from an active multiplexed connection or synchronously unregister a multiplexed device from a closed multiplexed connection.

Methods inherited from class org.apache.qpid.proton.engine.BaseHandler

add, children, getHandler, getHandler, handle, onConnectionFinal, onConnectionUnbound, onDelivery, onLinkFinal, onLinkFlow, onLinkInit, onLinkLocalClose, onLinkLocalDetach, onLinkLocalOpen, onLinkRemoteClose, onLinkRemoteDetach, onLinkRemoteOpen, onReactorQuiesced, onSelectableError, onSelectableExpired, onSelectableFinal, onSelectableInit, onSelectableReadable, onSelectableUpdated, onSelectableWritable, onSessionFinal, onSessionInit, onSessionLocalClose, onSessionLocalOpen, onSessionRemoteClose, onSessionRemoteOpen, onTransport, onTransportClosed, onTransportHeadClosed, onTransportTailClosed, onUnhandled, setHandler, setHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

AmqpsIotHubConnection

public AmqpsIotHubConnection(ClientConfiguration config,
                             java.lang.String transportUniqueIdentifier)

AmqpsIotHubConnection

public AmqpsIotHubConnection(java.lang.String hostName,
                             java.lang.String transportUniqueIdentifier,
                             boolean isWebsocketConnection,
                             javax.net.ssl.SSLContext sslContext,
                             ProxySettings proxySettings,
                             int keepAliveInterval)

Method Detail

registerMultiplexedDevice

public void registerMultiplexedDevice(ClientConfiguration config)

unregisterMultiplexedDevice

public void unregisterMultiplexedDevice(ClientConfiguration config,
                                        boolean willReconnect)

Asynchronously unregister a multiplexed device from an active multiplexed connection or synchronously unregister a multiplexed device from a closed multiplexed connection.

Parameters:

config - the config of the device that should be unregistered.

willReconnect - true if the device will be re-registered soon because it is reconnecting.

open

public void open()
          throws TransportException

Description copied from interface: IotHubTransportConnection

Opens the transport connection object

Specified by:

open in interface IotHubTransportConnection

Throws:

TransportException - If any exceptions are encountered while opening the connection

close

public void close()

Description copied from interface: IotHubTransportConnection

Closes the transport connection.

Specified by:

close in interface IotHubTransportConnection

onReactorInit

public void onReactorInit(org.apache.qpid.proton.engine.Event event)

Specified by:

onReactorInit in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onReactorInit in class org.apache.qpid.proton.engine.BaseHandler

onReactorFinal

public void onReactorFinal(org.apache.qpid.proton.engine.Event event)

Specified by:

onReactorFinal in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onReactorFinal in class org.apache.qpid.proton.engine.BaseHandler

onConnectionInit

public void onConnectionInit(org.apache.qpid.proton.engine.Event event)

Specified by:

onConnectionInit in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onConnectionInit in class org.apache.qpid.proton.engine.BaseHandler

onConnectionBound

public void onConnectionBound(org.apache.qpid.proton.engine.Event event)

Specified by:

onConnectionBound in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onConnectionBound in class org.apache.qpid.proton.engine.BaseHandler

onConnectionLocalOpen

public void onConnectionLocalOpen(org.apache.qpid.proton.engine.Event event)

Specified by:

onConnectionLocalOpen in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onConnectionLocalOpen in class org.apache.qpid.proton.engine.BaseHandler

onConnectionRemoteOpen

public void onConnectionRemoteOpen(org.apache.qpid.proton.engine.Event event)

Specified by:

onConnectionRemoteOpen in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onConnectionRemoteOpen in class org.apache.qpid.proton.engine.BaseHandler

onConnectionLocalClose

public void onConnectionLocalClose(org.apache.qpid.proton.engine.Event event)

Specified by:

onConnectionLocalClose in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onConnectionLocalClose in class org.apache.qpid.proton.engine.BaseHandler

onConnectionRemoteClose

public void onConnectionRemoteClose(org.apache.qpid.proton.engine.Event event)

Specified by:

onConnectionRemoteClose in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onConnectionRemoteClose in class org.apache.qpid.proton.engine.BaseHandler

onTransportError

public void onTransportError(org.apache.qpid.proton.engine.Event event)

Specified by:

onTransportError in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onTransportError in class org.apache.qpid.proton.engine.BaseHandler

onTimerTask

public void onTimerTask(org.apache.qpid.proton.engine.Event event)

Specified by:

onTimerTask in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onTimerTask in class org.apache.qpid.proton.engine.BaseHandler

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

sendMessage

public IotHubStatusCode sendMessage(Message message)

Description copied from interface: IotHubTransportConnection

Send a single message to the IotHub over the Transport Connection

Specified by:

sendMessage in interface IotHubTransportConnection

Parameters:

message - the message to send

Returns:

the status code from the service

sendMessageResult

public boolean sendMessageResult(IotHubTransportMessage message,
                                 IotHubMessageResult result)

Description copied from interface: IotHubTransportConnection

Send an acknowledgement to the IotHub for a message that the Transport layer received

Specified by:

sendMessageResult in interface IotHubTransportConnection

Parameters:

message - the message to acknowledge

result - the acknowledgement value to notify the service of

Returns:

true if the acknowledgement was sent successfully, and false otherwise

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

onDeviceSessionOpened

public void onDeviceSessionOpened(java.lang.String deviceId)

Executed when a device's amqp session has successfully been opened. For multiplexing scenarios, this callback will be fired once per device.

Parameters:

deviceId - the id of the device that had its session opened successfully

onAuthenticationSessionOpened

public void onAuthenticationSessionOpened()

Executed when the authentication session has successfully been opened. Never called for x509 auth.

onMessageAcknowledged

public void onMessageAcknowledged(Message message,
                                  org.apache.qpid.proton.amqp.transport.DeliveryState deliveryState,
                                  java.lang.String deviceId)

Executed when a message sent in this connection was acknowledged by the service.

Parameters:

message - the message that was acknowledged.

deliveryState - state information that describes if the message was accepted by the receiver or not.

deviceId - the Id of the device whose message was acknowledged.

onMessageReceived

public void onMessageReceived(IotHubTransportMessage message)

Executed when a message was received by a session that this connection owns. This message should be acknowledged later.

Parameters:

message - the message that was received.

onAuthenticationFailed

public void onAuthenticationFailed(java.lang.String deviceId,
                                   TransportException transportException)

Executed when SAS based authentication fails for a device in this connection

Parameters:

deviceId - the Id of the device for which the authentication failed.

transportException - the cause of that failure.

onSessionClosedUnexpectedly

public void onSessionClosedUnexpectedly(org.apache.qpid.proton.amqp.transport.ErrorCondition errorCondition,
                                        java.lang.String deviceId)

Executed if a session closes unexpectedly. May be because one of its links closed unexpectedly, or if the session closed unexpectedly.

Parameters:

errorCondition - the condition of the session that caused the close if the session closed remotely, or the condition of the link that closed unexpectedly.

deviceId - the device that the session belonged to.

onCBSSessionClosedUnexpectedly

public void onCBSSessionClosedUnexpectedly(org.apache.qpid.proton.amqp.transport.ErrorCondition errorCondition)

Executed if the CBS session closes unexpectedly. May be because one of its links closed unexpectedly, or if the session closed unexpectedly.

Parameters:

errorCondition - the condition of the session that caused the close if the session closed remotely, or the condition of the link that closed unexpectedly.

onSessionClosedAsExpected

public void onSessionClosedAsExpected(java.lang.String deviceId)

Executed if a session closes, but it was expected. Likely due to user calling close on the connection, or unregistering a device from an active multiplexed connection

Parameters:

deviceId - the device whose connection closed.

onReactorClosedUnexpectedly

public void onReactorClosedUnexpectedly()

Executed when the proton-j reactor closed unexpectedly. For example, if the reactor encountered a runtime exception and threw a handler exception at the ReactorRunner class.