Summary: Ctors | Methods | Inherited Methods

Recipient.Builder

Kotlin |Java

public static class Recipient.Builder
extends Object

java.lang.Object
↳	android.crypto.hpke.Recipient.Builder

A builder for HPKE Recipient objects.

Summary

Public constructors
`Builder(Hpke hpke, byte[] encapsulated, PrivateKey recipientKey)` Creates the builder.

Public methods
`Recipient`	`build()` Builds the `Recipient`.
`Recipient.Builder`	`setApplicationInfo(byte[] applicationInfo)` Adds optional application-related data which will be used during the key generation process.
`Recipient.Builder`	`setPsk(byte[] psk, byte[] pskId)` Sets pre-shared key information to be used for message authentication.
`Recipient.Builder`	`setSenderKey(PublicKey senderKey)` Sets the sender key to be used by the recipient for message authentication.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

public Builder (Hpke hpke, 
                byte[] encapsulated, 
                PrivateKey recipientKey)

Creates the builder.

Parameters
`hpke`	`Hpke`: This value cannot be `null`.
`encapsulated`	`byte`: encapsulated ephemeral key from an `Sender` This value cannot be `null`.
`recipientKey`	`PrivateKey`: private key of the recipient. This value cannot be `null`.

public Recipient build ()

Builds the Recipient.

Returns
`Recipient`	the Recipient. This value cannot be `null`.

Throws
`UnsupportedOperationException`	if this Provider does not support the expected mode
`InvalidKeyException`	if the sender or recipient key are unsupported

public Recipient.Builder setApplicationInfo (byte[] applicationInfo)

Adds optional application-related data which will be used during the key generation process.

Parameters
`applicationInfo`	`byte`: application-specific information. This value cannot be `null`.

Returns
`Recipient.Builder`	the Builder. This value cannot be `null`.

public Recipient.Builder setPsk (byte[] psk, 
                byte[] pskId)

Sets pre-shared key information to be used for message authentication.

Parameters
`psk`	`byte`: the pre-shared secret key. This value cannot be `null`.
`pskId`	`byte`: the id of the pre-shared key. This value cannot be `null`.

Returns
`Recipient.Builder`	the Builder. This value cannot be `null`.

public Recipient.Builder setSenderKey (PublicKey senderKey)

Sets the sender key to be used by the recipient for message authentication.

Parameters
`senderKey`	`PublicKey`: the sender's public key. This value cannot be `null`.

Returns
`Recipient.Builder`	the Builder. This value cannot be `null`.