Refactoring to separate vendor consent decoding, encoding and representation concerns. Bumping version to 2.0.0

Author: lanusau

.gitignore

@@ -5,3 +5,9 @@ build/*
 *.swp
 gradle-app.setting
 !gradle-wrapper.jar
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+/out/

build.gradle

@@ -4,8 +4,17 @@ apply plugin: 'idea'
 
 repositories {
     mavenCentral()
+    mavenLocal()
 }
 
+group = 'com.iab.gdpr'
+version = '2.0.0-SNAPSHOT'
+
+description = """A Java implementation of the IAB Consent String spec."""
+
+sourceCompatibility = 1.8
+targetCompatibility = 1.8
+
 dependencies {
     testCompile(
             "junit:junit:4.11",

settings.gradle

@@ -0,0 +1 @@
+rootProject.name = 'consent-string-sdk-java'

src/main/java/com/iab/gdpr/VendorConsent.java

@@ -25,6 +25,7 @@
  * 20specification%20v1.0a.pdf
  *
  */
+@Deprecated
 public class VendorConsent {
     private static Decoder decoder = Base64.getUrlDecoder();
     // As per the GDPR framework guidelines padding should be ommitted

src/main/java/com/iab/gdpr/consent/VendorConsent.java

@@ -0,0 +1,100 @@
+package com.iab.gdpr.consent;
+
+import java.time.Instant;
+import java.util.Set;
+
+/**
+ * Representation of the values in the vendor consent string.
+ *
+ * Combination of {@link VendorConsent#isPurposeAllowed(int)} and {@link VendorConsent#isVendorAllowed(int)} methods
+ * fully describes user's consent for particular action by a particular vendor
+ *
+ */
+public interface VendorConsent {
+
+    /**
+     *
+     * @return the version of consent string format
+     */
+    int getVersion();
+
+    /**
+     * @return the {@link Instant} at which the consent string was created
+     */
+    Instant getConsentRecordCreated();
+
+    /**
+     *
+     * @return the {@link Instant} at which consent string was last updated
+     */
+    Instant getConsentRecordLastUpdated();
+
+    /**
+     *
+     * @return the Consent Manager Provider ID that last updated the consent string
+     */
+    int getCmpId();
+
+    /**
+     *
+     * @return the Consent Manager Provider version
+     */
+    int getCmpVersion();
+
+    /**
+     *
+     * @return the screen number in the CMP where consent was given
+     */
+    int getConsentScreen();
+
+    /**
+     *
+     * @return the two-letter ISO639-1 language code that CMP asked for consent in
+     */
+    String getConsentLanguage();
+
+    /**
+     *
+     * @return version of vendor list used in most recent consent string update.
+     */
+    int getVendorListVersion();
+
+    /**
+     *
+     * @return the set of purpose id's which are permitted according to this consent string
+     */
+    Set<Integer> getAllowedPurposes();
+
+    /**
+     *
+     * @return an integer equivalent of allowed purpose id bits according to this consent string
+     */
+    int getAllowedPurposesBits();
+
+    /**
+     *
+     * @return the maximum VendorId for which consent values are given.
+     */
+    int getMaxVendorId();
+
+    /**
+     * Check whether purpose with specified ID is allowed
+     * @param purposeId purpose ID
+     * @return true if purpose is allowed in this consent, false otherwise
+     */
+    boolean isPurposeAllowed(int purposeId);
+
+    /**
+     * Check whether vendor with specified ID is allowd
+     * @param vendorId vendor ID
+     * @return a boolean describing if a user has consented to a particular vendor
+     */
+    boolean isVendorAllowed(int vendorId);
+
+    /**
+     *
+     * @return the value of this consent as byte array
+     */
+    byte[] toByteArray();
+
+}

src/main/java/com/iab/gdpr/consent/VendorConsentDecoder.java

@@ -0,0 +1,50 @@
+package com.iab.gdpr.consent;
+
+import com.iab.gdpr.Bits;
+import com.iab.gdpr.consent.implementation.v1.ByteBufferBackedVendorConsent;
+
+import java.util.Base64;
+
+import static com.iab.gdpr.GdprConstants.VERSION_BIT_OFFSET;
+import static com.iab.gdpr.GdprConstants.VERSION_BIT_SIZE;
+
+/**
+ * {@link VendorConsent} decoder from Base64 string. Right now only version 1 is know, but eventually
+ * this can be extended to support new versions
+ */
+public class VendorConsentDecoder {
+
+    private static final Base64.Decoder BASE64_DECODER = Base64.getUrlDecoder();
+
+    public static VendorConsent fromBase64String(String consentString) {
+        if (isNullOrEmpty(consentString))
+            throw new IllegalArgumentException("Null or empty consent string passed as an argument");
+
+        final Bits bits = new Bits(BASE64_DECODER.decode(consentString));
+        final int version = getVersion(bits);
+        switch (version) {
+            case 1:
+                return new ByteBufferBackedVendorConsent(bits);
+            default:
+                throw new IllegalStateException("Unsupported version: " + version);
+        }
+    }
+
+    /**
+     * Get the version field from bitmap
+     * @param bits bitmap
+     * @return a version number
+     */
+    private static int getVersion(Bits bits) {
+        return bits.getInt(VERSION_BIT_OFFSET, VERSION_BIT_SIZE);
+    }
+
+    /**
+     * Utility method to check whether string is empty or null
+     * @param string value to check
+     * @return a boolean value of the check
+     */
+    private static boolean isNullOrEmpty(String string) {
+        return string == null || string.isEmpty();
+    }
+}

src/main/java/com/iab/gdpr/consent/VendorConsentEncoder.java

@@ -0,0 +1,22 @@
+package com.iab.gdpr.consent;
+
+import java.util.Base64;
+
+/**
+ * Encode {@link VendorConsent} to Base64 string
+ */
+public class VendorConsentEncoder {
+
+    // As per the GDPR framework guidelines padding should be omitted
+    private static final Base64.Encoder ENCODER = Base64.getUrlEncoder().withoutPadding();
+
+    /**
+     * Encode vendor consent to Base64 string
+     * @param vendorConsent vendor consent
+     * @return Base64 encoded string
+     */
+    public static String toBase64String(VendorConsent vendorConsent) {
+        return ENCODER.encodeToString(vendorConsent.toByteArray());
+    }
+
+}