Final Refactoring - Syw UID2-4158 token gen code refactoring user identity

src/main/java/com/uid2/operator/IdentityConst.java

@@ -3,18 +3,22 @@
 import com.uid2.operator.service.EncodingUtils;
 
 public class IdentityConst {
-
+    // DIIs for generating optout tokens for legacy participants - to be deprecated
     public static final String OptOutTokenIdentityForEmail = "[email protected]";
     public static final String OptOutTokenIdentityForPhone = "+00000000001";
+
+    // DIIs for testing with token/validate endpoint, see https://unifiedid.com/docs/endpoints/post-token-validate
     public static final String ValidateIdentityForEmail = "[email protected]";
     public static final String ValidateIdentityForPhone = "+12345678901";
     public static final byte[] ValidateIdentityForEmailHash = EncodingUtils.getSha256Bytes(IdentityConst.ValidateIdentityForEmail);
     public static final byte[] ValidateIdentityForPhoneHash = EncodingUtils.getSha256Bytes(IdentityConst.ValidateIdentityForPhone);
+
+    // DIIs to use when you want to generate a optout response in token generation or identity map
     public static final String OptOutIdentityForEmail = "[email protected]";
     public static final String OptOutIdentityForPhone = "+00000000000";
+
+    // DIIs to use when you want to generate a UID token but when doing refresh token, you want to always get an optout response
+    // to test the optout handling workflow
     public static final String RefreshOptOutIdentityForEmail = "[email protected]";
     public static final String RefreshOptOutIdentityForPhone = "+00000000002";
-
-
-
 }

src/main/java/com/uid2/operator/model/AdvertisingTokenRequest.java

@@ -0,0 +1,28 @@
+package com.uid2.operator.model;
+
+import java.time.Instant;
+
+import com.uid2.operator.model.userIdentity.RawUidIdentity;
+import com.uid2.operator.util.PrivacyBits;
+import com.uid2.shared.model.TokenVersion;
+
+// class containing enough data to create a new uid or advertising token
+public class AdvertisingTokenRequest extends VersionedToken {
+    public final OperatorIdentity operatorIdentity;
+    public final SourcePublisher sourcePublisher;
+    public final RawUidIdentity rawUidIdentity;
+    public final PrivacyBits privacyBits;
+    public final Instant establishedAt;
+
+    public AdvertisingTokenRequest(TokenVersion version, Instant createdAt, Instant expiresAt, OperatorIdentity operatorIdentity,
+                                   SourcePublisher sourcePublisher, RawUidIdentity rawUidIdentity, PrivacyBits privacyBits,
+                                   Instant establishedAt) {
+        super(version, createdAt, expiresAt);
+        this.operatorIdentity = operatorIdentity;
+        this.sourcePublisher = sourcePublisher;
+        this.rawUidIdentity = rawUidIdentity;
+        this.privacyBits = privacyBits;
+        this.establishedAt = establishedAt;
+    }
+}
+

src/main/java/com/uid2/operator/model/IdentityRequest.java

@@ -1,18 +1,37 @@
 package com.uid2.operator.model;
 
