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

Class CloudToDeviceMessageConnectionHandler

java.lang.Object

org.apache.qpid.proton.engine.BaseHandler

com.microsoft.azure.sdk.iot.service.transport.amqps.ErrorLoggingBaseHandler

com.microsoft.azure.sdk.iot.service.transport.amqps.ErrorLoggingBaseHandlerWithCleanup

com.microsoft.azure.sdk.iot.service.transport.amqps.CloudToDeviceMessageConnectionHandler

All Implemented Interfaces:

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

public class CloudToDeviceMessageConnectionHandler
extends ErrorLoggingBaseHandlerWithCleanup

Instance of the QPID-Proton-J BaseHandler class to override the events what are needed to handle the receive operation Contains and sets connection parameters (path, port, endpoint) Maintains the layers of AMQP protocol (Link, Session, Connection, Transport) Creates and sets SASL authentication for transport

Field Summary

Fields

Modifier and Type	Field and Description
protected String	hostName

Fields inherited from class com.microsoft.azure.sdk.iot.service.transport.amqps.ErrorLoggingBaseHandler

errorProcessor, protonJExceptionParser

Constructor Summary

Constructors

Constructor and Description
CloudToDeviceMessageConnectionHandler(String hostName, com.azure.core.credential.AzureSasCredential azureSasCredential, IotHubServiceClientProtocol protocol, Consumer<ErrorContext> errorProcessor, ProxyOptions proxyOptions, SSLContext sslContext, int keepAliveIntervalSeconds)
CloudToDeviceMessageConnectionHandler(String connectionString, IotHubServiceClientProtocol protocol, Consumer<ErrorContext> errorProcessor, ProxyOptions proxyOptions, SSLContext sslContext, int keepAliveIntervalSeconds)
CloudToDeviceMessageConnectionHandler(String hostName, com.azure.core.credential.TokenCredential credential, IotHubServiceClientProtocol protocol, Consumer<ErrorContext> errorProcessor, ProxyOptions proxyOptions, SSLContext sslContext, int keepAliveIntervalSeconds)

Method Summary

Modifier and Type	Method and Description
void	closeAsync(Runnable onConnectionClosedCallback)
String	getConnectionId()
boolean	isOpen()
void	onAuthenticationFailed(IotHubException e) Executes when the CBS session has failed to authenticate the connection
void	onAuthenticationSucceeded()
void	onConnectionBound(org.apache.qpid.proton.engine.Event event) Event handler for the connection bound event
void	onConnectionInit(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	onLinkRemoteOpen(org.apache.qpid.proton.engine.Event event)
void	onReactorFinal(org.apache.qpid.proton.engine.Event event)
void	onReactorInit(org.apache.qpid.proton.engine.Event event)
void	onReceiverLinkRemoteOpen() Callback that executes when the receiver link has opened successfully
void	onSenderLinkRemoteOpen() Callback that executes when the sender link has opened successfully
void	onSessionRemoteOpen(org.apache.qpid.proton.engine.Event event)
void	sendAsync(String deviceId, String moduleId, Message iotHubMessage, Consumer<SendResult> callback, Object context)
void	verifyConnectionWasOpened() If an exception was encountered while opening the AMQP connection, this function shall throw that saved exception

Methods inherited from class com.microsoft.azure.sdk.iot.service.transport.amqps.ErrorLoggingBaseHandlerWithCleanup

onConnectionLocalClose, onConnectionLocalOpen, onLinkLocalClose, onLinkLocalOpen, onLinkRemoteClose, onSessionLocalClose, onSessionLocalOpen, onSessionRemoteClose, onTransportError

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

add, children, getHandler, getHandler, handle, onConnectionFinal, onConnectionUnbound, onDelivery, onLinkFinal, onLinkFlow, onLinkInit, onLinkLocalDetach, onLinkRemoteDetach, onReactorQuiesced, onSelectableError, onSelectableExpired, onSelectableFinal, onSelectableInit, onSelectableReadable, onSelectableUpdated, onSelectableWritable, onSessionFinal, onSessionInit, onTimerTask, 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

Field Detail

hostName

protected final String hostName

Constructor Detail

CloudToDeviceMessageConnectionHandler

public CloudToDeviceMessageConnectionHandler(String connectionString,
                                             IotHubServiceClientProtocol protocol,
                                             Consumer<ErrorContext> errorProcessor,
                                             ProxyOptions proxyOptions,
                                             SSLContext sslContext,
                                             int keepAliveIntervalSeconds)

CloudToDeviceMessageConnectionHandler

public CloudToDeviceMessageConnectionHandler(String hostName,
                                             com.azure.core.credential.TokenCredential credential,
                                             IotHubServiceClientProtocol protocol,
                                             Consumer<ErrorContext> errorProcessor,
                                             ProxyOptions proxyOptions,
                                             SSLContext sslContext,
                                             int keepAliveIntervalSeconds)

CloudToDeviceMessageConnectionHandler

public CloudToDeviceMessageConnectionHandler(String hostName,
                                             com.azure.core.credential.AzureSasCredential azureSasCredential,
                                             IotHubServiceClientProtocol protocol,
                                             Consumer<ErrorContext> errorProcessor,
                                             ProxyOptions proxyOptions,
                                             SSLContext sslContext,
                                             int keepAliveIntervalSeconds)

Method Detail

onAuthenticationSucceeded

public void onAuthenticationSucceeded()

onSenderLinkRemoteOpen

public void onSenderLinkRemoteOpen()

Callback that executes when the sender link has opened successfully

onReceiverLinkRemoteOpen

public void onReceiverLinkRemoteOpen()

Callback that executes when the receiver link has opened successfully

isOpen

public boolean isOpen()

sendAsync

public void sendAsync(String deviceId,
                      String moduleId,
                      Message iotHubMessage,
                      Consumer<SendResult> callback,
                      Object context)

closeAsync

public void closeAsync(Runnable onConnectionClosedCallback)

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

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

onConnectionBound

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

Event handler for the connection bound event

Specified by:

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

Overrides:

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

Parameters:

event - The proton event object

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

onLinkRemoteOpen

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

Specified by:

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

Overrides:

onLinkRemoteOpen in class ErrorLoggingBaseHandlerWithCleanup

onSessionRemoteOpen

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

Specified by:

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

Overrides:

onSessionRemoteOpen in class ErrorLoggingBaseHandlerWithCleanup

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 ErrorLoggingBaseHandlerWithCleanup

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 ErrorLoggingBaseHandlerWithCleanup

getConnectionId

public String getConnectionId()

verifyConnectionWasOpened

public void verifyConnectionWasOpened()
                               throws IOException,
                                      IotHubException

If an exception was encountered while opening the AMQP connection, this function shall throw that saved exception

Throws:

IOException - if an exception was encountered while openinging the AMQP connection. The encountered exception will be the inner exception

IotHubException

onAuthenticationFailed

public void onAuthenticationFailed(IotHubException e)

Executes when the CBS session has failed to authenticate the connection

Parameters:

e - the reason why authentication failed.