The Azure IoT SDK team is releasing a new major version for the Azure IoT Java SDK. This version has a smaller set of dependencies making it a much lighter SDK overall! Since it is a major and fantastic (if we may say so ourselves) overhaul, there are many breaking changes and improvements over the previous version. A detailed migration guide is provided here.
Specifically, the new version will have:
- Fewer dependencies
- More consistent API naming
- Change in how we handle trusted certificates
- Removal of all previously deprecated code
The most significant breaking change is how the SDK reads its trusted certificates. Until now, trusted certificates were read from source code. Now the SDK will rely on the device’s trusted certificate store to read the required certificates. This will also aid in preparing devices for root changes like the upcoming Baltimore Root migration that Azure IoT Hub and Device Provisioning Service will be undertaking. You can read more generally about the migration here, and SDK specific information is available here.
Some Important FAQs
Question: What do I gain by upgrading to the 2.X.X release?
Answer: You get a smaller set of dependencies which makes for a lighter SDK overall. You also get a more concise and clearer API surface since all deprecated APIs have been removed. Lastly, and most importantly, you get an SDK that is decoupled from a particular IoT hub and Device Provisioning Service root certificate. This makes these versions more future proof since they aren't tied to a root certificate that will be changed within a few years and may be changed again beyond then. Read the migration guide for detailed information on how to switch to this new version.
Question: Will the 1.X.X releases still be supported in any way?
Answer: We will continue to support the long-term support releases of the 1.X.X SDK for their lifespans, but we will not bring newer features to the 1.X.X SDK. Users who want access to the upcoming features are encouraged to upgrade to the 2.X.X SDK.
Testing and Feedback
To try out the new Java SDK, you can download the JAR files from here. We are always open and looking for feedback. For any comments, suggestions, or feedback, please use GitHub discussions.