Package com.iab.gdpr

Class VendorConsent

java.lang.Object

com.iab.gdpr.VendorConsent

@Deprecated
public class VendorConsent
extends Object

Deprecated.

This is deprecated and will be removed in future versions Use VendorConsentDecoder to decode vendor consent string Use VendorConsentBuilder to build version 1 consent string Use VendorConsentEncoder to encode vendor consent to string

This class implements a builder and a factory method for the IAB consent as specified in https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/ Draft_for_Public_Comment_Transparency%20%26%20Consent%20Framework%20-%20cookie%20and%20vendor%20list%20format% 20specification%20v1.0a.pdf

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VendorConsent.Builder	Deprecated.
static class	VendorConsent.RangeEntry	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	arePurposesAllowed(List<Integer> purposeIds)	Deprecated.
boolean	equals(Object o)	Deprecated.
static VendorConsent	fromBase64String(String consentString)	Deprecated. Constructor.
List<Integer>	getAllowedPurposes()	Deprecated.
int	getAllowedPurposesBits()	Deprecated.
String	getBinaryString()	Deprecated.
List<Boolean>	getBitfield()	Deprecated.
int	getCmpId()	Deprecated.
int	getCmpVersion()	Deprecated.
String	getConsentLanguage()	Deprecated.
Date	getConsentRecordCreated()	Deprecated.
Date	getConsentRecordLastUpdated()	Deprecated.
int	getConsentScreen()	Deprecated.
String	getConsentString()	Deprecated.
int	getMaxVendorId()	Deprecated.
List<VendorConsent.RangeEntry>	getRangeEntries()	Deprecated.
int	getVendorEncodingType()	Deprecated.
int	getVendorListVersion()	Deprecated.
int	getVersion()	Deprecated.
int	hashCode()	Deprecated.
boolean	isDefaultConsent()	Deprecated.
boolean	isPurposeAllowed(int purposeId)	Deprecated.
boolean	isVendorAllowed(int vendorId)	Deprecated.
String	toString()	Deprecated.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

fromBase64String

public static VendorConsent fromBase64String(String consentString)
                                      throws GdprException

Deprecated.

Constructor.

Parameters:

consentString - (required). The binary user consent data encoded as url and filename safe base64 string

Throws:

GdprException - if the consent string cannot be parsed

getConsentString

public String getConsentString()

Deprecated.

Returns:

the string passes in the constructor.

getConsentRecordCreated

public Date getConsentRecordCreated()

Deprecated.

Returns:

the Date at which the consent record was created

getConsentRecordLastUpdated

public Date getConsentRecordLastUpdated()

Deprecated.

Returns:

the Date at which the cookie was last updated

getVersion

public int getVersion()

Deprecated.

Returns:

the version of the cookie format used in this consent string

getCmpId

public int getCmpId()

Deprecated.

Returns:

the id of the consent management partner that created this consent string

getCmpVersion

public int getCmpVersion()

Deprecated.

Returns:

the version of the cmp being used

getConsentScreen

public int getConsentScreen()

Deprecated.

Returns:

the id of the string through which the user gave consent in the CMP UI

getConsentLanguage

public String getConsentLanguage()

Deprecated.

Returns:

The two letter ISO639-1 language code in which the CMP asked for consent

getMaxVendorId

public int getMaxVendorId()

Deprecated.

isDefaultConsent

public boolean isDefaultConsent()

Deprecated.

getVendorEncodingType

public int getVendorEncodingType()

Deprecated.

getRangeEntries

public List<VendorConsent.RangeEntry> getRangeEntries()

Deprecated.

getBitfield

public List<Boolean> getBitfield()

Deprecated.

getBinaryString

public String getBinaryString()

Deprecated.

getAllowedPurposes

public List<Integer> getAllowedPurposes()

Deprecated.

Returns:

a list of purpose id's which are permitted according to this consent string

getAllowedPurposesBits

public int getAllowedPurposesBits()

Deprecated.

Returns:

an integer equivalent of allowed purpose id bits according to this consent string

getVendorListVersion

public int getVendorListVersion()

Deprecated.

Returns:

the vendor list version which was used in creating this consent string

isPurposeAllowed

public boolean isPurposeAllowed(int purposeId)

Deprecated.

Returns:

a boolean describing the user consent status for a particular purpose. The lowest purpose ID is 1.

arePurposesAllowed

public boolean arePurposesAllowed(List<Integer> purposeIds)

Deprecated.

isVendorAllowed

public boolean isVendorAllowed(int vendorId)

Deprecated.

Returns:

a boolean describing if a vendor has consented to a particular vendor. The lowest vendor ID is 1. This method, along with isPurposeAllowed(int) fully describes the user consent for a particular action by a given vendor.

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

toString

public String toString()

Deprecated.

Overrides:

toString in class Object