| Package | Description |
|---|---|
| com.microsoft.azure.sdk.iot.device.auth |
Authenticates a device to an IoT Hub via SAS tokens.
|
| com.microsoft.azure.sdk.iot.device.edge | |
| com.microsoft.azure.sdk.iot.device.hsm | |
| com.microsoft.azure.sdk.iot.device.transport |
A transport for sending and receiving IoT Hub messages, along with supporting
functionality.
|
| com.microsoft.azure.sdk.iot.device.transport.amqps |
AMQPS IoT Hub transport and communication classes.
|
| com.microsoft.azure.sdk.iot.device.transport.amqps.exceptions | |
| com.microsoft.azure.sdk.iot.device.transport.https |
HTTPS IoT Hub transport and communication classes.
|
| com.microsoft.azure.sdk.iot.device.transport.https.exceptions | |
| com.microsoft.azure.sdk.iot.device.transport.mqtt | |
| com.microsoft.azure.sdk.iot.device.transport.mqtt.exceptions |
| Modifier and Type | Method and Description |
|---|---|
char[] |
IotHubSasTokenWithRefreshAuthenticationProvider.getSasToken()
Check if sas token should be renewed at all, and then renew it if necessary
|
abstract char[] |
IotHubSasTokenAuthenticationProvider.getSasToken() |
abstract void |
IotHubSasTokenWithRefreshAuthenticationProvider.refreshSasToken()
Renew the saved sas token
|
java.lang.String |
SignatureProvider.sign(java.lang.String keyName,
java.lang.String data,
java.lang.String generationId)
Sign the provided data using the provided key name
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
TrustBundleProvider.getTrustBundleCerts(java.lang.String providerUri,
java.lang.String apiVersion,
UnixDomainSocketChannel unixDomainSocketChannel) |
java.lang.String |
HttpsHsmTrustBundleProvider.getTrustBundleCerts(java.lang.String providerUri,
java.lang.String apiVersion,
UnixDomainSocketChannel unixDomainSocketChannel)
Retrieve the list of certificates to be trusted as dictated by the HSM
|
| Modifier and Type | Method and Description |
|---|---|
static IotHubSasTokenHsmAuthenticationProvider |
IotHubSasTokenHsmAuthenticationProvider.create(SignatureProvider signatureProvider,
java.lang.String deviceId,
java.lang.String moduleId,
java.lang.String hostname,
java.lang.String gatewayHostname,
java.lang.String generationId,
int suggestedTimeToLiveSeconds,
int timeBufferPercentage)
Constructor for a IotHubSasTokenHsmAuthenticationProvider instance
|
static IotHubSasTokenHsmAuthenticationProvider |
IotHubSasTokenHsmAuthenticationProvider.create(SignatureProvider signatureProvider,
java.lang.String deviceId,
java.lang.String moduleId,
java.lang.String hostname,
java.lang.String gatewayHostname,
java.lang.String generationId,
int suggestedTimeToLiveSeconds,
int timeBufferPercentage,
javax.net.ssl.SSLContext sslContext)
Constructor for a IotHubSasTokenHsmAuthenticationProvider instance
|
TrustBundleResponse |
HttpsHsmClient.getTrustBundle(java.lang.String apiVersion)
Retrieve a trust bundle from an hsm
|
void |
IotHubSasTokenHsmAuthenticationProvider.refreshSasToken()
Renew the saved sas token using the HSM unit
|
SignResponse |
HttpsHsmClient.sign(java.lang.String apiVersion,
java.lang.String moduleName,
SignRequest signRequest,
java.lang.String generationId)
Send a sign request to the HSM using the provided parameters and return the HSM's response
|
java.lang.String |
HttpHsmSignatureProvider.sign(java.lang.String keyName,
java.lang.String data,
java.lang.String generationId)
Sign the provided data using the provided key name
|
| Modifier and Type | Class and Description |
|---|---|
class |
IotHubServiceException
Exception class that covers all exceptions communicated from the IoT Hub that are not due to connection issues in
the transport protocols.
|
class |
MultiplexingDeviceUnauthorizedException
Exception that is thrown when one or more devices fail to register to an active multiplexed connection.
|
class |
ProtocolException
Exception class that covers all exceptions that occur within transport protocol communication.
|
| Modifier and Type | Method and Description |
|---|---|
RetryDecision |
RetryPolicy.getRetryDecision(int currentRetryCount,
TransportException lastException)
Determines whether the operation should be retried and the interval until the next retry.
|
RetryDecision |
NoRetry.getRetryDecision(int currentRetryCount,
TransportException lastException)
Always says to not retry.
|
RetryDecision |
ExponentialBackoffWithJitter.getRetryDecision(int currentRetryCount,
TransportException lastException)
Determines whether the operation should be retried and the interval until the next retry.
|
void |
IotHubTransport.onConnectionLost(TransportException e,
java.lang.String connectionId) |
void |
IotHubListener.onConnectionLost(TransportException e,
java.lang.String connectionId)
Callback to be fired when connection has been lost
|
void |
IotHubTransport.onMessageReceived(IotHubTransportMessage message,
TransportException e) |
void |
IotHubListener.onMessageReceived(IotHubTransportMessage transportMessage,
TransportException e)
Callback to be fired when a transport message has been received.
|
void |
IotHubTransport.onMessageSent(Message message,
java.lang.String deviceId,
TransportException e) |
void |
IotHubListener.onMessageSent(Message message,
java.lang.String deviceId,
TransportException e)
Callback to be fired when a message that the transport client sent has been acknowledged by Iot Hub
|
void |
IotHubTransport.onMultiplexedDeviceSessionLost(TransportException e,
java.lang.String connectionId,
java.lang.String deviceId,
boolean shouldReconnect) |
void |
IotHubListener.onMultiplexedDeviceSessionLost(TransportException e,
java.lang.String connectionId,
java.lang.String deviceId,
boolean shouldReconnect)
Callback to be fired when the multiplexed connection loses a device session.
|
| Modifier and Type | Method and Description |
|---|---|
void |
IotHubTransport.handleMessage()
Invokes the message callback if a message is found and
responds to the IoT Hub on how the processed message should be
handled by the IoT Hub.
|
void |
IotHubTransportConnection.open()
Opens the transport connection object
|
void |
IotHubTransport.open(boolean withRetry)
Establishes a communication channel with an IoT Hub.
|
IotHubStatusCode |
IotHubTransportConnection.sendMessage(Message message)
Send a single message to the IotHub over the Transport Connection
|
boolean |
IotHubTransportConnection.sendMessageResult(IotHubTransportMessage message,
IotHubMessageResult result)
Send an acknowledgement to the IotHub for a message that the Transport layer received
|
| Modifier and Type | Method and Description |
|---|---|
void |
AmqpsIotHubConnection.onAuthenticationFailed(java.lang.String deviceId,
TransportException transportException) |
| Modifier and Type | Method and Description |
|---|---|
void |
AmqpsIotHubConnection.open() |
| Modifier and Type | Class and Description |
|---|---|
class |
AmqpConnectionForcedException
This exception is thrown when a amqp:connection:forced error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpConnectionFramingErrorException
This exception is thrown when a amqp:connection:framing-error error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpConnectionRedirectException
This exception is thrown when a amqp:connection:redirect error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpConnectionThrottledException
This exception is thrown when a com.microsoft:device-container-throttled error is encountered over an AMQP connection
|
class |
AmqpDecodeErrorException
This exception is thrown when a amqp:decode-error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpFrameSizeTooSmallException
This exception is thrown when a amqp:frame-size-too-small error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpIllegalStateException
This exception is thrown when a amqp:illegal-state error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpInternalErrorException
This exception is thrown when a amqp:internal-error error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpInvalidFieldException
This exception is thrown when a amqp:invalid-field error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpLinkCreationConflict |
class |
AmqpLinkDetachForcedException
This exception is thrown when a amqp:link:detach-forced error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpLinkMessageSizeExceededException
This exception is thrown when a amqp:link:message-size-exceeded error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpLinkRedirectException
This exception is thrown when a amqp:link:redirect error is encountered over an AMQP connection
Check the headers of the message with this error to see where you are being redirected to.
|
class |
AmqpLinkStolenException
This exception is thrown when a amqp:link:stolen error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpLinkTransferLimitExceededException
This exception is thrown when a amqp:link:transfer-limit-exceeded error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpNotAllowedException
This exception is thrown when a amqp:not-allowed error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpNotFoundException
This exception is thrown when a amqp:not-found error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpNotImplementedException
This exception is thrown when a amqp:not-implemented error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpPreconditionFailedException
This exception is thrown when a amqp:precondition-failed error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpResourceDeletedException
This exception is thrown when a amqp:resource-deleted error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpResourceLimitExceededException
This exception is thrown when a amqp:resource-limit-exceeded error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpResourceLockedException
This exception is thrown when a amqp:resource-locked error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpSessionErrantLinkException
This exception is thrown when a amqp:session:errant-link error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpSessionHandleInUseException
This exception is thrown when a amqp:session:handle-in-use error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpSessionUnattachedHandleException
This exception is thrown when a amqp:session:unattached-handle error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpSessionWindowViolationException
This exception is thrown when a amqp:session:window-violation error is encountered over an AMQP connection
For additional details, see this link
|
class |
AmqpUnauthorizedAccessException
This exception is thrown when a amqp:unauthorized-access error is encountered over an AMQP connection
For additional details, see this link
|
class |
ProtonIOException |
| Modifier and Type | Method and Description |
|---|---|
void |
HttpsConnection.connect()
Sends the request to the URL given in the constructor.
|
int |
HttpsConnection.getResponseStatus()
Returns the response status code.
|
DirectMethodResponse |
HttpsTransportManager.invokeMethod(DirectMethodRequest directMethodRequest,
java.lang.String deviceId,
java.lang.String moduleId)
Invoke a direct method to the provided uri
|
byte[] |
HttpsConnection.readError()
Reads from the error stream and returns the error reason.
|
byte[] |
HttpsConnection.readInput()
Reads from the input stream (response stream) and returns the response.
|
IotHubTransportMessage |
HttpsIotHubConnection.receiveMessage()
Receives an IotHubTransportMessage, if one exists.
|
HttpsResponse |
HttpsRequest.send()
Executes the HTTPS request.
|
HttpsResponse |
HttpsRequest.sendAsHttpRequest()
Executes the HTTPS request as an HTTP request.
|
HttpsResponse |
HttpsIotHubConnection.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 |
HttpsIotHubConnection.sendMessage(Message message)
Sends an event message.
|
boolean |
HttpsIotHubConnection.sendMessageResult(IotHubTransportMessage message,
IotHubMessageResult result)
Sends the message result for the previously received
message.
|
void |
HttpsConnection.setRequestMethod(HttpsMethod method)
Sets the request method (i.e.
|
| Constructor and Description |
|---|
HttpsConnection(java.net.URL url,
HttpsMethod method)
Constructor.
|
HttpsConnection(java.net.URL url,
HttpsMethod method,
ProxySettings proxySettings)
Constructor.
|
HttpsConnection(java.net.URL url,
HttpsMethod method,
ProxySettings proxySettings,
boolean isHttps)
Constructor.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BadFormatException |
class |
HubOrDeviceIdNotFoundException |
class |
InternalServerErrorException |
class |
PreconditionFailedException |
class |
QuotaExceededException |
class |
RequestEntityTooLargeException |
class |
ServerBusyException |
class |
ServiceUnknownException |
class |
ThrottledException |
class |
UnauthorizedException |
| Modifier and Type | Method and Description |
|---|---|
void |
MqttIotHubConnection.open()
Establishes a connection for the device and IoT Hub given in the client
configuration.
|
IotHubStatusCode |
MqttIotHubConnection.sendMessage(Message message)
Sends an event message.
|
boolean |
MqttIotHubConnection.sendMessageResult(IotHubTransportMessage message,
IotHubMessageResult result)
Sends an ACK to the service for the provided message
|
| Constructor and Description |
|---|
MqttIotHubConnection(ClientConfiguration config)
Constructs an instance from the given
ClientConfiguration
object. |
| Modifier and Type | Class and Description |
|---|---|
class |
MqttBadUsernameOrPasswordException
This exception is thrown when an MQTT Connection Return code of 0x04 is encountered when opening an MQTT connection
MQTT Connect Return Code Documentation
|
class |
MqttIdentifierRejectedException
This exception is thrown when an MQTT Connection Return code of 0x02 is encountered when opening an MQTT connection
MQTT Connect Return Code Documentation
|
class |
MqttRejectedProtocolVersionException
This exception is thrown when an MQTT Connection Return code of 0x01 is encountered when opening an MQTT connection
Should never be thrown since the MQTT version is hardcoded
MQTT Connect Return Code Documentation
|
class |
MqttServerUnavailableException
This exception is thrown when an MQTT Connection Return code of 0x03 is encountered when opening an MQTT connection
In the context of IoT, this exception may be encountered when trying to connect to a disabled device
MQTT Connect Return Code Documentation
|
class |
MqttUnauthorizedException
This exception is thrown when an MQTT Connection Return code of 0x05 is encountered when opening an MQTT connection
MQTT Connect Return Code Documentation
|
class |
MqttUnexpectedErrorException
This exception is thrown when an unrecognized MQTT Connection code is returned when opening an MQTT connection
MQTT Connect Return Code Documentation
|
Copyright © 2023. All rights reserved.