Industrial IoT SDK V2 for Java¶
Introduction¶
The Industrial SDK V2 for Java enables developers to work with Industrial IoT easily. It is divided into a core module and several service modules, which allows developers to include only those parts of the SDK required for their use case.
The core module provides authentication, exception handling, logging features and a common Java client implementation for the RESTful Industrial IoT APIs. All service modules have a dependency on the core module.
The Industrial IoT SDK V2 for Java provides client implementations for the following APIs:
| Name | API Version | SDK Version |
|---|---|---|
| SDK Core | 2.4.0 | |
| Agent Management | 3.2.1 | 3.5.2 |
| Asset Management | 3.9.1 | 3.9.9 |
| Event Management | 3.8.1 | 3.8.10 |
| Event Analytics | 3.1.1 | 3.2.1 |
| IoT File | 3.2.4 | 3.3.0 |
| IoT Time Series | 3.4.4 | 3.4.5 |
| IoT TS Aggregates | 4.0.0 | 4.2.1 |
| Token Management Service | 3.0.0 | 3.1.5 |
| Integrated Data Lake | 3.2.0 | 3.2.4 |
| IoT Bulk Data | 3.5.0 | 3.5.1 |
| MindConnect | 3.5.1 | 3.5.3 |
Following older SDK & API versions can be referred for backward compatibility & will be deprecated in upcoming SDK releases:
| Name | API Version | SDK Version |
|---|---|---|
| IoT Time Series | 3.4.1 | 3.4.1 |
| IoT TS Aggregates | 3.1.1 | 3.1.6 |
Refer to the Getting Started for installation and configuration of an API client.
Get the SDK¶
The Industrial IoT SDK V2 for Java is available for download on the Siemens Industry Online Support (SIOS) Portal. The SDK core and service specific modules are in JAR format and bundled into a ZIP file. It is possible to only unzip those modules you intend to use.
Download for region China 1
For region China 1, download the zip file with Region China special label version from the Siemens Industry Online Support (SIOS) Portal.
Features¶
The Industrial IoT SDK V2 for Java provides the same core features as the previous version. It bundles these features in the core module, which is separate from the individual service modules.
Industrial IoT SDK Core¶
The core module of the Industrial IoT SDK V2 for Java handles authorization, client configuration, exception handling, and common API Client for the RESTful Industrial IoT APIs. All the clients have a dependency on the core module.
Client Configuration¶
You can easily configure the Industrial IoT SDK V2 for Java through configuration parameters such as proxy settings and connection time-outs.
Token Handling Mechanism¶
The Industrial IoT SDK V2 for Java provides an easy authorization handling mechanism. It handles technical token fetching, caching, validation and re-fetching based on user authorization tokens or service credentials configured by developers.
Refer to Token Handling for more information.
Logging¶
Logging is configured with SLF4J, which is an abstraction layer that enables the use of any logging framework at runtime, such as Java Logging Framework and Apache Log4j. The logging can be enabled or disabled by the developer application.
Refer to Logging for more information.
Exception Handling¶
The Industrial IoT SDK V2 for Java provides an exception handling mechanism. Different exception classes help to identify whether an exception was caused by your client or by the Industrial IoT server. Detailed information such as error code, message, HTTP status, logref, and cause are provided for investigation.
Refer to Exception Handling for more information.
Page Iterators¶
The Industrial IoT SDK V2 for Java provides page iterator objects for most API clients, which allows for easy pagination. Developer applications can configure paging parameters and request the next/previous page or a specific page number.