Package com.iab.gdpr

Class VendorConsent.Builder

java.lang.Object

com.iab.gdpr.VendorConsent.Builder

Enclosing class:

VendorConsent

public static class VendorConsent.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VendorConsent	build()
VendorConsent.Builder	withAllowedPurposes(List<Integer> allowedPurposes)
VendorConsent.Builder	withBitField(List<Integer> bitFieldEntries)
VendorConsent.Builder	withCmpID(int cmpID)
VendorConsent.Builder	withCmpVersion(int cmpVersion)
VendorConsent.Builder	withConsentLanguage(String consentLanguage)
VendorConsent.Builder	withConsentRecordCreatedOn(Date consentRecordCreated)
VendorConsent.Builder	withConsentRecordLastUpdatedOn(Date consentRecordLastUpdated)
VendorConsent.Builder	withConsentScreenID(int consentScreenID)
VendorConsent.Builder	withDefaultConsent(boolean defaultConsent)
VendorConsent.Builder	withMaxVendorId(int maxVendorId)
VendorConsent.Builder	withRangeEntries(List<VendorConsent.RangeEntry> rangeEntries)
VendorConsent.Builder	withVendorEncodingType(int vendorEncodingType)
VendorConsent.Builder	withVendorListVersion(int vendorListVersion)
VendorConsent.Builder	withVersion(int version)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withVersion

public VendorConsent.Builder withVersion(int version)

Parameters:

version - Version of the Consent String Format

withConsentRecordCreatedOn

public VendorConsent.Builder withConsentRecordCreatedOn(Date consentRecordCreated)

Parameters:

consentRecordCreated - Epoch deciseconds when consent string was first created

withConsentRecordLastUpdatedOn

public VendorConsent.Builder withConsentRecordLastUpdatedOn(Date consentRecordLastUpdated)

Parameters:

consentRecordLastUpdated - Epoch deciseconds when consent string was last updated

withCmpID

public VendorConsent.Builder withCmpID(int cmpID)

Parameters:

cmpID - Consent Manager Provider ID that last updated the consent string

withCmpVersion

public VendorConsent.Builder withCmpVersion(int cmpVersion)

Parameters:

cmpVersion - Consent Manager Provider version

withConsentScreenID

public VendorConsent.Builder withConsentScreenID(int consentScreenID)

Parameters:

consentScreenID - Screen number in the CMP where consent was given

withConsentLanguage

public VendorConsent.Builder withConsentLanguage(String consentLanguage)

Parameters:

consentLanguage - Two-letter ISO639-1 language code that CMP asked for consent in. Each letter should be encoded as 6 bits, A=0..Z=25 . This will result in the base64url-encoded bytes spelling out the language code (in uppercase).

withVendorListVersion

public VendorConsent.Builder withVendorListVersion(int vendorListVersion)

Parameters:

vendorListVersion - Version of vendor list used in most recent consent string update

withAllowedPurposes

public VendorConsent.Builder withAllowedPurposes(List<Integer> allowedPurposes)

Parameters:

allowedPurposes - For each Purpose, one bit: 0=No Consent 1=Consent Purposes are listed in the global Vendor List. Resultant consent value is the ?AND? of the applicable bit(s) from this field and a vendor?s specific consent bit. Purpose #1 maps to the first (most significant) bit, purpose #24 maps to the last (least significant) bit.

withMaxVendorId

public VendorConsent.Builder withMaxVendorId(int maxVendorId)

Parameters:

maxVendorId - The maximum VendorId for which consent values are given.

withVendorEncodingType

public VendorConsent.Builder withVendorEncodingType(int vendorEncodingType)

Parameters:

vendorEncodingType - 0=BitField 1=Range

withBitField

public VendorConsent.Builder withBitField(List<Integer> bitFieldEntries)

Parameters:

bitFieldEntries - List of VendorIds for which the vendors have consent

withRangeEntries

public VendorConsent.Builder withRangeEntries(List<VendorConsent.RangeEntry> rangeEntries)

Parameters:

rangeEntries - List of VendorIds or a range of VendorIds for which the vendors have consent

withDefaultConsent

public VendorConsent.Builder withDefaultConsent(boolean defaultConsent)

Parameters:

defaultConsent - Default consent for VendorIds not covered by a RangeEntry. 0=No Consent 1=Consent

build

public VendorConsent build()