From c878d0073a4e1bfb1f5c5744b2550b1656e36cb8 Mon Sep 17 00:00:00 2001
From: Martin Vogel <martin.vogel@sinc.de>
Date: Fri, 17 Jun 2022 14:37:10 +0200
Subject: [PATCH] #414 Remove german javadoc (to be replaced with an english
version)
---
README.md | 2 +-
.../domain/model/metadata/AdditionalReferenceInfo.java | 4 ----
.../api/domain/model/metadata/ContentStructure.java | 3 ---
.../api/domain/model/metadata/PublicServiceType.java | 7 -------
.../domain/model/metadata/attachment/Attachment.java | 4 ----
.../api/domain/model/metadata/attachment/Purpose.java | 6 ------
.../attachment/signature/EidasAdesProfile.java | 5 -----
.../model/metadata/attachment/signature/Hash__1.java | 6 ------
.../metadata/attachment/signature/SignatureFormat.java | 3 ---
.../metadata/attachment/signature/Signature__1.java | 3 ---
.../model/metadata/attachment/signature/Type.java | 3 ---
.../api/domain/model/metadata/data/Data.java | 3 ---
.../domain/model/metadata/data/EidasAdesProfile.java | 5 -----
.../api/domain/model/metadata/data/Hash.java | 6 ------
.../api/domain/model/metadata/data/MimeType.java | 3 ---
.../api/domain/model/metadata/data/Signature.java | 3 ---
.../domain/model/metadata/data/SignatureFormat.java | 3 ---
.../domain/model/metadata/data/SubmissionSchema.java | 6 ------
.../api/domain/model/metadata/data/Type.java | 3 ---
client/README.md | 10 +++++-----
.../de/fitko/fitconnect/cmd/CommandLineRunner.java | 2 ++
21 files changed, 8 insertions(+), 82 deletions(-)
diff --git a/README.md b/README.md
index a961e35a1..f9f056069 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
### Build
-To build the maven artifact, run: `mvn clean install`
+To build the maven artifact, run: `mvn clean package`
####
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/AdditionalReferenceInfo.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/AdditionalReferenceInfo.java
index 56460300c..07e92aadc 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/AdditionalReferenceInfo.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/AdditionalReferenceInfo.java
@@ -9,10 +9,6 @@ import lombok.Setter;
import java.util.Map;
-/**
- * Eine Struktur, um zusätzliche Informationen zu hinterlegen
- */
-
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"senderReference",
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/ContentStructure.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/ContentStructure.java
index b3ae4bb1b..8e06ae6c6 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/ContentStructure.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/ContentStructure.java
@@ -12,9 +12,6 @@ import lombok.Setter;
import java.util.List;
import java.util.Map;
-/**
- * Beschreibt die Struktur der zusätzlichen Inhalte der Einreichung, wie Anlagen oder Fachdaten.
- */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"data",
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/PublicServiceType.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/PublicServiceType.java
index cb06e95d1..fb29a6d1c 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/PublicServiceType.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/PublicServiceType.java
@@ -9,13 +9,6 @@ import lombok.Setter;
import java.util.Map;
-/**
- * Verwaltungsleistung
- * <p>
- * Beschreibung der Art der Verwaltungsleistung. Eine Verwaltungsleistung sollte immer mit einer LeiKa-Id beschrieben werden.
- * <p>
- * Ist für die gegebene Verwaltungsleistung keine LeiKa-Id vorhanden, kann die Verwaltungsleistung übergangsweise über die Angabe einer anderen eindeutigen Schema-URN beschrieben werden.
- */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"name",
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/Attachment.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/Attachment.java
index f26482f7f..8147f7664 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/Attachment.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/Attachment.java
@@ -12,10 +12,6 @@ import lombok.Setter;
import java.util.Map;
import java.util.UUID;
-
-/**
- * Eine in der Einreichung enthaltene Anlage.
- */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"hash",
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/Purpose.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/Purpose.java
index 3b2e50565..a5726ea38 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/Purpose.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/Purpose.java
@@ -6,12 +6,6 @@ import com.fasterxml.jackson.annotation.JsonValue;
import java.util.HashMap;
import java.util.Map;
-/**
- * Zweck/Art der Anlage
- * - form: Automatisch generierte PDF-Repräsentation des vollständigen Antragsformulars
- * - attachment: Anlage, die von einem Bürger hochgeladen wurde
- * - report: Vom Onlinedienst, nachträglich erzeugte Unterlage
- */
public enum Purpose {
FORM("form"),
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/EidasAdesProfile.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/EidasAdesProfile.java
index 767a80717..21199aef3 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/EidasAdesProfile.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/EidasAdesProfile.java
@@ -6,11 +6,6 @@ import com.fasterxml.jackson.annotation.JsonValue;
import java.util.HashMap;
import java.util.Map;
-/**
- * Referenziert ein eindeutiges Profil einer AdES (advanced electronic signature/seal) gemäß eIDAS-Verordnung über eine URI gemäß [ETSI TS 119 192](https://www.etsi.org/deliver/etsi_ts/119100_119199/119192/01.01.01_60/ts_119192v010101p.pdf).
- * <p>
- * Für die Details zur Verwendung und Validierung von Profilen siehe auch https://ec.europa.eu/cefdigital/DSS/webapp-demo/doc/dss-documentation.html#_signatures_profile_simplification
- */
public enum EidasAdesProfile {
HTTP_URI_ETSI_ORG_ADES_191_X_2_LEVEL_BASELINE_B_B("http://uri.etsi.org/ades/191x2/level/baseline/B-B#"),
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Hash__1.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Hash__1.java
index 78ad80e7e..3522e8d5d 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Hash__1.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Hash__1.java
@@ -9,12 +9,6 @@ import lombok.Setter;
import java.util.Map;
-/**
- * Hashwert
- * <p>
- * Der Hashwert der unverschlüsselten Anlage.
- * Die Angabe des Hashwertes dient der Integritätssicherung des Gesamtantrags und schützt vor einem Austausch der Anlage durch Systeme zwischen Sender und Subscriber (z.B. dem Zustelldienst).
- */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"type",
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/SignatureFormat.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/SignatureFormat.java
index 6f1510387..b9c613efe 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/SignatureFormat.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/SignatureFormat.java
@@ -6,9 +6,6 @@ import com.fasterxml.jackson.annotation.JsonValue;
import java.util.HashMap;
import java.util.Map;
-/**
- * Beschreibt, welches Signaturformat die genutzte Signatur / das genutzte Siegel nutzt. Aktuell wird die Hinterlegung folgender Signaturformate unterstützt: CMS = Cryptographic Message Syntax, Asic = Associated Signature Containers, PDF = PDF Signatur, XML = XML-Signature, JSON = JSON Web Signature.
- */
public enum SignatureFormat {
CMS("cms"),
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Signature__1.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Signature__1.java
index de42b349f..b2288869a 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Signature__1.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Signature__1.java
@@ -10,9 +10,6 @@ import lombok.Setter;
import java.util.Map;
-/**
- * Beschreibt das Signaturformt und Profile
- */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"signatureFormat",
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Type.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Type.java
index 16257d48e..17b4660ee 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Type.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/attachment/signature/Type.java
@@ -6,9 +6,6 @@ import com.fasterxml.jackson.annotation.JsonValue;
import java.util.HashMap;
import java.util.Map;
-/**
- * Der verwendete Hash-Algorithmus. Derzeit ist nur `sha512` erlaubt.
- */
public enum Type {
SHA_512("sha512");
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Data.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Data.java
index d83e7c441..58e9dc5d8 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Data.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Data.java
@@ -10,9 +10,6 @@ import lombok.Setter;
import java.util.Map;
-/**
- * Definiert das Schema und die Signatur(-art), die für die Fachdaten verwendet werden.
- */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"signature",
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/EidasAdesProfile.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/EidasAdesProfile.java
index 339f9b7ac..fc8843b28 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/EidasAdesProfile.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/EidasAdesProfile.java
@@ -6,11 +6,6 @@ import com.fasterxml.jackson.annotation.JsonValue;
import java.util.HashMap;
import java.util.Map;
-/**
- * Referenziert ein eindeutiges Profil einer AdES (advanced electronic signature/seal) gemäß eIDAS-Verordnung über eine URI gemäß [ETSI TS 119 192](https://www.etsi.org/deliver/etsi_ts/119100_119199/119192/01.01.01_60/ts_119192v010101p.pdf).
- * <p>
- * Für die Details zur Verwendung und Validierung von Profilen siehe auch https://ec.europa.eu/cefdigital/DSS/webapp-demo/doc/dss-documentation.html#_signatures_profile_simplification
- */
public enum EidasAdesProfile {
HTTP_URI_ETSI_ORG_ADES_191_X_2_LEVEL_BASELINE_B_B("http://uri.etsi.org/ades/191x2/level/baseline/B-B#"),
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Hash.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Hash.java
index 03d99b982..94475c308 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Hash.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Hash.java
@@ -9,12 +9,6 @@ import lombok.Setter;
import java.util.Map;
-
-/**
- * Hashwert
- * <p>
- * Der Hashwert der unverschlüsselten Fachdaten. Die Angabe des Hashwertes dient der Integritätssicherung des Gesamtantrags und schützt vor einem Austausch der Fachdaten durch Systeme zwischen Sender und Subscriber (z.B. dem Zustelldienst).
- */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"type",
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/MimeType.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/MimeType.java
index b07f19a11..cf210d483 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/MimeType.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/MimeType.java
@@ -6,9 +6,6 @@ import com.fasterxml.jackson.annotation.JsonValue;
import java.util.HashMap;
import java.util.Map;
-/**
- * Mimetype (z.B. application/json oder application/xml) des referenzierten Schemas (z.B. XSD- oder JSON-Schema).
- */
public enum MimeType {
APPLICATION_JSON("application/json"),
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Signature.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Signature.java
index 4ccfab279..dba35defd 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Signature.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Signature.java
@@ -9,9 +9,6 @@ import lombok.Setter;
import java.util.Map;
-/**
- * Beschreibt das Signaturformt und Profile
- */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"signatureFormat",
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/SignatureFormat.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/SignatureFormat.java
index 47701c30e..e1676eb7b 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/SignatureFormat.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/SignatureFormat.java
@@ -6,9 +6,6 @@ import com.fasterxml.jackson.annotation.JsonValue;
import java.util.HashMap;
import java.util.Map;
-/**
- * Beschreibt, welches Signaturformat die genutzte Signatur / das genutzte Siegel nutzt. Aktuell wird die Hinterlegung folgender Signaturformate unterstützt: CMS = Cryptographic Message Syntax, Asic = Associated Signature Containers, PDF = PDF Signatur, XML = XML-Signature, JSON = JSON Web Signature.
- */
public enum SignatureFormat {
CMS("cms"),
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/SubmissionSchema.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/SubmissionSchema.java
index fada00695..4d3b62bcd 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/SubmissionSchema.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/SubmissionSchema.java
@@ -10,12 +10,6 @@ import lombok.Setter;
import java.net.URI;
import java.util.Map;
-
-/**
- * Fachdatenschema
- * <p>
- * Referenz auf ein Schema, das die Struktur der Fachdaten einer Einreichung beschreibt.
- */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"schemaUri",
diff --git a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Type.java b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Type.java
index e6b1d5688..060804d68 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Type.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/domain/model/metadata/data/Type.java
@@ -6,9 +6,6 @@ import com.fasterxml.jackson.annotation.JsonValue;
import java.util.HashMap;
import java.util.Map;
-/**
- * Der verwendete Hash-Algorithmus. Derzeit ist nur `sha512` erlaubt.
- */
public enum Type {
SHA_512("sha512");
diff --git a/client/README.md b/client/README.md
index b243904dc..360a90d89 100644
--- a/client/README.md
+++ b/client/README.md
@@ -3,17 +3,17 @@
### API Flow
The SdkClientFactory provides fluent API client both for **Sender** and **Subscriber**.
-As the flow chart belwo shows, the fluent client ntercae guide you through all essentials calls
-in order to hand in a **Submission**.
+As the flow chart below shows, the fluent client guides through all essentials calls
+in order to hand in a correct **Submission**.
#### Api client flow for sending a submission
```mermaid
flowchart LR
-A[retrieveOAuthToken] --> B(Upload)
-B -->|uploadAttachment| C[Result 1]
-B -->|uploadData| D[Result 2]
+A[retrieveOAuthToken] --> B(Upload Attachements)
+B -->|encrypt Attachments| C[Create Submission]
+B -->|upload Attachments| C[Result 2]
```
#### Api client flow for subscribing to a submission
diff --git a/client/src/main/java/de/fitko/fitconnect/cmd/CommandLineRunner.java b/client/src/main/java/de/fitko/fitconnect/cmd/CommandLineRunner.java
index 9145ff801..fae9f0351 100644
--- a/client/src/main/java/de/fitko/fitconnect/cmd/CommandLineRunner.java
+++ b/client/src/main/java/de/fitko/fitconnect/cmd/CommandLineRunner.java
@@ -3,6 +3,8 @@ package de.fitko.fitconnect.cmd;
import com.beust.jcommander.JCommander;
import de.fitko.fitconnect.client.SenderClient;
+import java.util.Optional;
+
public class CommandLineRunner {
public static void main(String[] args) {
--
GitLab