From 66247ee1e3627b09070471ea042cea9fedabeacf Mon Sep 17 00:00:00 2001
From: Malo <mtc@kereval.com>
Date: Wed, 26 Aug 2020 11:10:19 +0200
Subject: [PATCH] add javadoc
---
.../adapter/webservice/AudienceRegistry.java | 8 ++++++++
.../adapter/webservice/DummyAuthzServer.java | 11 +++++++++++
.../adapter/webservice/TestUserRegistry.java | 7 +++++++
.../adapter/webservice/TokenGenerator.java | 8 ++++++++
.../business/AccessTokenExtension.java | 9 +++++++++
.../business/AccessTokenRequest.java | 9 +++++++++
.../business/AsymmetricSignature.java | 9 +++++++++
.../accesstokenproviderapi/business/CodedValue.java | 3 +++
.../accesstokenproviderapi/business/Credential.java | 3 +++
.../accesstokenproviderapi/business/Password.java | 9 +++++++++
.../accesstokenproviderapi/business/PublicKey.java | 9 +++++++++
.../accesstokenproviderapi/business/Signature.java | 10 ++++++++++
.../business/SymmetricSignature.java | 9 +++++++++
.../business/testuser/TestUser.java | 12 ++++++++++++
14 files changed, 116 insertions(+)
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/AudienceRegistry.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/AudienceRegistry.java
index 05a70e6..0c41aa0 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/AudienceRegistry.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/AudienceRegistry.java
@@ -2,8 +2,16 @@ package net.ihe.gazelle.app.accesstokenproviderapi.adapter.webservice;
import net.ihe.gazelle.app.accesstokenproviderapi.business.Credential;
+/**
+ * Interface to interact with the audience registry where is store all known audience with their credential
+ */
public interface AudienceRegistry {
+ /**
+ * Get credential's audience
+ * @param audienceId
+ * @return credential
+ */
Credential getAudienceCredentials(String audienceId);
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/DummyAuthzServer.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/DummyAuthzServer.java
index e457811..27f6de6 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/DummyAuthzServer.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/DummyAuthzServer.java
@@ -1,7 +1,18 @@
package net.ihe.gazelle.app.accesstokenproviderapi.adapter.webservice;
+/**
+ * For SoapUI integration need, a simplified Authorization Server (or IDP) is required.
+ */
public interface DummyAuthzServer {
+ /**
+ * get a dummy access token
+ * @param userId
+ * @param audienceId
+ * @param purposeOfUser
+ * @param resourceId
+ * @return an access token
+ */
byte[] getAccessToken(String userId, String audienceId, String purposeOfUser, String resourceId);
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/TestUserRegistry.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/TestUserRegistry.java
index 94e0de2..3477a88 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/TestUserRegistry.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/TestUserRegistry.java
@@ -2,8 +2,15 @@ package net.ihe.gazelle.app.accesstokenproviderapi.adapter.webservice;
import net.ihe.gazelle.app.accesstokenproviderapi.business.testuser.TestUser;
+/**
+ * Interface to interact with the test-users’ database for authentication step and token content
+ */
public interface TestUserRegistry {
+ /**
+ * @param userId
+ * @return TestUser
+ */
TestUser getTestUser(String userId);
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/TokenGenerator.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/TokenGenerator.java
index d597ea6..0be087f 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/TokenGenerator.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/adapter/webservice/TokenGenerator.java
@@ -3,8 +3,16 @@ package net.ihe.gazelle.app.accesstokenproviderapi.adapter.webservice;
import net.ihe.gazelle.app.accesstokenproviderapi.business.AccessTokenRequest;
import net.ihe.gazelle.sb.iua.business.EncodedIUAToken;
+/**
+ * Interface to interact with the access token generator
+ */
public interface TokenGenerator {
+ /**
+ * generate an access token from an access token request
+ * @param accessTokenRequest
+ * @return EncodedIUAToken
+ */
EncodedIUAToken generateAccessToken(AccessTokenRequest accessTokenRequest);
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AccessTokenExtension.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AccessTokenExtension.java
index f38b23d..cd92b50 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AccessTokenExtension.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AccessTokenExtension.java
@@ -3,6 +3,9 @@ package net.ihe.gazelle.app.accesstokenproviderapi.business;
import java.util.ArrayList;
import java.util.List;
+/**
+ * Extensions for the Access Token
+ */
public class AccessTokenExtension {
private String subjectId;
@@ -208,6 +211,9 @@ public class AccessTokenExtension {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
@@ -231,6 +237,9 @@ public class AccessTokenExtension {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public int hashCode() {
int result = subjectId != null ? subjectId.hashCode() : 0;
result = 31 * result + (subjectOrganizations != null ? subjectOrganizations.hashCode() : 0);
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AccessTokenRequest.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AccessTokenRequest.java
index 596a1ac..d1dfad1 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AccessTokenRequest.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AccessTokenRequest.java
@@ -4,6 +4,9 @@ import net.ihe.gazelle.sb.iua.business.TokenType;
import java.time.Duration;
+/**
+ * The Access Token request
+ */
public class AccessTokenRequest {
private String issuer;
@@ -107,6 +110,9 @@ public class AccessTokenRequest {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
@@ -123,6 +129,9 @@ public class AccessTokenRequest {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public int hashCode() {
int result = issuer.hashCode();
result = 31 * result + subject.hashCode();
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AsymmetricSignature.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AsymmetricSignature.java
index 616fa0a..d3f3020 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AsymmetricSignature.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/AsymmetricSignature.java
@@ -2,6 +2,9 @@ package net.ihe.gazelle.app.accesstokenproviderapi.business;
import java.util.Arrays;
+/**
+ * Asymmetric signature information of the access token
+ */
public class AsymmetricSignature extends Signature {
private byte[] privateKey;
@@ -33,6 +36,9 @@ public class AsymmetricSignature extends Signature {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
@@ -45,6 +51,9 @@ public class AsymmetricSignature extends Signature {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public int hashCode() {
int result = Arrays.hashCode(privateKey);
result = 31 * result + privateKeyPassword.hashCode();
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/CodedValue.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/CodedValue.java
index fa429f6..ebd7e36 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/CodedValue.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/CodedValue.java
@@ -1,5 +1,8 @@
package net.ihe.gazelle.app.accesstokenproviderapi.business;
+/**
+ * A Coded value
+ */
public class CodedValue {
private String code;
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Credential.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Credential.java
index 7014be5..cb7789c 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Credential.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Credential.java
@@ -1,4 +1,7 @@
package net.ihe.gazelle.app.accesstokenproviderapi.business;
+/**
+ * Credential for an audience
+ */
public abstract class Credential {
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Password.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Password.java
index 4265f78..7123a18 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Password.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Password.java
@@ -2,6 +2,9 @@ package net.ihe.gazelle.app.accesstokenproviderapi.business;
import java.util.Arrays;
+/**
+ * A password
+ */
public class Password extends Credential {
private byte[] value;
@@ -22,6 +25,9 @@ public class Password extends Credential {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
@@ -32,6 +38,9 @@ public class Password extends Credential {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public int hashCode() {
return Arrays.hashCode(value);
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/PublicKey.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/PublicKey.java
index c39edfd..2803b5b 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/PublicKey.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/PublicKey.java
@@ -2,6 +2,9 @@ package net.ihe.gazelle.app.accesstokenproviderapi.business;
import java.util.Arrays;
+/**
+ * A public key
+ */
public class PublicKey extends Credential {
private byte[] key;
@@ -21,6 +24,9 @@ public class PublicKey extends Credential {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
@@ -31,6 +37,9 @@ public class PublicKey extends Credential {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public int hashCode() {
return Arrays.hashCode(key);
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Signature.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Signature.java
index 50515e6..ec065fc 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Signature.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/Signature.java
@@ -1,5 +1,9 @@
package net.ihe.gazelle.app.accesstokenproviderapi.business;
+
+/**
+ * Signature information of the access token
+ */
public abstract class Signature {
private String algorithm;
@@ -20,6 +24,9 @@ public abstract class Signature {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
@@ -30,6 +37,9 @@ public abstract class Signature {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public int hashCode() {
return algorithm.hashCode();
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/SymmetricSignature.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/SymmetricSignature.java
index 7e8c811..31628ba 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/SymmetricSignature.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/SymmetricSignature.java
@@ -1,5 +1,8 @@
package net.ihe.gazelle.app.accesstokenproviderapi.business;
+/**
+ * Symmetric signature information of the access token
+ */
public class SymmetricSignature extends Signature {
private String secret;
@@ -21,6 +24,9 @@ public class SymmetricSignature extends Signature {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
@@ -32,6 +38,9 @@ public class SymmetricSignature extends Signature {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public int hashCode() {
return secret.hashCode();
}
diff --git a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/testuser/TestUser.java b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/testuser/TestUser.java
index 9b5d454..321d4ea 100644
--- a/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/testuser/TestUser.java
+++ b/access-token-provider-api/src/main/java/net/ihe/gazelle/app/accesstokenproviderapi/business/testuser/TestUser.java
@@ -6,6 +6,9 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
+/**
+ * Test user used for authentication and token content
+ */
public class TestUser {
private String userId;
@@ -15,6 +18,9 @@ public class TestUser {
private String gender; //fixme String ?
private Map<String, String> extensions = new HashMap<>();
+ /**
+ * Constructor
+ */
public TestUser(String userId, List<String> givenNames, String lastName) {
this.userId = userId;
this.givenNames = givenNames;
@@ -105,6 +111,9 @@ public class TestUser {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
@@ -120,6 +129,9 @@ public class TestUser {
}
@Override
+ /**
+ * {@inheritDoc}
+ */
public int hashCode() {
int result = userId.hashCode();
result = 31 * result + givenNames.hashCode();
--
GitLab