EncryptedTopic


public final class EncryptedTopic
extends Object

java.lang.Object
   ↳ android.adservices.topics.EncryptedTopic


Encrypted form of Topic. This object will be used to return encrypted topic cipher text along with necessary fields required to decrypt it.

Decryption of EncryptedTopic#getEncryptedTopic() should give json string for Topic. Example of decrypted json string: { "taxonomy_version": 5, "model_version": 2, "topic_id": 10010 }

Decryption of cipher text is expected to happen on the server with the corresponding algorithm and private key for the public key EncryptedTopic#getKeyIdentifier()}.

Detailed steps on decryption can be found on Developer Guide.

Summary

Public constructors

EncryptedTopic(byte[] encryptedTopic, String keyIdentifier, byte[] encapsulatedKey)

Creates encrypted version of the Topic object.

Public methods

boolean equals(Object object)

Indicates whether some other object is "equal to" this one.

byte[] getEncapsulatedKey()

Returns the encapsulated key generated during HPKE setup.

byte[] getEncryptedTopic()

Returns encrypted bytes for the JSON version of the Topic object as cipher text.

String getKeyIdentifier()

Returns key identifier for the used encryption key.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Inherited methods

Public constructors

EncryptedTopic

public EncryptedTopic (byte[] encryptedTopic, 
                String keyIdentifier, 
                byte[] encapsulatedKey)

Creates encrypted version of the Topic object.

Parameters
encryptedTopic byte: byte array cipher text containing encrypted Topic json string. This value cannot be null.

keyIdentifier String: key used to identify the public key used for encryption. This value cannot be null.

encapsulatedKey byte: encapsulated key generated during HPKE setup. This value cannot be null.

Public methods

equals

Added in API level 35
public boolean equals (Object object)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
object Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getEncapsulatedKey

public byte[] getEncapsulatedKey ()

Returns the encapsulated key generated during HPKE setup.

Returns
byte[] This value cannot be null.

getEncryptedTopic

public byte[] getEncryptedTopic ()

Returns encrypted bytes for the JSON version of the Topic object as cipher text.

Returns
byte[] This value cannot be null.

getKeyIdentifier

public String getKeyIdentifier ()

Returns key identifier for the used encryption key.

Returns
String This value cannot be null.

hashCode

Added in API level 35
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

toString

Added in API level 35
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.