SDK-2531: Update SessionSpec to use strongly typed object for Identity Profile requirements

Author: MrBurtyyy

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/create/SessionSpec.java

@@ -8,6 +8,7 @@
 import com.yoti.api.client.docs.session.create.check.RequestedCheck;
 import com.yoti.api.client.docs.session.create.filters.RequiredDocument;
 import com.yoti.api.client.docs.session.create.identityprofile.advanced.AdvancedIdentityProfileRequirementsPayload;
+import com.yoti.api.client.docs.session.create.identityprofile.simple.IdentityProfileRequirementsPayload;
 import com.yoti.api.client.docs.session.create.resources.ResourceCreationContainer;
 import com.yoti.api.client.docs.session.create.task.RequestedTask;
 
@@ -55,7 +56,7 @@ public class SessionSpec {
     private final IbvOptions ibvOptions;
 
     @JsonProperty(Property.IDENTITY_PROFILE_REQUIREMENTS)
-    private final Map<String, Object> identityProfile;
+    private final IdentityProfileRequirementsPayload identityProfile;
 
     @JsonProperty(Property.ADVANCED_IDENTITY_PROFILE_REQUIREMENTS)
     private final AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirements;
@@ -81,7 +82,7 @@ public class SessionSpec {
             Boolean blockBiometricConsent,
             IbvOptions ibvOptions,
             ZonedDateTime sessionDeadline,
-            Map<String, Object> identityProfile,
+            IdentityProfileRequirementsPayload identityProfile,
             Map<String, Object> subject,
             ResourceCreationContainer resources,
             Boolean createIdentityProfilePreview,
@@ -223,7 +224,7 @@ public ZonedDateTime getSessionDeadline() {
      *
      * @return Identity Profile
      */
-    public Object getIdentityProfile() {
+    public IdentityProfileRequirementsPayload getIdentityProfile() {
         return identityProfile;
     }
 
@@ -277,7 +278,7 @@ public static class Builder {
         private Boolean blockBiometricConsent;
         private IbvOptions ibvOptions;
         private ZonedDateTime sessionDeadline;
-        private Map<String, Object> identityProfile;
+        private IdentityProfileRequirementsPayload identityProfile;
         private AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirementsPayload;
         private Map<String, Object> subject;
         private ResourceCreationContainer resources;
@@ -428,7 +429,7 @@ public Builder withSessionDeadline(ZonedDateTime sessionDeadline) {
          * @param identityProfile the Identity Profile
          * @return the Builder
          */
-        public Builder withIdentityProfile(Map<String, Object> identityProfile) {
+        public Builder withIdentityProfile(IdentityProfileRequirementsPayload identityProfile) {
             this.identityProfile = identityProfile;
             return this;
         }

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/create/identityprofile/simple/IdentityProfileRequirementsPayload.java

@@ -0,0 +1,67 @@
+package com.yoti.api.client.docs.session.create.identityprofile.simple;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class IdentityProfileRequirementsPayload {
+
+    @JsonProperty("trust_framework")
+    private final String trustFramework;
+
+    @JsonProperty("scheme")
+    private final IdentityProfileSchemePayload scheme;
+
+    IdentityProfileRequirementsPayload(String trustFramework, IdentityProfileSchemePayload scheme) {
+        this.trustFramework = trustFramework;
+        this.scheme = scheme;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public String getTrustFramework() {
+        return trustFramework;
+    }
+
+    public IdentityProfileSchemePayload getScheme() {
+        return scheme;
+    }
+
+    public static class Builder {
+
+        private String trustFramework;
+        private IdentityProfileSchemePayload scheme;
+
+        Builder() {}
+
+        /**
+         * Sets the trust framework name for the Identity Profile requirement
+         *
+         * @param trustFramework the name of the trust framework
+         * @return the builder
+         */
+        public Builder withTrustFramework(String trustFramework) {
+            this.trustFramework = trustFramework;
+            return this;
+        }
+
+        /**
+         * Sets the scheme for the Identity Profile requirement
+         *
+         * @param scheme the scheme
+         * @return the builder
+         */
+        public Builder withScheme(IdentityProfileSchemePayload scheme) {
+            this.scheme = scheme;
+            return this;
+        }
+
+        public IdentityProfileRequirementsPayload build() {
+            return new IdentityProfileRequirementsPayload(trustFramework, scheme);
+        }
+
+    }
+
+}

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/create/identityprofile/simple/IdentityProfileSchemePayload.java

@@ -0,0 +1,67 @@
+package com.yoti.api.client.docs.session.create.identityprofile.simple;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class IdentityProfileSchemePayload {
+
+    @JsonProperty("type")
+    private final String type;
+
+    @JsonProperty("objective")
+    private final String objective;
+
+    IdentityProfileSchemePayload(String type, String objective) {
+        this.type = type;
+        this.objective = objective;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public String getObjective() {
+        return objective;
+    }
+
+    public static class Builder {
+
+        private String type;
+        private String objective;
+
+        Builder() {}
+
+        /**
+         * Sets the type of the scheme for the Identity Profile
+         *
+         * @param type the type of scheme
+         * @return the builder
+         */
+        public Builder withType(String type) {
+            this.type = type;
+            return this;
+        }
+
+        /**
+         * Sets the objective of the scheme for the Identity Profile
+         *
+         * @param objective the objective of the scheme
+         * @return the builder
+         */
+        public Builder withObjective(String objective) {
+            this.objective = objective;
+            return this;
+        }
+
+        public IdentityProfileSchemePayload build() {
+            return new IdentityProfileSchemePayload(type, objective);
+        }
+
+    }
+
+}

yoti-sdk-api/src/test/java/com/yoti/api/client/docs/session/create/SessionSpecTest.java

@@ -20,6 +20,7 @@
 import com.yoti.api.client.docs.session.create.check.RequestedDocumentAuthenticityCheck;
 import com.yoti.api.client.docs.session.create.check.RequestedLivenessCheck;
 import com.yoti.api.client.docs.session.create.filters.RequiredDocument;
+import com.yoti.api.client.docs.session.create.identityprofile.simple.IdentityProfileRequirementsPayload;
 import com.yoti.api.client.docs.session.create.resources.ResourceCreationContainer;
 import com.yoti.api.client.docs.session.create.task.RequestedIdDocTextExtractionTask;
 
@@ -57,6 +58,7 @@ public class SessionSpecTest {
     @Mock ZonedDateTime sessionDeadlineMock;
     @Mock ResourceCreationContainer resourceCreationContainerMock;
     @Mock ImportTokenPayload importTokenMock;
+    @Mock IdentityProfileRequirementsPayload identityProfileRequirementsPayloadMock;
 
     @Test
     public void shouldBuildWithMinimalConfiguration() {
@@ -215,33 +217,12 @@ public void withSessionDeadline_shouldSetTheSessionDeadline() {
     }
 
     @Test
-    public void shouldBuildWithIdentityProfileRequirements() throws IOException {
-        Map<String, Object> scheme = new HashMap<>();
-        scheme.put(IdentityProperty.TYPE, "A_TYPE");
-        scheme.put(IdentityProperty.OBJECTIVE, "AN_OBJECTIVE");
-
-        Map<String, Object> identityProfile = new HashMap<>();
-        identityProfile.put(IdentityProperty.TRUST_FRAMEWORK, "A_FRAMEWORK");
-        identityProfile.put(IdentityProperty.SCHEME, scheme);
-
-        JsonNode json = toSessionSpecJson(identityProfile);
-
-        assertThat(
-                json.get(IdentityProperty.TRUST_FRAMEWORK).asText(),
-                is(equalTo(identityProfile.get(IdentityProperty.TRUST_FRAMEWORK)))
-        );
-
-        JsonNode schemeJsonNode = json.get(IdentityProperty.SCHEME);
-        assertThat(schemeJsonNode.get(IdentityProperty.TYPE).asText(), is(equalTo(scheme.get(IdentityProperty.TYPE))));
-        assertThat(schemeJsonNode.get(IdentityProperty.OBJECTIVE).asText(), is(equalTo(scheme.get(IdentityProperty.OBJECTIVE))));
-    }
-
-    private static JsonNode toSessionSpecJson(Map<String, Object> obj) throws IOException {
-        SessionSpec session = SessionSpec.builder()
-                .withIdentityProfile(obj)
+    public void withIdentityProfile_shouldSetTheIdentityProfile() {
+        SessionSpec result = SessionSpec.builder()
+                .withIdentityProfile(identityProfileRequirementsPayloadMock)
                 .build();
 
-        return MAPPER.readTree(MAPPER.writeValueAsString(session.getIdentityProfile()).getBytes(DEFAULT_CHARSET));
+        assertThat(result.getIdentityProfile(), is(identityProfileRequirementsPayloadMock));
     }
 
     @Test