Methodensignaturen Java-SDK [M]

Warum?

Als Vorbereitung zur Erstellung des Java-SDK (#15 (closed)) soll die Funktionalität und Benutzbarkeit des Java-SDK auf Grundlage eines Grundgerüstes für eine Java-Bibliothek abgestimmt werden. Hierfür soll eine Library erstellt werden, die nur Methodensignaturen und JavaDoc (aber keine Implementierungen) enthält.

Relevante Links und Bemerkungen

• SDK-Konzept im Wiki
• inoffizielles Python-SDK
• Code-Generierung aus OpenAPI-Spec?
• GGf. Code zwischen Zustelldienst und SDK sharen?
• Gedanken über Versionsmanagement der API
• Für Rückkanal wird voraussichtlich OpenAPI 3.1 benötigt. Ggf. beachten bei Code-Generierung (Tools für OpenAPI 3.1 sind noch nicht so weit: https://github.com/OpenAPITools/openapi-generator/issues/9083)

Akzeptanzkriterien

1. Im GitLab findet sich unter https://git.fitko.de/fit-connect/sdk-java ein Grundgerüst des SDKs mit Methodensignaturen.
2. Jede Methode ist ausführlich mittels JavaDoc dokumentiert.
3. Alle Methoden werfen eine NotImplementedException (o.ä.)
4. Die folgenden Funktionalitäten sind abgebildet (nicht jede Funktionalität muss zwangsläufig über eine eigene Methode abgebildet werden, ggf. reicht auch ein // TODO: implement xyz):
   • Sender + Subscriber: Abruf von OAuth-Tokens
   • Sender: Prüfung von öffentlichen Schlüsseln und Zertifikatsketten + OCSP-Check (vgl. #119 (closed))
   • Sender: Verschlüsselung von Fachdaten (JSON, XML) mittels JWE
   • Sender: Verschlüsselung von Anhängen (Binärdaten) mittels JWE
   • Sender: Korrekte Erzeugung eines Metadatensatzes inkl. Hashwerte
   • Subscriber: Entschlüsselung von Fachdaten (JSON oder XML) mittels JWE
   • Subscriber: Entschlüsselung von Anhängen (Binärdaten) mittels JWE
   • Subscriber: Prüfung der empfangenen Metadaten gegen das zugehörige JSON-Schema
   • Subscriber: Prüfung der Hashwerte aus dem Metadatensatz.
   • Subscriber: SET-Erstellung inkl. Signaturerzeugung
   • Sender + Subscriber: SET-Empfang inkl. Signaturprüfung
   • Sender + Subscriber: Unterstüzung / Abstraktion der API-Nutzung (fitconnect.sendSubmission(metadata, destinationID, ...) o.ä.) für die oben genannten Use-Cases
   • Logging (Logging-Modul muss von außen kommen)
5. Es ist vorgesehen, dass das SDK auch über einen HTTP-Proxy genutzt werden kann (vgl. ProxyRestTemplate im Zustelldienst).

Durchführungsplan (vom Entwickler bei Storyplanung auszufüllen)

• Lesen der Wiki-Seite, Klärung von offenen Fragen
• ...
• ...
• ...
• Definition of Done wurde geprüft

added type::Story + 1 deleted label

added component::SDK - Java label

changed the description

mentioned in issue #15 (closed)

added workflow::Ready for Refinement label

changed the description

changed the description

changed the description

changed title from Methodensignaturen Java-SDK to Methodensignaturen Java-SDK [M]

mentioned in issue #427 (closed)

added workflow::Ready label and removed workflow::Ready for Refinement label

assigned to @Michael_Miera

marked this issue as related to #438 (closed)

mentioned in issue #439 (closed)

changed milestone to %Story und Task Kandidaten für Q2 2022

added workflow::In Progress label and removed workflow::Ready label

added 1 deleted label

changed the description

assigned to @Martin_Vogel and unassigned @Michael_Miera

changed the description

marked the checklist item Im GitLab findet sich unter https://git.fitko.de/fit-connect/sdk-java ein Grundgerüst des SDKs mit Methodensignaturen. as completed

marked the checklist item Die folgenden Funktionalitäten sind abgebildet (nicht jede Funktionalität muss zwangsläufig über eine eigene Methode abgebildet werden, ggf. reicht auch ein // TODO: implement xyz): as completed

marked the checklist item Alle Methoden werfen eine NotImplementedException (o.ä.) as completed

marked the checklist item Sender + Subscriber: Abruf von OAuth-Tokens as completed

marked the checklist item Sender: Prüfung von öffentlichen Schlüsseln und Zertifikatsketten + OCSP-Check (vgl. #119 (closed)) as completed

marked the checklist item Sender: Verschlüsselung von Fachdaten (JSON, XML) mittels JWE as completed

marked the checklist item Sender: Verschlüsselung von Anhängen (Binärdaten) mittels JWE as completed

marked the checklist item Sender: Korrekte Erzeugung eines Metadatensatzes inkl. Hashwerte as completed

marked the checklist item Subscriber: Entschlüsselung von Fachdaten (JSON oder XML) mittels JWE as completed

marked the checklist item Subscriber: Entschlüsselung von Anhängen (Binärdaten) mittels JWE as completed

marked the checklist item Subscriber: Prüfung der empfangenen Metadaten gegen das zugehörige JSON-Schema as completed

marked the checklist item Sender + Subscriber: Unterstüzung / Abstraktion der API-Nutzung (fitconnect.sendSubmission(metadata, destinationID, ...) o.ä.) für die oben genannten Use-Cases as completed

marked the checklist item Logging (Logging-Modul muss von außen kommen) as completed

marked the checklist item Es ist vorgesehen, dass das SDK auch über einen HTTP-Proxy genutzt werden kann (vgl. ProxyRestTemplate im Zustelldienst). as completed

marked the checklist item Subscriber: Prüfung der Hashwerte aus dem Metadatensatz. as completed

marked the checklist item Subscriber: SET-Erstellung inkl. Signaturerzeugung as completed

marked the checklist item Jede Methode ist ausführlich mittels JavaDoc dokumentiert. as completed

added workflow::Peer Review label and removed workflow::In Progress label

marked the checklist item Lesen der Wiki-Seite, Klärung von offenen Fragen as completed

added workflow::PO Review label and removed workflow::Peer Review label

added team::SDK label

mentioned in merge request sdk-java!1 (merged)

PO-Review im Merge-Request durchgeführt. Die noch offenen Kleinigkeiten bitte selbstständig bearbeiten und anschließend gerne selbsständig mergen und Issue schließen.

Ich schiebe das Issue erstmal wieder nach ~"workflow::ready", um im Kanban-Board korrekt abzubilden, woran ihr gerade arbeitet. Gerne wieder in ~"In Bearbeitung" schieben, sobald Du die offenen Punkte angehst. Anschließend Abkürzung: ~"Peer Review" -> Close

Falls noch Rückfragen sind, gerne nochmal in ~"PO Review" platzieren.

added workflow::Ready label and removed workflow::PO Review label

added workflow::In Progress label and removed workflow::Ready label

mentioned in commit sdk-java@d332facc

closed