io.didomi.sdk

Class ConsentToken

java.lang.Object

io.didomi.sdk.ConsentToken

public class ConsentToken
extends java.lang.Object

A user consent token A consent token stores all the consent information on the user (date when consent was last collected, list of enabled/disabled purposes and vendors, etc.)

Method Summary

Modifier and Type	Method and Description
static ConsentToken	create() Create a new empty consent token
static ConsentToken	create(java.util.Date created, java.util.Date updated) Create a new empty consent token
static ConsentToken	fromJSON(java.lang.String jsonString, VendorRepository vendorRepository) Create a new consent token from a JSON string The consent is encoded in a standardized format across SDK so it needs to be converted into our internal format.
java.util.Date	getCreated()
java.util.Set<java.lang.String>	getDisabledLegIntVendorIds()
java.util.Map<java.lang.String,Vendor>	getDisabledLegIntVendors()
java.util.Set<java.lang.String>	getDisabledLegitimatePurposeIds()
java.util.Map<java.lang.String,Purpose>	getDisabledLegitimatePurposes()
java.util.Set<java.lang.String>	getDisabledPurposeIds() Get the list of disabled purpose IDs
java.util.Map<java.lang.String,Purpose>	getDisabledPurposes()
java.util.Set<java.lang.String>	getDisabledVendorIds() Get the list of disabled vendor IDs
java.util.Map<java.lang.String,Vendor>	getDisabledVendors()
java.util.Set<java.lang.String>	getEnabledLegIntVendorIds()
java.util.Map<java.lang.String,Vendor>	getEnabledLegIntVendors()
java.util.Set<java.lang.String>	getEnabledLegitimatePurposeIds()
java.util.Map<java.lang.String,Purpose>	getEnabledLegitimatePurposes()
java.util.Set<java.lang.String>	getEnabledPurposeIds() Get enabled purpose IDs
java.util.Map<java.lang.String,Purpose>	getEnabledPurposes()
java.util.Set<java.lang.String>	getEnabledVendorIds() Get enabled vendor IDs
java.util.Set<java.lang.String>	getEnabledVendorIds(java.lang.String namespace) Get enabled vendor IDs for a specific namespace
java.util.Map<java.lang.String,Vendor>	getEnabledVendors()
java.util.Date	getLastSyncDate()
java.util.Date	getUpdated()
boolean	isConsentDenied() Check if consents are denied (purposes and vendors)
boolean	noLegitimatePurposesDefined()
void	setLastSyncDate(java.util.Date lastSyncDate)
boolean	setUserConsentStatus(java.util.Set<Purpose> enabledPurposes, java.util.Set<Purpose> disabledPurposes, java.util.Set<Purpose> enabledLegitimatePurposes, java.util.Set<Purpose> disabledLegitimatePurposes, java.util.Set<Vendor> enabledVendors, java.util.Set<Vendor> disabledVendors, java.util.Set<Vendor> enabledLegIntVendors, java.util.Set<Vendor> disabledLegIntVendors) Update the user consent status for purposes and vendors
org.json.JSONObject	toJSON() Convert the token into a JSON object The token is stored in a standardized format across SDKs so we need to convert from our internal format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static ConsentToken create(java.util.Date created,
                                  java.util.Date updated)

Create a new empty consent token

Returns:

create

public static ConsentToken create()

Create a new empty consent token

Returns:

fromJSON

public static ConsentToken fromJSON(java.lang.String jsonString,
                                    VendorRepository vendorRepository)
                             throws java.lang.Exception

Create a new consent token from a JSON string The consent is encoded in a standardized format across SDK so it needs to be converted into our internal format.

Parameters:

jsonString -

vendorRepository -

Returns:

Throws:

java.lang.Exception

setUserConsentStatus

public boolean setUserConsentStatus(java.util.Set<Purpose> enabledPurposes,
                                    java.util.Set<Purpose> disabledPurposes,
                                    java.util.Set<Purpose> enabledLegitimatePurposes,
                                    java.util.Set<Purpose> disabledLegitimatePurposes,
                                    java.util.Set<Vendor> enabledVendors,
                                    java.util.Set<Vendor> disabledVendors,
                                    java.util.Set<Vendor> enabledLegIntVendors,
                                    java.util.Set<Vendor> disabledLegIntVendors)

Update the user consent status for purposes and vendors

Parameters:

enabledPurposes -

disabledPurposes -

enabledVendors -

disabledVendors -

enabledLegIntVendors -

disabledLegIntVendors -

toJSON

public org.json.JSONObject toJSON()
                           throws org.json.JSONException

Convert the token into a JSON object The token is stored in a standardized format across SDKs so we need to convert from our internal format.

Returns:

Throws:

org.json.JSONException

getEnabledPurposeIds

public java.util.Set<java.lang.String> getEnabledPurposeIds()

Get enabled purpose IDs

Returns:

getEnabledVendorIds

public java.util.Set<java.lang.String> getEnabledVendorIds(java.lang.String namespace)

Get enabled vendor IDs for a specific namespace

Returns:

getEnabledVendorIds

public java.util.Set<java.lang.String> getEnabledVendorIds()

Get enabled vendor IDs

Returns:

getCreated

public java.util.Date getCreated()

getUpdated

public java.util.Date getUpdated()

getLastSyncDate

@Nullable
public java.util.Date getLastSyncDate()

getDisabledPurposes

public java.util.Map<java.lang.String,Purpose> getDisabledPurposes()

getDisabledPurposeIds

public java.util.Set<java.lang.String> getDisabledPurposeIds()

Get the list of disabled purpose IDs

Returns:

getEnabledPurposes

public java.util.Map<java.lang.String,Purpose> getEnabledPurposes()

getDisabledVendors

public java.util.Map<java.lang.String,Vendor> getDisabledVendors()

getDisabledVendorIds

public java.util.Set<java.lang.String> getDisabledVendorIds()

Get the list of disabled vendor IDs

Returns:

getEnabledLegIntVendorIds

public java.util.Set<java.lang.String> getEnabledLegIntVendorIds()

getDisabledLegIntVendorIds

public java.util.Set<java.lang.String> getDisabledLegIntVendorIds()

getEnabledVendors

public java.util.Map<java.lang.String,Vendor> getEnabledVendors()

getEnabledLegIntVendors

public java.util.Map<java.lang.String,Vendor> getEnabledLegIntVendors()

getDisabledLegIntVendors

public java.util.Map<java.lang.String,Vendor> getDisabledLegIntVendors()

getEnabledLegitimatePurposeIds

public java.util.Set<java.lang.String> getEnabledLegitimatePurposeIds()

getDisabledLegitimatePurposeIds

public java.util.Set<java.lang.String> getDisabledLegitimatePurposeIds()

getEnabledLegitimatePurposes

public java.util.Map<java.lang.String,Purpose> getEnabledLegitimatePurposes()

getDisabledLegitimatePurposes

public java.util.Map<java.lang.String,Purpose> getDisabledLegitimatePurposes()

noLegitimatePurposesDefined

public boolean noLegitimatePurposesDefined()

setLastSyncDate

public void setLastSyncDate(java.util.Date lastSyncDate)

isConsentDenied

public boolean isConsentDenied()

Check if consents are denied (purposes and vendors)

Returns:

true contains at least one disabled consent AND no enabled consent