Deprecated API

Contents

• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Classes

Class and Description
com.microsoft.azure.sdk.iot.device.CustomLogger
com.microsoft.azure.sdk.iot.device.TransportClient This client has been replaced with MultiplexingClient since this client does not support adding or removing devices once the connection has been established. MultiplexingClient allows for adding and removing of devices from multiplexed connections before or after opening the connection.

Deprecated Fields

Field and Description
com.microsoft.azure.sdk.iot.device.DeviceClient.CONNECTION_STRING_CHARSET as of release 1.2.27 this value is deprecated and will not be replaced. The charset used for URL-encoding the device ID in the connection string.
com.microsoft.azure.sdk.iot.device.DeviceClient.DEVICE_ID_ATTRIBUTE as of release 1.2.27 this value is deprecated and will not be replaced. The device ID attribute name in a connection string.
com.microsoft.azure.sdk.iot.device.DeviceClient.HOSTNAME_ATTRIBUTE as of release 1.2.27 this value is deprecated and will not be replaced. The hostname attribute name in a connection string.
com.microsoft.azure.sdk.iot.device.DeviceClient.RECEIVE_PERIOD_MILLIS_AMQPS as of release 1.2.27 these value is deprecated and replaced by DeviceClient.setOption(String, Object) SetMinimumPollingInterval to change it. The number of milliseconds the transport will wait between polling for messages.
com.microsoft.azure.sdk.iot.device.DeviceClient.RECEIVE_PERIOD_MILLIS_HTTPS
com.microsoft.azure.sdk.iot.device.DeviceClient.RECEIVE_PERIOD_MILLIS_MQTT
com.microsoft.azure.sdk.iot.device.DeviceClient.SEND_PERIOD_MILLIS as of release 1.2.27 this value is deprecated and replaced by DeviceClient.setOption(String, Object) SetSendInterval to change it. The number of milliseconds the transport will wait between sending out messages.
com.microsoft.azure.sdk.iot.device.DeviceClient.SHARED_ACCESS_KEY_ATTRIBUTE as of release 1.2.27 this value is deprecated and will not be replaced. The shared access key attribute name in a connection string.
com.microsoft.azure.sdk.iot.device.DeviceClient.SHARED_ACCESS_TOKEN_ATTRIBUTE as of release 1.2.27 this value is deprecated and will not be replaced. The shared access signature attribute name in a connection string.

Deprecated Methods

Method and Description
com.microsoft.azure.sdk.iot.device.DeviceClient.close() : As of release 1.1.25 this call is replaced by DeviceClient.closeNow()
com.microsoft.azure.sdk.iot.device.DeviceClient.completeFileUploadAsync(FileUploadCompletionNotification) This function is not actually async, so use DeviceClient.completeFileUpload(FileUploadCompletionNotification) to avoid confusion
com.microsoft.azure.sdk.iot.device.CustomLogger.LogFatal(String, Object...) Since the switch from Log4j to slf4j there is no fatal log level anymore. Mapped to error level
com.microsoft.azure.sdk.iot.device.DeviceClient.registerConnectionStateCallback(IotHubConnectionStateCallback, Object) as of release 1.10.0 by InternalClient.registerConnectionStatusChangeCallback(IotHubConnectionStatusChangeCallback callback, Object callbackContext)
com.microsoft.azure.sdk.iot.device.Message.setContentType(String) as of device-client version 1.14.1, please use Message.setContentTypeFinal(String)
com.microsoft.azure.sdk.iot.device.DeviceClient.uploadToBlobAsync(String, InputStream, long, IotHubEventCallback, Object) Use DeviceClient.getFileUploadSasUri(FileUploadSasUriRequest) to get the SAS URI, use the azure storage SDK to upload a file to that SAS URI, and then use DeviceClient.completeFileUpload(FileUploadCompletionNotification) to notify Iot Hub that your file upload has completed, successfully or otherwise. This method does all three of these tasks for you, but has limited configuration options.

Deprecated Constructors

Constructor and Description
com.microsoft.azure.sdk.iot.device.DeviceClient(String, IotHubClientProtocol, SSLContext) For x509 authentication, use DeviceClient(String, IotHubClientProtocol, ClientOptions) and provide an SSLContext instance in the ClientOptions instance. For a sample on how to build this SSLContext, see this code which references a helper class for building SSLContext objects for x509 authentication as well as for SAS based authentication. When not using this deprecated constructor, you can safely exclude the Bouncycastle dependencies that this library declares. See this pom.xml for an example of how to do this.
com.microsoft.azure.sdk.iot.device.DeviceClient(String, IotHubClientProtocol, String, boolean, String, boolean) For x509 authentication, use DeviceClient(String, IotHubClientProtocol, ClientOptions) and provide an SSLContext instance in the ClientOptions instance. For a sample on how to build this SSLContext, see this code which references a helper class for building SSLContext objects for x509 authentication as well as for SAS based authentication. When not using this deprecated constructor, you can safely exclude the Bouncycastle dependencies that this library declares. See this pom.xml for an example of how to do this.
com.microsoft.azure.sdk.iot.device.DeviceClient(String, TransportClient) MultiplexingClient should be used instead of TransportClient for creating all multiplexed connections.
com.microsoft.azure.sdk.iot.device.ModuleClient(String, IotHubClientProtocol, SSLContext) For x509 authentication, use ModuleClient(String, IotHubClientProtocol, ClientOptions) and provide an SSLContext instance in the ClientOptions instance. For a sample on how to build this SSLContext, see this code which references a helper class for building SSLContext objects for x509 authentication as well as for SAS based authentication. When not using this deprecated constructor, you can safely exclude the Bouncycastle dependencies that this library declares. See this pom.xml for an example of how to do this.
com.microsoft.azure.sdk.iot.device.ModuleClient(String, IotHubClientProtocol, String, boolean, String, boolean) For x509 authentication, use ModuleClient(String, IotHubClientProtocol, ClientOptions) and provide an SSLContext instance in the ClientOptions instance. For a sample on how to build this SSLContext, see this code which references a helper class for building SSLContext objects for x509 authentication as well as for SAS based authentication. When not using this deprecated constructor, you can safely exclude the Bouncycastle dependencies that this library declares. See this pom.xml for an example of how to do this.

Deprecated Enum Constants

Enum Constant and Description
com.microsoft.azure.sdk.iot.device.transport.amqps.IoTHubConnectionType.USE_TRANSPORTCLIENT