README.md

\textcolor{#890000}{\text{THIS SDK IS IN DEVELOPMENT AND NOT READY FOR PRODUCTION USE YET!!!}}

About the FIT-Connect Java SDK

The Java SDK for FIT-Connect enables to build clients for senders and subscribers without directly interacting with any REST-Endpoints. It provides a simple fluent API that guides through the creation and sending of a submission, as well as receiving submissions as a subscriber.

For further information, check out the official docs: FIT-Connect Documentation as well as the:

• Self-Service-Portal (Testing Environment)
• FITKO project website

Outline

• About the FIT-Connect Java SDK
• Outline
• Getting Started
  • Build Dependencies
  • Prerequisites
  • Add FIT-Connect SDK to your build
• Modules
• Setup
• API Usage for Sender
  • Hand in already encrypted submission (e.g. from frontend)
    • 1. Retrieve public encryption key:
    • 2. Send encrypted data
  • Hand in a new submission with unencrypted data
• API Usage for Subscriber
  • Retrieving submissions
    • List with pagination
    • List without pagination
    • Receive single submission
  • Sending events to the event-log
    • Accepting a submission
    • Rejecting a submission
• Roadmap
• Contact
• License

Getting Started

How to set up the SDK project locally.

Build Dependencies

This section lists major frameworks/libraries used in the SDK.

• Java 11 (LTS)
• Maven 3.x
• Junit 5

Further 3rd party dependencies:

• Nimbus-Jose JWT
• Spring Web/HTTP
• Jackson FasterXMl
• JCommander
• Snakeyaml

Prerequisites

• Java Runtime >= 11, check your current setup in your commandline

  java --version 

(back to top)

Add FIT-Connect SDK to your build