From 5e1a438a25e310910e9dfb89a44e0b1ea846bf6a Mon Sep 17 00:00:00 2001
From: Youn <yct@kereval.com>
Date: Thu, 3 Sep 2020 14:36:28 +0200
Subject: [PATCH] IUAINFRA-48 code review
---
.../app/accesstokenproviderapi/adapter/README.txt | 5 -----
.../accesstokenproviderapi/application/README.txt | 2 --
.../application/TokenGenerator.java | 5 +++--
.../application/TokenRequestException.java | 3 +++
.../exception/UnsupportedAlgorithmException.java | 4 +++-
.../exception/UnsupportedTokenTypeException.java | 3 +++
.../accesstokenproviderapi/business/README.txt | 2 --
.../app/accesstokenproviderapi/adapter/README.txt | 1 -
.../AudienceSecretRetrieverTestImpl.java | 3 +++
.../application/DummyAuthzServerSoapuiTest.java | 15 ++++++++++-----
.../accesstokenproviderapi/application/README.txt | 1 -
.../accesstokenproviderapi/business/README.txt | 1 -
.../src/test/resources/README.txt | 1 -
.../app/audienceretriever/adapter/README.txt | 5 -----
.../app/audienceretriever/application/README.txt | 2 --
.../app/audienceretriever/business/README.txt | 2 --
.../AudienceSecretRetrieverForSoapuiTest.java | 3 +++
.../app/audienceretriever/adapter/README.txt | 1 -
.../app/audienceretriever/application/README.txt | 1 -
.../app/audienceretriever/business/README.txt | 1 -
audience-retriever/src/test/resources/README.txt | 1 -
21 files changed, 28 insertions(+), 34 deletions(-)
delete mode 100644 access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/README.txt
delete mode 100644 access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/README.txt
delete mode 100644 access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/README.txt
delete mode 100644 access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/README.txt
delete mode 100644 access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/README.txt
delete mode 100644 access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/business/README.txt
delete mode 100644 access-token-provider-api/src/test/resources/README.txt
delete mode 100644 audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/adapter/README.txt
delete mode 100644 audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/application/README.txt
delete mode 100644 audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/business/README.txt
delete mode 100644 audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/adapter/README.txt
delete mode 100644 audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/application/README.txt
delete mode 100644 audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/business/README.txt
delete mode 100644 audience-retriever/src/test/resources/README.txt
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/README.txt b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/README.txt
deleted file mode 100644
index f9f3a06..0000000
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/README.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-Put here classes from adapter layer :
-Data transformers, adapters, presenters or DAO. Abstraction of external libraries for
-application or business use.
-Web-services point, sockets, database connection and pool, GUI, file system, framework,
-external libraries.
\ No newline at end of file
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/README.txt b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/README.txt
deleted file mode 100644
index 13b8d86..0000000
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/README.txt
+++ /dev/null
@@ -1,2 +0,0 @@
-Put here classes from application layer :
-Use cases. Business elements applied in an application context or scenario.
\ No newline at end of file
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/TokenGenerator.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/TokenGenerator.java
index 6889020..de715c8 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/TokenGenerator.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/TokenGenerator.java
@@ -15,13 +15,15 @@ import net.ihe.gazelle.sb.jwtstandardblock.business.jwt.JSONWebSignature;
import net.ihe.gazelle.sb.jwtstandardblock.business.jwt.JSONWebToken;
import net.ihe.gazelle.sb.jwtstandardblock.business.jwt.JSONWebTokenClaimSet;
-import javax.inject.Inject;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.UUID;
+/**
+ * Class to generate the token
+ */
public class TokenGenerator {
private static final String ALGORITHM = "HS256";
@@ -31,7 +33,6 @@ public class TokenGenerator {
private AudienceSecretRetriever audienceSecretRetriever;
- @Inject
public void setAudienceSecretRetriever(AudienceSecretRetriever audienceSecretRetriever) {
this.audienceSecretRetriever = audienceSecretRetriever;
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/TokenRequestException.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/TokenRequestException.java
index 31af84d..a22ea5c 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/TokenRequestException.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/TokenRequestException.java
@@ -1,5 +1,8 @@
package net.ihe.gazelle.app.accesstokenproviderapi.application;
+/**
+ * Class to manage token request exception
+ */
public class TokenRequestException extends Exception {
/**
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/exception/UnsupportedAlgorithmException.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/exception/UnsupportedAlgorithmException.java
index 2ac7835..078073b 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/exception/UnsupportedAlgorithmException.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/exception/UnsupportedAlgorithmException.java
@@ -1,7 +1,9 @@
package net.ihe.gazelle.app.accesstokenproviderapi.application.exception;
+/**
+ * Class to manage unsupported algorithm exception
+ */
public class UnsupportedAlgorithmException extends Exception {
-
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/exception/UnsupportedTokenTypeException.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/exception/UnsupportedTokenTypeException.java
index 41d342f..829eb6d 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/exception/UnsupportedTokenTypeException.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/application/exception/UnsupportedTokenTypeException.java
@@ -1,4 +1,7 @@
package net.ihe.gazelle.app.accesstokenproviderapi.application.exception;
+/**
+ * Class to manage unsupported token exception
+ */
public class UnsupportedTokenTypeException extends Exception {
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/README.txt b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/README.txt
deleted file mode 100644
index 277b09a..0000000
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/README.txt
+++ /dev/null
@@ -1,2 +0,0 @@
-Put here classes from business layer :
-Business model, rules and constraints. Always true. Independent from the application.
\ No newline at end of file
diff --git a/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/README.txt b/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/README.txt
deleted file mode 100644
index ddaf15e..0000000
--- a/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-Put here test classes for adapter layer.
\ No newline at end of file
diff --git a/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/AudienceSecretRetrieverTestImpl.java b/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/AudienceSecretRetrieverTestImpl.java
index 766019c..30d64ac 100644
--- a/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/AudienceSecretRetrieverTestImpl.java
+++ b/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/AudienceSecretRetrieverTestImpl.java
@@ -5,6 +5,9 @@ import net.ihe.gazelle.app.audienceretriever.application.AudienceSecretRetriever
import java.util.HashMap;
import java.util.Map;
+/**
+ * Class to test the retriever of the audience secret
+ */
public class AudienceSecretRetrieverTestImpl implements AudienceSecretRetriever {
private Map<String, String> registry = new HashMap<>();
diff --git a/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/DummyAuthzServerSoapuiTest.java b/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/DummyAuthzServerSoapuiTest.java
index d580ad3..1fb14a9 100644
--- a/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/DummyAuthzServerSoapuiTest.java
+++ b/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/DummyAuthzServerSoapuiTest.java
@@ -1,8 +1,13 @@
package net.ihe.gazelle.app.accesstokenproviderapi.application;
import org.junit.jupiter.api.Test;
-import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+/**
+ * Class to test the soapui authorization server
+ */
class DummyAuthzServerSoapuiTest {
private static final String SUBJECT = "aamrein";
@@ -13,11 +18,11 @@ class DummyAuthzServerSoapuiTest {
*/
@Test
public void getAccessTokenWithPathAudienceTest() {
- DummyAuthzServerSoapui dummyAuthzServer = new DummyAuthzServerSoapui("src/test/resources/audience.properties");
+ DummyAuthzServerSoapui dummyAuthzServer = new DummyAuthzServerSoapui();
dummyAuthzServer.setAudienceSecretRetriever((String audience) -> "myBeautifulKeyWhichIsAJWTSecretSoSecret");
- assertNotNull(dummyAuthzServer.getAccessToken(SUBJECT, AUDIENCE, null, null));
+ assertNotNull(dummyAuthzServer.getAccessToken(SUBJECT, AUDIENCE, null, null), "check that the access token is not null");
}
/**
@@ -28,7 +33,7 @@ class DummyAuthzServerSoapuiTest {
DummyAuthzServerSoapui dummyAuthzServer = new DummyAuthzServerSoapui();
dummyAuthzServer.setAudienceSecretRetriever((String audience) -> "myBeautifulKeyWhichIsAJWTSecretSoSecret");
- assertNotNull(dummyAuthzServer.getAccessToken(SUBJECT, AUDIENCE, null, null));
+ assertNotNull(dummyAuthzServer.getAccessToken(SUBJECT, AUDIENCE, null, null), "check that the access token is not null");
}
/**
@@ -37,6 +42,6 @@ class DummyAuthzServerSoapuiTest {
@Test
public void getAccessTokenWithBadPathAudienceTest() {
DummyAuthzServerSoapui dummyAuthzServer = new DummyAuthzServerSoapui("test.properties");
- assertNull(dummyAuthzServer.getAccessToken(SUBJECT, AUDIENCE, null, null));
+ assertNull(dummyAuthzServer.getAccessToken(SUBJECT, AUDIENCE, null, null), "check that the access token is null");
}
}
diff --git a/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/README.txt b/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/README.txt
deleted file mode 100644
index fe1a7ed..0000000
--- a/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/application/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-Put here test classes for application layer.
\ No newline at end of file
diff --git a/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/business/README.txt b/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/business/README.txt
deleted file mode 100644
index 9ab90c5..0000000
--- a/access-token-provider-api/src/test/java/net/ihe/gazelle/app/accesstokenproviderapi/business/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-Put here test classes for business layer.
\ No newline at end of file
diff --git a/access-token-provider-api/src/test/resources/README.txt b/access-token-provider-api/src/test/resources/README.txt
deleted file mode 100644
index c6f818d..0000000
--- a/access-token-provider-api/src/test/resources/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-Put here your test resources.
\ No newline at end of file
diff --git a/audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/adapter/README.txt b/audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/adapter/README.txt
deleted file mode 100644
index f9f3a06..0000000
--- a/audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/adapter/README.txt
+++ /dev/null
@@ -1,5 +0,0 @@
-Put here classes from adapter layer :
-Data transformers, adapters, presenters or DAO. Abstraction of external libraries for
-application or business use.
-Web-services point, sockets, database connection and pool, GUI, file system, framework,
-external libraries.
\ No newline at end of file
diff --git a/audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/application/README.txt b/audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/application/README.txt
deleted file mode 100644
index 13b8d86..0000000
--- a/audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/application/README.txt
+++ /dev/null
@@ -1,2 +0,0 @@
-Put here classes from application layer :
-Use cases. Business elements applied in an application context or scenario.
\ No newline at end of file
diff --git a/audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/business/README.txt b/audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/business/README.txt
deleted file mode 100644
index 277b09a..0000000
--- a/audience-retriever/src/main/java/net/ihe/gazelle/app/audienceretriever/business/README.txt
+++ /dev/null
@@ -1,2 +0,0 @@
-Put here classes from business layer :
-Business model, rules and constraints. Always true. Independent from the application.
\ No newline at end of file
diff --git a/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/adapter/AudienceSecretRetrieverForSoapuiTest.java b/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/adapter/AudienceSecretRetrieverForSoapuiTest.java
index c78f92d..1bd78af 100644
--- a/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/adapter/AudienceSecretRetrieverForSoapuiTest.java
+++ b/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/adapter/AudienceSecretRetrieverForSoapuiTest.java
@@ -5,6 +5,9 @@ import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertNull;
+/**
+ * Class to test the retrieve of the audience secret
+ */
class AudienceSecretRetrieverForSoapuiTest {
@Test
diff --git a/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/adapter/README.txt b/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/adapter/README.txt
deleted file mode 100644
index ddaf15e..0000000
--- a/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/adapter/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-Put here test classes for adapter layer.
\ No newline at end of file
diff --git a/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/application/README.txt b/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/application/README.txt
deleted file mode 100644
index fe1a7ed..0000000
--- a/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/application/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-Put here test classes for application layer.
\ No newline at end of file
diff --git a/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/business/README.txt b/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/business/README.txt
deleted file mode 100644
index 9ab90c5..0000000
--- a/audience-retriever/src/test/java/net/ihe/gazelle/app/audienceretriever/business/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-Put here test classes for business layer.
\ No newline at end of file
diff --git a/audience-retriever/src/test/resources/README.txt b/audience-retriever/src/test/resources/README.txt
deleted file mode 100644
index c6f818d..0000000
--- a/audience-retriever/src/test/resources/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-Put here your test resources.
\ No newline at end of file
--
GitLab