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

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.identities.RawUid;
+import com.uid2.operator.util.PrivacyBits;
+import com.uid2.shared.model.TokenVersion;
+
+// class containing enough information to create a new uid token (aka advertising token)
+public class AdvertisingTokenRequest extends VersionedTokenRequest {
+    public final OperatorIdentity operatorIdentity;
+    public final SourcePublisher sourcePublisher;
+    public final RawUid rawUid;
+    public final PrivacyBits privacyBits;
+    public final Instant establishedAt;
+
+    public AdvertisingTokenRequest(TokenVersion version, Instant createdAt, Instant expiresAt, OperatorIdentity operatorIdentity,
+                                   SourcePublisher sourcePublisher, RawUid rawUid, PrivacyBits privacyBits,
+                                   Instant establishedAt) {
+        super(version, createdAt, expiresAt);
+        this.operatorIdentity = operatorIdentity;
+        this.sourcePublisher = sourcePublisher;
+        this.rawUid = rawUid;
+        this.privacyBits = privacyBits;
+        this.establishedAt = establishedAt;
+    }
+}
+

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

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

src/main/java/com/uid2/operator/model/IdentityMapResponseItem.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 IdentityMapResponseItem {
+    public static final IdentityMapResponseItem OptoutIdentity = new IdentityMapResponseItem(new byte[33], "");
+    // The raw UID is also known as Advertising Id (historically)
+    public final byte[] rawUid;
+    public final String bucketId;
+
+    public IdentityMapResponseItem(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/SourcePublisher.java

@@ -0,0 +1,24 @@
+package com.uid2.operator.model;
+
+// The original publisher that requests to generate a UID token
+public class SourcePublisher {
+    public final int siteId;
+
+    // these 2 values are added into adverting/UID token and refresh token payload but
+    // are not really used for any real purposes currently so sometimes are set to 0
+    // see the constructor below
+    public final int clientKeyId;
+    public final long publisherId;
+
+    public SourcePublisher(int siteId, int clientKeyId, long publisherId) {
+        this.siteId = siteId;
+        this.clientKeyId = clientKeyId;
+        this.publisherId = publisherId;
+    }
+
+    public SourcePublisher(int siteId) {
+        this.siteId = siteId;
+        this.clientKeyId = 0;
+        this.publisherId = 0;
+    }
+}

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

@@ -0,0 +1,40 @@
+package com.uid2.operator.model;
+
+import com.uid2.operator.model.identities.HashedDii;
+import com.uid2.operator.util.PrivacyBits;
+
+import java.time.Instant;
+
+public final class TokenGenerateRequest {
+    public final SourcePublisher sourcePublisher;
+    public final HashedDii hashedDii;
+    public final OptoutCheckPolicy optoutCheckPolicy;
+
+    public final PrivacyBits privacyBits;
+    public final Instant establishedAt;
+
+    public TokenGenerateRequest(
+            SourcePublisher sourcePublisher,
+            HashedDii hashedDii,
+            OptoutCheckPolicy tokenGeneratePolicy,
+            PrivacyBits privacyBits,
+            Instant establishedAt) {
+        this.sourcePublisher = sourcePublisher;
+        this.hashedDii = hashedDii;
+        this.optoutCheckPolicy = tokenGeneratePolicy;
+        this.privacyBits = privacyBits;
+        this.establishedAt = establishedAt;
+    }
+
+    public TokenGenerateRequest(
+            SourcePublisher sourcePublisher,
+            HashedDii hashedDii,
+            OptoutCheckPolicy tokenGeneratePolicy) {
+        this(sourcePublisher, hashedDii, tokenGeneratePolicy, PrivacyBits.DEFAULT, Instant.now());
+
+    }
+
+    public boolean shouldCheckOptOut() {
+        return optoutCheckPolicy.equals(OptoutCheckPolicy.RespectOptOut);
+    }
+}