com.iab.gpp.encoder.segment.UsNatCoreSegment Maven / Gradle / Ivy
The newest version!
package com.iab.gpp.encoder.segment;
import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;
import com.iab.gpp.encoder.base64.AbstractBase64UrlEncoder;
import com.iab.gpp.encoder.base64.CompressedBase64UrlEncoder;
import com.iab.gpp.encoder.bitstring.BitStringEncoder;
import com.iab.gpp.encoder.datatype.EncodableFixedInteger;
import com.iab.gpp.encoder.datatype.EncodableFixedIntegerList;
import com.iab.gpp.encoder.error.DecodingException;
import com.iab.gpp.encoder.error.ValidationException;
import com.iab.gpp.encoder.field.EncodableBitStringFields;
import com.iab.gpp.encoder.field.UsNatField;
import com.iab.gpp.encoder.section.UsNat;
public class UsNatCoreSegment extends AbstractLazilyEncodableSegment {
private AbstractBase64UrlEncoder base64UrlEncoder = CompressedBase64UrlEncoder.getInstance();
private BitStringEncoder bitStringEncoder = BitStringEncoder.getInstance();
public UsNatCoreSegment() {
super();
}
public UsNatCoreSegment(String encodedString) {
super();
this.decode(encodedString);
}
@Override
public List getFieldNames() {
return UsNatField.USNAT_CORE_SEGMENT_FIELD_NAMES;
}
@Override
protected EncodableBitStringFields initializeFields() {
Predicate nullableBooleanAsTwoBitIntegerValidator = (n -> n >= 0 && n <= 2);
Predicate nonNullableBooleanAsTwoBitIntegerValidator = (n -> n >= 1 && n <= 2);
Predicate> nullableBooleanAsTwoBitIntegerListValidator = (l -> {
for (int n : l) {
if (n < 0 || n > 2) {
return false;
}
}
return true;
});
EncodableBitStringFields fields = new EncodableBitStringFields();
fields.put(UsNatField.VERSION, new EncodableFixedInteger(6, UsNat.VERSION));
fields.put(UsNatField.SHARING_NOTICE,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.SALE_OPT_OUT_NOTICE,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.SHARING_OPT_OUT_NOTICE,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.TARGETED_ADVERTISING_OPT_OUT_NOTICE,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.SENSITIVE_DATA_PROCESSING_OPT_OUT_NOTICE,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.SENSITIVE_DATA_LIMIT_USE_NOTICE,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.SALE_OPT_OUT,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.SHARING_OPT_OUT,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.TARGETED_ADVERTISING_OPT_OUT,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.SENSITIVE_DATA_PROCESSING,
new EncodableFixedIntegerList(2, Arrays.asList(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0))
.withValidator(nullableBooleanAsTwoBitIntegerListValidator));
fields.put(UsNatField.KNOWN_CHILD_SENSITIVE_DATA_CONSENTS, new EncodableFixedIntegerList(2, Arrays.asList(0, 0))
.withValidator(nullableBooleanAsTwoBitIntegerListValidator));
fields.put(UsNatField.PERSONAL_DATA_CONSENTS,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.MSPA_COVERED_TRANSACTION,
new EncodableFixedInteger(2, 1).withValidator(nonNullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.MSPA_OPT_OUT_OPTION_MODE,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
fields.put(UsNatField.MSPA_SERVICE_PROVIDER_MODE,
new EncodableFixedInteger(2, 0).withValidator(nullableBooleanAsTwoBitIntegerValidator));
return fields;
}
@Override
protected String encodeSegment(EncodableBitStringFields fields) {
String bitString = bitStringEncoder.encode(fields, getFieldNames());
String encodedString = base64UrlEncoder.encode(bitString);
return encodedString;
}
@Override
protected void decodeSegment(String encodedString, EncodableBitStringFields fields) {
if (encodedString == null || encodedString.isEmpty()) {
this.fields.reset(fields);
}
try {
String bitString = base64UrlEncoder.decode(encodedString);
bitStringEncoder.decode(bitString, getFieldNames(), fields);
} catch (Exception e) {
throw new DecodingException("Unable to decode UsNatCoreSegment '" + encodedString + "'", e);
}
}
@Override
public void validate() {
Integer sharingNotice = ((EncodableFixedInteger) fields.get(UsNatField.SHARING_NOTICE)).getValue();
Integer sharingOptOutNotice = ((EncodableFixedInteger) fields.get(UsNatField.SHARING_OPT_OUT_NOTICE)).getValue();
Integer sharingOptOut = ((EncodableFixedInteger) fields.get(UsNatField.SHARING_OPT_OUT)).getValue();
Integer saleOptOutNotice = ((EncodableFixedInteger) fields.get(UsNatField.SALE_OPT_OUT_NOTICE)).getValue();
Integer saleOptOut = ((EncodableFixedInteger) fields.get(UsNatField.SALE_OPT_OUT)).getValue();
Integer targetedAdvertisingOptOutNotice =
((EncodableFixedInteger) fields.get(UsNatField.TARGETED_ADVERTISING_OPT_OUT_NOTICE)).getValue();
Integer targetedAdvertisingOptOut =
((EncodableFixedInteger) fields.get(UsNatField.TARGETED_ADVERTISING_OPT_OUT)).getValue();
Integer mspaServiceProviderMode =
((EncodableFixedInteger) fields.get(UsNatField.MSPA_SERVICE_PROVIDER_MODE)).getValue();
Integer mspaOptOutOptionMode =
((EncodableFixedInteger) fields.get(UsNatField.MSPA_OPT_OUT_OPTION_MODE)).getValue();
Integer sensitiveDataLimtUserNotice =
((EncodableFixedInteger) fields.get(UsNatField.SENSITIVE_DATA_LIMIT_USE_NOTICE)).getValue();
if (sharingNotice == 0) {
if (sharingOptOut != 0) {
throw new ValidationException(
"Invalid usnat sharing notice / opt out combination: {" + sharingNotice + " / " + sharingOptOut + "}");
}
} else if (sharingNotice == 1) {
if (sharingOptOut != 1 && sharingOptOut != 2) {
throw new ValidationException(
"Invalid usnat sharing notice / opt out combination: {" + sharingNotice + " / " + sharingOptOut + "}");
}
} else if (sharingNotice == 2) {
if (sharingOptOut != 1) {
throw new ValidationException(
"Invalid usnat sharing notice / opt out combination: {" + sharingNotice + " / " + sharingOptOut + "}");
}
}
if (sharingOptOutNotice == 0) {
if (sharingOptOut != 0) {
throw new ValidationException("Invalid usnat sharing notice / opt out combination: {" + sharingOptOutNotice
+ " / " + sharingOptOut + "}");
}
} else if (sharingOptOutNotice == 1) {
if (sharingOptOut != 1 && sharingOptOut != 2) {
throw new ValidationException("Invalid usnat sharing notice / opt out combination: {" + sharingOptOutNotice
+ " / " + sharingOptOut + "}");
}
} else if (sharingOptOutNotice == 2) {
if (sharingOptOut != 1) {
throw new ValidationException("Invalid usnat sharing notice / opt out combination: {" + sharingOptOutNotice
+ " / " + sharingOptOut + "}");
}
}
if (saleOptOutNotice == 0) {
if (saleOptOut != 0) {
throw new ValidationException(
"Invalid usnat sale notice / opt out combination: {" + saleOptOutNotice + " / " + saleOptOut + "}");
}
} else if (saleOptOutNotice == 1) {
if (saleOptOut != 1 && saleOptOut != 2) {
throw new ValidationException(
"Invalid usnat sale notice / opt out combination: {" + saleOptOutNotice + " / " + saleOptOut + "}");
}
} else if (saleOptOutNotice == 2) {
if (saleOptOut != 1) {
throw new ValidationException(
"Invalid usnat sale notice / opt out combination: {" + saleOptOutNotice + " / " + saleOptOut + "}");
}
}
if (targetedAdvertisingOptOutNotice == 0) {
if (targetedAdvertisingOptOut != 0) {
throw new ValidationException("Invalid usnat targeted advertising notice / opt out combination: {"
+ targetedAdvertisingOptOutNotice + " / " + targetedAdvertisingOptOut + "}");
}
} else if (targetedAdvertisingOptOutNotice == 1) {
if (saleOptOut != 1 && saleOptOut != 2) {
throw new ValidationException("Invalid usnat targeted advertising notice / opt out combination: {"
+ targetedAdvertisingOptOutNotice + " / " + targetedAdvertisingOptOut + "}");
}
} else if (targetedAdvertisingOptOutNotice == 2) {
if (saleOptOut != 1) {
throw new ValidationException("Invalid usnat targeted advertising notice / opt out combination: {"
+ targetedAdvertisingOptOutNotice + " / " + targetedAdvertisingOptOut + "}");
}
}
if (mspaServiceProviderMode == 0) {
if (saleOptOutNotice != 0) {
throw new ValidationException("Invalid usnat mspa service provider mode / sale opt out notice combination: {"
+ mspaServiceProviderMode + " / " + saleOptOutNotice + "}");
}
if (sharingOptOutNotice != 0) {
throw new ValidationException("Invalid usnat mspa service provider mode / sharing opt out notice combination: {"
+ mspaServiceProviderMode + " / " + sharingOptOutNotice + "}");
}
if (sensitiveDataLimtUserNotice != 0) {
throw new ValidationException(
"Invalid usnat mspa service provider mode / sensitive data limit use notice combination: {"
+ mspaServiceProviderMode + " / " + sensitiveDataLimtUserNotice + "}");
}
} else if (mspaServiceProviderMode == 1) {
if (mspaOptOutOptionMode != 2) {
throw new ValidationException("Invalid usnat mspa service provider / opt out option modes combination: {"
+ mspaServiceProviderMode + " / " + mspaServiceProviderMode + "}");
}
if (saleOptOutNotice != 0) {
throw new ValidationException("Invalid usnat mspa service provider mode / sale opt out notice combination: {"
+ mspaServiceProviderMode + " / " + saleOptOutNotice + "}");
}
if (sharingOptOutNotice != 0) {
throw new ValidationException("Invalid usnat mspa service provider mode / sharing opt out notice combination: {"
+ mspaServiceProviderMode + " / " + sharingOptOutNotice + "}");
}
if (sensitiveDataLimtUserNotice != 0) {
throw new ValidationException(
"Invalid usnat mspa service provider mode / sensitive data limit use notice combination: {"
+ mspaServiceProviderMode + " / " + sensitiveDataLimtUserNotice + "}");
}
} else if (mspaServiceProviderMode == 2) {
if (mspaOptOutOptionMode != 1) {
throw new ValidationException("Invalid usnat mspa service provider / opt out option modes combination: {"
+ mspaServiceProviderMode + " / " + mspaOptOutOptionMode + "}");
}
}
}
}