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

Class AmqpSendHandler

java.lang.Object

org.apache.qpid.proton.engine.BaseHandler

com.microsoft.azure.sdk.iot.deps.transport.amqp.ErrorLoggingBaseHandler

com.microsoft.azure.sdk.iot.deps.transport.amqp.ErrorLoggingBaseHandlerWithCleanup

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

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

All Implemented Interfaces:

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

public class AmqpSendHandler
extends AmqpConnectionHandler

Instance of the QPID-Proton-J BaseHandler class to override the events what are needed to handle the send 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
static String	DEVICE_PATH_FORMAT
static String	ENDPOINT
static String	MODULE_PATH_FORMAT
static String	SEND_TAG

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

connection, hostName, iotHubServiceClientProtocol, proxyOptions, sasToken, sslContext, userName

Fields inherited from class com.microsoft.azure.sdk.iot.deps.transport.amqp.ErrorLoggingBaseHandler

protonJExceptionParser

Constructor Summary

Constructors

Constructor and Description
AmqpSendHandler(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol) Constructor to set up connection parameters and initialize handshaker for transport
AmqpSendHandler(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions) Constructor to set up connection parameters and initialize handshaker for transport
AmqpSendHandler(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions, SSLContext sslContext) Constructor to set up connection parameters and initialize handshaker for transport

Method Summary

Modifier and Type	Method and Description
void	createProtonMessage(String deviceId, Message message) Create Proton message from deviceId and content string
void	createProtonMessage(String deviceId, String moduleId, Message message) Create Proton message from deviceId and content string
void	onAuthenticationSucceeded()
void	onConnectionRemoteClose(org.apache.qpid.proton.engine.Event event)
void	onDelivery(org.apache.qpid.proton.engine.Event event)
void	onLinkFlow(org.apache.qpid.proton.engine.Event event) Event handler for the link flow event
void	verifySendSucceeded()

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

getConnectionId, onAuthenticationFailed, onConnectionBound, onConnectionInit, onConnectionRemoteOpen, onLinkRemoteOpen, onReactorInit, onSessionRemoteOpen, verifyConnectionWasOpened

Methods inherited from class com.microsoft.azure.sdk.iot.deps.transport.amqp.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, onLinkFinal, onLinkInit, onLinkLocalDetach, onLinkRemoteDetach, onReactorFinal, 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

SEND_TAG

public static final String SEND_TAG

See Also:

Constant Field Values

ENDPOINT

public static final String ENDPOINT

See Also:

Constant Field Values

DEVICE_PATH_FORMAT

public static final String DEVICE_PATH_FORMAT

See Also:

Constant Field Values

MODULE_PATH_FORMAT

public static final String MODULE_PATH_FORMAT

See Also:

Constant Field Values

Constructor Detail

AmqpSendHandler

public AmqpSendHandler(String hostName,
                       String userName,
                       String sasToken,
                       IotHubServiceClientProtocol iotHubServiceClientProtocol)

Constructor to set up connection parameters and initialize handshaker for transport

Parameters:

hostName - The address string of the service (example: AAA.BBB.CCC)

userName - The username string to use SASL authentication (example: user@sas.service)

sasToken - The SAS token string

iotHubServiceClientProtocol - protocol to use

AmqpSendHandler

public AmqpSendHandler(String hostName,
                       String userName,
                       String sasToken,
                       IotHubServiceClientProtocol iotHubServiceClientProtocol,
                       ProxyOptions proxyOptions)

Constructor to set up connection parameters and initialize handshaker for transport

Parameters:

hostName - The address string of the service (example: AAA.BBB.CCC)

userName - The username string to use SASL authentication (example: user@sas.service)

sasToken - The SAS token string

iotHubServiceClientProtocol - protocol to use

proxyOptions - the proxy options to tunnel through, if a proxy should be used.

AmqpSendHandler

public AmqpSendHandler(String hostName,
                       String userName,
                       String sasToken,
                       IotHubServiceClientProtocol iotHubServiceClientProtocol,
                       ProxyOptions proxyOptions,
                       SSLContext sslContext)

Constructor to set up connection parameters and initialize handshaker for transport

Parameters:

hostName - The address string of the service (example: AAA.BBB.CCC)

userName - The username string to use SASL authentication (example: user@sas.service)

sasToken - The SAS token string

iotHubServiceClientProtocol - protocol to use

proxyOptions - the proxy options to tunnel through, if a proxy should be used.

sslContext - the SSL context to use during the TLS handshake when opening the connection. If null, a default SSL context will be generated. This default SSLContext trusts the IoT Hub public certificates.

Method Detail

createProtonMessage

public void createProtonMessage(String deviceId,
                                Message message)

Create Proton message from deviceId and content string

Parameters:

deviceId - The device name string

message - The message to be sent

createProtonMessage

public void createProtonMessage(String deviceId,
                                String moduleId,
                                Message message)

Create Proton message from deviceId and content string

Parameters:

deviceId - The device name string

moduleId - The device name string

message - The message to be sent

onLinkFlow

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

Event handler for the link flow event

Specified by:

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

Overrides:

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

Parameters:

event - The proton event object

onDelivery

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

Specified by:

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

Overrides:

onDelivery 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 com.microsoft.azure.sdk.iot.deps.transport.amqp.ErrorLoggingBaseHandlerWithCleanup

verifySendSucceeded

public void verifySendSucceeded()
                         throws IotHubException,
                                IOException

Throws:

IotHubException

IOException

onAuthenticationSucceeded

public void onAuthenticationSucceeded()