From afb6939da05a2efc6a8df0fb8f358f94b9440bb7 Mon Sep 17 00:00:00 2001
From: Martin Vogel <martin.vogel@sinc.de>
Date: Wed, 22 Jun 2022 18:33:29 +0200
Subject: [PATCH] #414 Refactor internal interfaces
---
.../api/services/auth/OAuthService.java | 7 +++----
.../api/services/crypto/CryptoService.java | 16 ++++++++--------
.../api/services/metadata/MetadataService.java | 4 ++--
.../services/validation/MetadataValidator.java | 4 ++--
4 files changed, 15 insertions(+), 16 deletions(-)
diff --git a/api/src/main/java/de/fitko/fitconnect/api/services/auth/OAuthService.java b/api/src/main/java/de/fitko/fitconnect/api/services/auth/OAuthService.java
index c6683988e..91629731c 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/services/auth/OAuthService.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/services/auth/OAuthService.java
@@ -1,15 +1,14 @@
package de.fitko.fitconnect.api.services.auth;
import de.fitko.fitconnect.api.domain.auth.OAuthToken;
-import de.fitko.fitconnect.api.domain.model.submission.SubmissionRequest;
-import de.fitko.fitconnect.api.exceptions.internal.AuthenticationException;
+import de.fitko.fitconnect.api.domain.model.submission.SubmissionSubmit;
+import de.fitko.fitconnect.api.exceptions.AuthenticationException;
/**
* A Service that provides an interface to authenticate against the Fit-Connect API in order
- * to send a {@link SubmissionRequest}.
+ * to send a {@link SubmissionSubmit}.
*
* @see <a href="https://docs.fitko.de/fit-connect/docs/getting-started/authentication">Fit-Connect documentation on authentication</a>
- *
*/
public interface OAuthService {
diff --git a/api/src/main/java/de/fitko/fitconnect/api/services/crypto/CryptoService.java b/api/src/main/java/de/fitko/fitconnect/api/services/crypto/CryptoService.java
index 9a493990b..93b97d280 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/services/crypto/CryptoService.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/services/crypto/CryptoService.java
@@ -3,12 +3,12 @@ package de.fitko.fitconnect.api.services.crypto;
import com.nimbusds.jose.jwk.RSAKey;
import de.fitko.fitconnect.api.domain.model.metadata.data.Data;
import de.fitko.fitconnect.api.domain.model.metadata.attachment.Attachment;
-import de.fitko.fitconnect.api.domain.model.submission.SubmissionRequest;
-import de.fitko.fitconnect.api.exceptions.internal.DecryptionException;
-import de.fitko.fitconnect.api.exceptions.internal.EncryptionException;
+import de.fitko.fitconnect.api.domain.model.submission.SubmissionSubmit;
+import de.fitko.fitconnect.api.exceptions.DecryptionException;
+import de.fitko.fitconnect.api.exceptions.EncryptionException;
/**
- * A service that allows to encrypt and decrypt {@link Data} and {@link Attachment}s of a {@link SubmissionRequest} via JWE.
+ * A service that allows to encrypt and decrypt {@link Data} and {@link Attachment}s of a {@link SubmissionSubmit} via JWE.
*
* @see <a href="https://datatracker.ietf.org/doc/html/rfc7516">JSON-Web-Encryption</a>
*/
@@ -17,7 +17,7 @@ public interface CryptoService {
/**
* Decrypts a JWE encrypted string with the given private key
*
- * @param privateKey RSA private key the encrypted JWE string is decrypted with
+ * @param privateKey RSA private key the encrypted JWE string is decrypted with
* @param encryptedData serialized encrypted JWE string that is decrypted
* @return a string serialization of the decrypted payload
* @throws DecryptionException if the payload cannot be decrypted or there was an issue with the key
@@ -27,7 +27,7 @@ public interface CryptoService {
/**
* Decrypts a JWE encrypted byte[] with the given private key
*
- * @param privateKey RSA private key the encrypted JWE string is decrypted with
+ * @param privateKey RSA private key the encrypted JWE string is decrypted with
* @param encryptedData serialized encrypted JWE string that is decrypted
* @return a byte[] of the decrypted string payload
* @throws DecryptionException if the payload cannot be decrypted or there was an issue with the key
@@ -38,7 +38,7 @@ public interface CryptoService {
* JWE encrypts a given string payload with the public key
*
* @param publicKey RSA public key the payload is encrypted with
- * @param data json or xml data that should be encrypted
+ * @param data json or xml data that should be encrypted
* @return a string serialization of the encrypted JWE object
* @throws EncryptionException if the payload cannot be encrypted or there was an issue with the key
*/
@@ -48,7 +48,7 @@ public interface CryptoService {
* JWE encrypts a given byte[] payload with the public key
*
* @param publicKey RSA public key the payload is encrypted with
- * @param bytes byte[] of the data that should be encrypted
+ * @param bytes byte[] of the data that should be encrypted
* @return a string serialization of the encrypted JWE object
* @throws EncryptionException if the payload cannot be encrypted or there was an issue with the key
*/
diff --git a/api/src/main/java/de/fitko/fitconnect/api/services/metadata/MetadataService.java b/api/src/main/java/de/fitko/fitconnect/api/services/metadata/MetadataService.java
index 2071fdcf4..b8cfc4fc7 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/services/metadata/MetadataService.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/services/metadata/MetadataService.java
@@ -3,12 +3,12 @@ package de.fitko.fitconnect.api.services.metadata;
import de.fitko.fitconnect.api.domain.model.metadata.Metadata;
import de.fitko.fitconnect.api.domain.model.metadata.attachment.Attachment;
import de.fitko.fitconnect.api.domain.model.metadata.data.Data;
-import de.fitko.fitconnect.api.domain.model.submission.SubmissionRequest;
+import de.fitko.fitconnect.api.domain.model.submission.SubmissionSubmit;
import java.util.List;
/**
- * Provides the generation of correct and valid {@link Metadata} for a {@link SubmissionRequest}
+ * Provides the generation of correct and valid {@link Metadata} for a {@link SubmissionSubmit}
*
* @see
* <a href="https://docs.fitko.de/fit-connect/docs/metadataoverview">Metadata</a> and
diff --git a/api/src/main/java/de/fitko/fitconnect/api/services/validation/MetadataValidator.java b/api/src/main/java/de/fitko/fitconnect/api/services/validation/MetadataValidator.java
index e788b3153..7f03d2ad8 100644
--- a/api/src/main/java/de/fitko/fitconnect/api/services/validation/MetadataValidator.java
+++ b/api/src/main/java/de/fitko/fitconnect/api/services/validation/MetadataValidator.java
@@ -3,11 +3,11 @@ package de.fitko.fitconnect.api.services.validation;
import de.fitko.fitconnect.api.domain.model.metadata.Metadata;
import de.fitko.fitconnect.api.domain.model.metadata.attachment.Attachment;
import de.fitko.fitconnect.api.domain.model.metadata.data.Data;
-import de.fitko.fitconnect.api.domain.model.submission.SubmissionRequest;
+import de.fitko.fitconnect.api.domain.model.submission.SubmissionSubmit;
import de.fitko.fitconnect.api.domain.validation.ValidationResult;
/**
- * A validator that ensure the integrity of the transferred {@link Metadata} of a {@link SubmissionRequest}.
+ * A validator that ensure the integrity of the transferred {@link Metadata} of a {@link SubmissionSubmit}.
* Both schema-validation and hash value validation is provided.
*
* @see <a href="https://docs.fitko.de/fit-connect/docs/sending/metadata#integrity">Metadata Integrity</a>
--
GitLab