Industrial IoT SDK for Java¶
Introduction¶
The Industrial IoT SDK for Java enables Java developers to work with Insights Hub easily. It provides a Java client implementation for the RESTful Industrial IoT APIs.
The Industrial IoT SDK for Java provides client implementations for the following APIs:
Name | API Version |
---|---|
Asset Management | 3.4 |
IoT Time Series | 3.1 |
IoT TS Aggregates | 3.0 |
IoT File | 3.1 |
Event Management | 3.5 |
Event Analytics | 3.0 |
See the Getting Started for installation and configuration of an API client.
Get the SDK¶
You can download the Industrial IoT SDK for Java from the Siemens Industry Online Support (SIOS) Portal by following these links [EN]/[DE].
Features¶
Client Configuration¶
You can easily configure the Industrial IoT SDK for Java through configuration parameters such as proxy settings and connection time-outs.
Authorization Handling Mechanism¶
The Industrial IoT SDK for Java provides an easy authorization handling mechanism. Developers can configure user authorization tokens or service credentials. The SDK provides multiple ways for setting up service credentials for use in an API client. Environment variables can be set for service credential configuration to generate authorization for API calls.
Page Iterators¶
This SDK for Java provides page iterator objects for easy pagination for most API clients. Developer applications can configure paging parameters and get next/previous or specific page data.
Logging¶
The Industrial IoT SDK for Java logging is configured with SLF4J, which is an abstraction layer that enables the use of any logging framework at runtime. Supported logging systems include the Java Logging Framework and Apache Log4j, among others. The Industrial IoT SDK logging can be enabled or disabled by the developer application.
See Logging for more information.
Exception Handling¶
This SDK provides an exception handling mechanism. The SDK exceptions are structured to identify client and server exceptions. Information such as error code, message, HTTP status, logref and cause can help to easy identify exceptions.
See Exception Handling for more information.