Skip to content
Snippets Groups Projects
Haydar Khalid Haydar Qarawlus's avatar
Haydar Qarawlus authored
Simplify usage of the toolbox

See merge request silicon-economy/base/ids/wrapper-toolbox!128
3388c64f
History

IDS Integration Toolbox

Java framework for configuring and managing the Dataspace Connector (DSC).

Table of Contents

About

The IDS Integration Toolbox (formerly known as Wrapper Toolbox) is a Java framework that aims to help developers to configure and manage the Dataspace Connector (DSC) on code level. It provides a bunch of useful tools and methods to easily integrate new or existing systems into the IDS ecosystem. Therefore, deeper knowledge in the IDS concepts or DSC API enpoints aren't needed.

Background

The International Data Spaces (IDS) initiative, formed by different research and industry partners across the globe, aims to create a decentralized ecosystem to enable secure data exchange under the consideration of data sovereignty and interoperability. One core component that is needed to participate is an IDS Connector, for example the Dataspace Connector (DSC) that follows the IDS Reference Architecture Model (RAM).

Getting Started

Prerequirements

The following things are nedded to use the IDS Integration Toolbox:

  • A Java Runtime Environment or an equivalent Docker setup
  • Maven
  • A running Dataspace Connector instance

Quick Start

  1. Create an empty Java Spring project.
  2. Add the IDS Integration Toolbox as a maven dependency in your pom.xml:
<dependency>
  <groupId>org.siliconeconomy</groupId>
  <artifactId>ids-integration-toolbox</artifactId>
  <version>${version.you.desire}</version>
</dependency>
  1. Add the packages to your Spring application:
@SpringBootApplication(scanBasePackages = {"org.siliconeconomy.idsintegrationtoolbox"})
  1. Integrate all necessary properties to your application.properties. They can be found in src/main/resources/example.properties.
  2. You are ready to use all the provided tools and functions!

More and detailed information can be found in our documentation.

In-Depth

For additional information, check out the documentation and especially the Getting-Started Guide for an in-depth overview of the library-usage and integration.

Contributing

Contributions to this project are greatly appreciated! Code changes are handled over pull requests. Detailed information can be found in the CONTRIBUTING.md guidelines and the CODE_OF_CONDUCT.md.

License

Copyright © 2021 Open Logistics Foundation. The project is licensed under the Open Logistics License 1.0. For details on the licensing terms, see the LICENSE file.

Developers