Skip to content

emnify/emnify-sdk-java

Repository files navigation

emnify Java SDK

Build Status Maven Central codecov Bugs

Supply your swarm of IoT devices with cloud connectivity by emnify. Automate your routines with this SDK for Java.

Installation

The recommended method for installing the SDK is with a build automation tool, like Maven or Gradle. You can add the emnify dependency to your existing project, specifying the latest version.

Regardless of the package manager you are using, you need to specify the latest version of the emnify Java SDK. The following examples use {version} where this should be specified.

Maven

Use the following dependency in your project to grab via Maven:

    <dependency>
        <groupId>com.emnify.sdk</groupId>
        <artifactId>emnify</artifactId>
        <version>{version}</version>
    </dependency>

Gradle

Use the following to add the emnify dependency to your project via Gradle:

    implementation group: "com.emnify.sdk", name: "emnify", version: "{version}"

Compile the SDK yourself

If you want to compile it yourself, here's how:

    git clone git@github.com:EMnify/emnify-sdk-java
    cd emnify-sdk-java
    mvn install # Requires Maven

If you want to build your own .jar, execute the following from within the cloned directory:

  mvn package

Supported Java versions

This library supports the following Java implementations:

TLS requirements

Refer to the SSL Report table for the supported Transport Layer Security (TLS) versions.

Environment variables

You can use environment variables for storing configuration settings like an application token or a base URL instead of hardcoding them in your application.

Name Description
EMNIFY_BASE_PATH Base URL to form a request. Default value: https://cdn.emnify.net
EMNIFY_APPLICATION_TOKEN Variable for authenticating via an application token.
EMNIFY_USERNAME and EMNIFY_PASSWORD Variables for authenticating via username and password.

Documentation

Read more about working with the Java SDK and the underlying concepts in the emnify product documentation.

Contributing

If you've found a bug or would like to add new features, open an issue or create a pull request to this Github repository.

Please note that this project is governed by emnify's Code of Conduct. By participating, you agree to abide by its terms.

Get support

If you need help using our services, please file a support ticket.