+import com.uid2.operator.model.userIdentity.HashedDiiIdentity;
+import com.uid2.operator.util.PrivacyBits;
+
+import java.time.Instant;
+
 public final class IdentityRequest {
-    public final PublisherIdentity publisherIdentity;
-    public final UserIdentity userIdentity;
+    public final SourcePublisher sourcePublisher;
+    public final HashedDiiIdentity hashedDiiIdentity;
     public final OptoutCheckPolicy optoutCheckPolicy;
 
+    public final PrivacyBits privacyBits;
+    public final Instant establishedAt;
+
     public IdentityRequest(
-            PublisherIdentity publisherIdentity,
-            UserIdentity userIdentity,
-            OptoutCheckPolicy tokenGeneratePolicy)
-    {
-        this.publisherIdentity = publisherIdentity;
-        this.userIdentity = userIdentity;
+            SourcePublisher sourcePublisher,
+            HashedDiiIdentity hashedDiiIdentity,
+            OptoutCheckPolicy tokenGeneratePolicy,
+            PrivacyBits privacyBits,
+            Instant establishedAt) {
+        this.sourcePublisher = sourcePublisher;
+        this.hashedDiiIdentity = hashedDiiIdentity;
         this.optoutCheckPolicy = tokenGeneratePolicy;
+        this.privacyBits = privacyBits;
+        this.establishedAt = establishedAt;
+    }
+
+    public IdentityRequest(
+            SourcePublisher sourcePublisher,
+            HashedDiiIdentity hashedDiiIdentity,
+            OptoutCheckPolicy tokenGeneratePolicy) {
+        this(sourcePublisher, hashedDiiIdentity, tokenGeneratePolicy, PrivacyBits.DEFAULT, Instant.now());
+
     }
 
     public boolean shouldCheckOptOut() {

src/main/java/com/uid2/operator/model/IdentityResponse.java

@@ -0,0 +1,81 @@
+package com.uid2.operator.model;
+
+import com.uid2.shared.model.TokenVersion;
+import io.vertx.core.json.JsonObject;
+
+import java.time.Instant;
+
+// this defines all the fields for the response of the /token/generate and /client/generate endpoints before they are
+// jsonified
+// todo: can be converted to record later
+public class IdentityResponse {
+    public static IdentityResponse OptOutIdentityResponse = new IdentityResponse("", null, "", Instant.EPOCH, Instant.EPOCH, Instant.EPOCH);
+
+    //aka UID token
+    private final String advertisingToken;
+    private final TokenVersion advertisingTokenVersion;
+    private final String refreshToken;
+    // when the advertising token/uid token expires
+    private final Instant identityExpires;
+    private final Instant refreshExpires;
+    private final Instant refreshFrom;
+
+    public IdentityResponse(String advertisingToken, TokenVersion advertisingTokenVersion, String refreshToken,
+                            Instant identityExpires, Instant refreshExpires, Instant refreshFrom) {
+        this.advertisingToken = advertisingToken;
+        this.advertisingTokenVersion = advertisingTokenVersion;
+        this.refreshToken = refreshToken;
+        this.identityExpires = identityExpires;
+        this.refreshExpires = refreshExpires;
+        this.refreshFrom = refreshFrom;
+    }
+
+    public String getAdvertisingToken() {
+        return advertisingToken;
+    }
+
+    public TokenVersion getAdvertisingTokenVersion() {
+        return advertisingTokenVersion;
+    }
+
+    public String getRefreshToken() {
+        return refreshToken;
+    }
+
+    public Instant getIdentityExpires() {
+        return identityExpires;
+    }
+
+    public Instant getRefreshExpires() {
+        return refreshExpires;
+    }
+
+    public Instant getRefreshFrom() {
+        return refreshFrom;
+    }
+
+    public boolean isOptedOut() {
+        return advertisingToken == null || advertisingToken.isEmpty();
+    }
+
+    // for v1/v2 token/generate and token/refresh and client/generate (CSTG) endpoints
+    public JsonObject toJsonV1() {
+        final JsonObject json = new JsonObject();
+        json.put("advertising_token", getAdvertisingToken());
+        json.put("refresh_token", getRefreshToken());
+        json.put("identity_expires", getIdentityExpires().toEpochMilli());
+        json.put("refresh_expires", getRefreshExpires().toEpochMilli());
+        json.put("refresh_from", getRefreshFrom().toEpochMilli());
+        return json;
+    }
+
+    // for the original/legacy token/generate and token/refresh endpoint
+    public JsonObject toJsonV0() {
+        final JsonObject json = new JsonObject();
+        json.put("advertisement_token", getAdvertisingToken());
+        json.put("advertising_token", getAdvertisingToken());
+        json.put("refresh_token", getRefreshToken());
+
+        return json;
+    }
+}

src/main/java/com/uid2/operator/model/MapRequest.java

@@ -1,18 +1,19 @@
 package com.uid2.operator.model;
 
+import com.uid2.operator.model.userIdentity.HashedDiiIdentity;
+
 import java.time.Instant;
 
 public final class MapRequest {
-    public final UserIdentity userIdentity;
+    public final HashedDiiIdentity hashedDiiIdentity;
     public final OptoutCheckPolicy optoutCheckPolicy;
     public final Instant asOf;
 
     public MapRequest(
-            UserIdentity userIdentity,
+            HashedDiiIdentity hashedDiiIdentity,
             OptoutCheckPolicy optoutCheckPolicy,
-            Instant asOf)
-    {
-        this.userIdentity = userIdentity;
+            Instant asOf) {
+        this.hashedDiiIdentity = hashedDiiIdentity;
         this.optoutCheckPolicy = optoutCheckPolicy;
         this.asOf = asOf;
     }

src/main/java/com/uid2/operator/model/RawUidResponse.java

@@ -0,0 +1,19 @@
+package com.uid2.operator.model;
+
+// Contains the computed raw UID and its bucket ID from identity/map request
+public class RawUidResponse {
+    public static final RawUidResponse OptoutIdentity = new RawUidResponse(new byte[33], "");
+    // The raw UID is also known as Advertising Id (historically)
+    public final byte[] rawUid;
+    public final String bucketId;
+
+    public RawUidResponse(byte[] rawUid, String bucketId) {
+        this.rawUid = rawUid;
+        this.bucketId = bucketId;
+    }
+
+    // historically Optout is known as Logout
+    public boolean isOptedOut() {
+        return this.equals(OptoutIdentity) || this.bucketId == null || this.bucketId.isEmpty();
+    }
+}

src/main/java/com/uid2/operator/model/RefreshResponse.java

@@ -4,37 +4,38 @@
 
 public class RefreshResponse {
 
-    public static RefreshResponse Invalid = new RefreshResponse(Status.Invalid, IdentityTokens.LogoutToken);
-    public static RefreshResponse Optout = new RefreshResponse(Status.Optout, IdentityTokens.LogoutToken);
-    public static RefreshResponse Expired = new RefreshResponse(Status.Expired, IdentityTokens.LogoutToken);
-    public static RefreshResponse Deprecated = new RefreshResponse(Status.Deprecated, IdentityTokens.LogoutToken);
-    public static RefreshResponse NoActiveKey = new RefreshResponse(Status.NoActiveKey, IdentityTokens.LogoutToken);
+    public static final RefreshResponse Invalid = new RefreshResponse(Status.Invalid,
+            IdentityResponse.OptOutIdentityResponse);
+    public static final RefreshResponse Optout = new RefreshResponse(Status.Optout, IdentityResponse.OptOutIdentityResponse);
+    public static final RefreshResponse Expired = new RefreshResponse(Status.Expired, IdentityResponse.OptOutIdentityResponse);
+    public static final RefreshResponse Deprecated = new RefreshResponse(Status.Deprecated, IdentityResponse.OptOutIdentityResponse);
+    public static final RefreshResponse NoActiveKey = new RefreshResponse(Status.NoActiveKey, IdentityResponse.OptOutIdentityResponse);
     private final Status status;
-    private final IdentityTokens tokens;
+    private final IdentityResponse identityResponse;
     private final Duration durationSinceLastRefresh;
     private final boolean isCstg;
 
-    private RefreshResponse(Status status, IdentityTokens tokens, Duration durationSinceLastRefresh, boolean isCstg) {
+    private RefreshResponse(Status status, IdentityResponse identityResponse, Duration durationSinceLastRefresh, boolean isCstg) {
         this.status = status;
-        this.tokens = tokens;
+        this.identityResponse = identityResponse;
         this.durationSinceLastRefresh = durationSinceLastRefresh;
         this.isCstg = isCstg;
     }
 
-    private RefreshResponse(Status status, IdentityTokens tokens) {
-        this(status, tokens, null, false);
+    private RefreshResponse(Status status, IdentityResponse identityResponse) {
+        this(status, identityResponse, null, false);
     }
 
-    public static RefreshResponse createRefreshedResponse(IdentityTokens tokens, Duration durationSinceLastRefresh, boolean isCstg) {
-        return new RefreshResponse(Status.Refreshed, tokens, durationSinceLastRefresh, isCstg);
+    public static RefreshResponse createRefreshedResponse(IdentityResponse identityResponse, Duration durationSinceLastRefresh, boolean isCstg) {
+        return new RefreshResponse(Status.Refreshed, identityResponse, durationSinceLastRefresh, isCstg);
     }
 
     public Status getStatus() {
         return status;
     }
 
-    public IdentityTokens getTokens() {
-        return tokens;
+    public IdentityResponse getIdentityResponse() {
+        return identityResponse;
     }
 
     public Duration getDurationSinceLastRefresh() {