Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 2.55 KB

README.md

File metadata and controls

51 lines (39 loc) · 2.55 KB
Raw

IOTA Integration Services Java SDK

This is the Java SDK for easy usability of the Integration Services API.

Prerequisites

Examples

Getting Started

Please set up the following files in order to generate the JAR and run the code locally:

  • env.properties - with the following structure: 
    api-key=XXXXXXX
api-version=vX.X
api-url=XXXXXXX
identity-file=adminIdentity.json
  • adminIdentity.json - will contain the admin identity object (json file with elements doc and key)

Then, perform the following steps:

mvn clean install

You are now ready to use the JAR and access the classes. Please remember to keep the env.properties in the same folder as the JAR. The JAR can be used as a dependency to run the examples, which, contrary to the node implementation, exist as part of their own package which depends on this project's JAR (see examples/pom.xml)

The IOTA Foundation has created a handy wiki to help you better understand the platform's characteristics and usage. A Java-specific section is coming soon. In the meantime, please refer to the node section.

A basic Dockerfile has been provided to help you run this code in its own container.

Extending this codebase

We have kept this codebase as small and general-purpose as possible, wrapping it in a Maven project to facilitate the creation of JAR files and libraries. Below are suggested extensions that the Integration Services team and/or future maintainers could consider implementing:

  • Hook this codebase to a MongoDB instance as per the Node.js implementation
  • Write unit tests
  • Gradle support

Authors

  • Project Owner & Maintainer: Alberto De Capitani [GitHub, Email]
  • Lead developer: Giulio Casarotti [GitHub, Email]

Special thanks to Michele Nati, Dominic Zettl and Michele Mastrogiovanni for their precious contributions.