Skip to content

MindSphere SDK V2 for Java

Introduction

The MindSphere SDK V2 for Java enables developers to work with the MindSphere IoT platform 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 MindSphere Platform APIs. All service modules have a dependency on the core module.

The MindSphere SDK V2 for Java provides client implementations for the following APIs:

Name API Version
Asset Management 3.8
IoT Time Series 3.1
IoT TS Aggregates 3.2
IoT File 3.1
Event Analytics 3.1

Refer to the Getting Started for installation and configuration of an API client.

Get the SDK

The MindSphere SDK V2 for Java is available for download on the Siemens Industry Online Support (SIOS) Portal [EN]/[DE]. The SDK core and service specific modules are bundled into a zip file. It is possible to only unzip those modules you intend to use.

Features

The MindSphere 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.

Java SDK Core

The core module of the MindSphere SDK V2 for Java handles authorization, client configuration, exception handling, and common API Client for the RESTful MindSphere platform APIs. All the clients have a dependency on the core module.

Client Configuration

You can easily configure the MindSphere SDK V2 for Java through configuration parameters such as proxy settings and connection time-outs.

Authorization Handling Mechanism

The MindSphere SDK V2 for Java provides an easy authorization handling mechanism. Developers can configure user authorization tokens or service credentials. Service credentials for use in an API client can be set up in multiple ways. Environment variables can be set for service credential configuration to generate authorization for API calls.

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 MindSphere 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 MindSphere 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 MindSphere 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.

Any questions left?

Ask the community


Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.