\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:
Outline
- About the FIT-Connect Java SDK
- Outline
- Getting Started
- Modules
- Setup
- API Usage for Sender
- API Usage for Subscriber
- 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
Add FIT-Connect SDK to your build
To add a dependency on FIT-Connect using Maven, use the following:
<dependency>
<groupId>dev.fitko.fitconnect.sdk</groupId>
<artifactId>client</artifactId>
<version>[Latest Version]</version>
</dependency>
With [Latest Version]
of the last stable build or snapshot.
If you use a snapshot version, please add the maven snapshot repo to your pom.
<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
</distributionManagement>
Modules
See the projects' module documentation for more specific information:
Setup
The following steps show how to get the SDK running
- Create and account on the self service portal
- Get your sender/subscriber API-key credentials
- Clone the sdk repo
git clone https://git.fitko.de/fit-connect/sdk-java
- Build the project
./mvnw clean install -DskipTests
- Enter your API keys and references to your private decryption key in
config.yml
- Provide config via environment variable
FIT_CONNECT_CONFIG
or load the config withvar config = ApplicationConfigLoader.loadConfig("absolute/path/to/config.yml"); var senderClient = ClientFactory.senderClient(config);
API Usage for Sender
The fluent API client for sender and subscriber allows method chaining to guide through all necessary steps and is called via dev.fitko.fitconnect.client.factory.ClientFactory
.
Hand in already encrypted submission (e.g. from frontend)
If all data, metadata and attachments are encrypted outside the SDK the sender client allows to retrieve the public key for encryption as well as sending of already encrypted payloads.
For further information on how to implement end-2-end encryption please check the FIT-Connect documentation.
1. Retrieve public encryption key:
Optional<String> publicJwk = ClientFactory.senderClient(config).getPublicKey(UUID.fromString("d2d43892-9d9c-4630-980a-5af341179b14"));
2. Send encrypted data
ClientFactory.senderClient(config)
.newSubmissionWithEncryptedData("$encrpyt€ed d@t@")
.withEncryptedAttachment(UUID.fromString("attachmentId"), "$encrpyt€ed @tt@chment")
.withEncryptedJsonData("{$encrpyt€ed json}")
.withEncryptedMetadata("$encrpyt€ed metadata")
.withDestination(UUID.fromString("d2d43892-9d9c-4630-980a-5af341179b14"))
.withServiceType("TestService", "Führerscheinbeantragung", "urn:de:fim:leika:leistung:99400048079000")
.submit();
Hand in a new submission with unencrypted data
If all data, metadata and attachments are encrypted in the sender using the SDK, the client automatically handles the encryption.
Be aware that this example is not end-2-end encrypted, see FIT-Connect documentation for details.
ClientFactory.senderClient(config)
.newSubmission()
.withAttachment(Path.of("path/to/attachment.txt").toFile()) // optional
.withJsonData("{ \"foo\" : \"bar\"}")
.withDestination(UUID.fromString("d2d43892-9d9c-4630-980a-5af341179b14"))
.withServiceType("TestService", "Führerscheinbeantragung", "urn:de:fim:leika:leistung:99400048079000")
.submit();
Read the Event-Log
To read the event-log, destinationId and caseId are needed.
var destinationId = UUID.fromString("d2d43892-9d9c-4630-980a-5af341179b14");
var caseId = UUID.fromString("d2d43892-9d9c-4630-980a-5af341179b14");
List<EventLogEntry> eventLog = ClientFactory.senderClient(config).getEventLog(caseId, destinationId);
for(EventLogEntry logEntry: eventLog) {
LOGGER.info("Event: {}", logEntry.getEvent());
LOGGER.info("EventId: {}", logEntry.getEventId());
LOGGER.info("Issued at: {}", logEntry.getIssueTime());
LOGGER.info("Issuer: {}", logEntry.getIssuer());
LOGGER.info("CaseId: {}", logEntry.getCaseId());
LOGGER.info("SubmissionId: {}", logEntry.getSubmissionId());
LOGGER.info("Problems: {}", logEntry.getProblems());
}
The log contains the event, issuer and occurred problems like shown in the example output below:
Event: https://schema.fitko.de/fit-connect/events/submit-submission
EventId: 659bcbe7-fd53-4313-a1c3-192bccc95f94
Issued at: Thu Dec 15 10:23:51 CET 2022
Issuer: https://submission-api-testing.fit-connect.fitko.dev
CaseId: cb9a5a78-0ec6-492c-b652-0d7aa5e488b0
SubmissionId: 7502200b-f12d-4fc5-9669-ad3e3337396b
Problems: []
Read the latest status of a submission
Instead of the entire log, the latest status for a submission can be retrieved as well.
SentSubmission sentSubmission = ... // sent submission by sender client
EventStatus eventStatus = ClientFactory.senderClient(config).getStatusForSubmission(sentSubmission);
LOGGER.info("Current status for submission {} => {}", sentSubmission.getSubmissionId(), eventStatus.getStatus());
The example output shows the current state of the submission after being created, following the transitions in the diagram below:
Current status for submission 43cf7163-5163-4bc8-865e-be96e271ecc3 => incomplete
API Usage for Subscriber
Retrieving submissions
Submissions can be fetched by id or as a list of submissions for a specific case.
List with pagination
Limit and offset parameters allow to page through the result.
int offset = 0;
int limit = 100;
Set<SubmissionForPickup> firstOneHundredSubmissions = ClientFactory.subscriberClient(config).getAvailableSubmissions(UUID.fromString("d2d43892-9d9c-4630-980a-5af341179b14"), limit, offset);
List without pagination
Listing available submissions without pagination pulls the first 500 entries.
Set<SubmissionForPickup> submissions = ClientFactory.subscriberClient(config).getAvailableSubmissions(UUID.fromString("d2d43892-9d9c-4630-980a-5af341179b14"));
Receive single submission
Optional<ReceivedSubmission> submission = ClientFactory.subscriberClient(config).requestSubmission(UUID.fromString("submissionId"));
Sending events to the event-log
In order to accept or reject a submission, the subscriber client can send events (security-event-tokens) to the event-log. For more details please see the documentation on events and the creation of set-events.
Accepting a submission
If the functional review by the subscriber was positive, the submission can be accepted with an accept-submission
event.
ClientFactory.subscriberClient(config)
.requestSubmission(UUID.fromString("d2d43892-9d9c-4630-980a-5af341179b14"))
.acceptSubmission();
After the accept event was sent the submission transitions into the state deleted
and is removed.
Rejecting a submission
If the functional or technical review by the subscriber was negative, e.g. there is a discrepancy within the semantics of the data, the submission can be rejected with an reject-submission
event.
The rejection takes a list of dev.fitko.fitconnect.api.domain.model.event.problems.*
as parameter to specify the problem.
See the Fit-Connect documentation for more details on available (technical) problems.
ClientFactory.subscriberClient(config)
.requestSubmission(UUID.fromString("d2d43892-9d9c-4630-980a-5af341179b14"))
.rejectSubmission(List.of(new DataSchemaViolation()));
After the rejection event was sent the submission transitions into the state deleted
and is removed.
Read the Event-Log
To read the event-log, destinationId and caseId are needed.
var destinationId = UUID.fromString("d2d43892-9d9c-4630-980a-5af341179b14");
var caseId = UUID.fromString("d2d43892-9d9c-4630-980a-5af341179b14");
List<EventLogEntry> eventLog = ClientFactory.subscriberClient(config).getEventLog(caseId, destinationId);
for(EventLogEntry logEntry: eventLog) {
LOGGER.info("Event: {}", logEntry.getEvent());
LOGGER.info("EventId: {}", logEntry.getEventId());
LOGGER.info("Issued at: {}", logEntry.getIssueTime());
LOGGER.info("Issuer: {}", logEntry.getIssuer());
LOGGER.info("CaseId: {}", logEntry.getCaseId());
LOGGER.info("SubmissionId: {}", logEntry.getSubmissionId());
LOGGER.info("Problems: {}", logEntry.getProblems());
}
The log contains the event, issuer and occurred problems like shown in the example output below:
Event: https://schema.fitko.de/fit-connect/events/create-submission
EventId: 659bcbe7-fd53-4313-a1c3-192bccc95f94
Issued at: Thu Dec 15 10:23:51 CET 2022
Issuer: https://submission-api-testing.fit-connect.fitko.dev
CaseId: cb9a5a78-0ec6-492c-b652-0d7aa5e488b0
SubmissionId: 7502200b-f12d-4fc5-9669-ad3e3337396b
Problems: []
For more details please see the event-log documentation.
Roadmap
- Add SET-Event handling
- Add Routing features
- Add Callback handling
See the open issues for a full list of proposed features (and known issues).
Contact
FIT-Connect Contact Page for further information
License
Source code is licensed under the EUPL.
Rechtlicher Hinweis: Dieses Software Development Kit (SDK) ist dazu bestimmt, die Anbindung einer Software an die FIT-Connect-Infrastruktur zu ermöglichen. Hierfür kann das SDK in die anzubindenden Software integriert werden. Erfolgt die Integration des SDK in unveränderter Form, liegt keine Bearbeitung im Sinne der EUPL bzw. des deutschen Urheberrechts vor. Die Art und Weise der Verlinkung des SDK führt insbesondere nicht zur Schaffung eines abgeleiteten Werkes. Die unveränderte Übernahme des SDK in eine anzubindende Software führt damit nicht dazu, dass die anzubindende Software unter den Bedingungen der EUPL zu lizenzieren ist. Für die Weitergabe des SDK selbst - in unveränderter oder bearbeiteter Form, als Quellcode oder ausführbares Programm - gelten die Lizenzbedingungen der EUPL in unveränderter Weise.