com.google.crypto.tink.apps.paymentmethodtoken

Class PaymentMethodTokenRecipient.Builder

java.lang.Object

com.google.crypto.tink.apps.paymentmethodtoken.PaymentMethodTokenRecipient.Builder

Enclosing class:

PaymentMethodTokenRecipient

public static class PaymentMethodTokenRecipient.Builder
extends Object

Builder for PaymentMethodTokenRecipient.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PaymentMethodTokenRecipient.Builder	addRecipientKem(PaymentMethodTokenRecipientKem kem) Adds a custom PaymentMethodTokenRecipientKem.
PaymentMethodTokenRecipient.Builder	addRecipientPrivateKey(ECPrivateKey val) Adds the decryption private key of the recipient.
PaymentMethodTokenRecipient.Builder	addRecipientPrivateKey(String val) Adds the decryption private key of the recipient.
PaymentMethodTokenRecipient.Builder	addSenderVerifyingKey(ECPublicKey val) Adds a verifying public key of the sender.
PaymentMethodTokenRecipient.Builder	addSenderVerifyingKey(String val) Adds a verifying public key of the sender.
PaymentMethodTokenRecipient	build()
PaymentMethodTokenRecipient.Builder	fetchSenderVerifyingKeysWith(GooglePaymentsPublicKeysManager googlePaymentsPublicKeysManager) Fetches verifying public keys of the sender using GooglePaymentsPublicKeysManager.
PaymentMethodTokenRecipient.Builder	protocolVersion(String val) Sets the protocolVersion.
PaymentMethodTokenRecipient.Builder	recipientId(String val) Sets the recipient Id.
PaymentMethodTokenRecipient.Builder	senderId(String val) Sets the sender Id.
PaymentMethodTokenRecipient.Builder	senderVerifyingKeys(String trustedSigningKeysJson) Sets the trusted verifying public keys of the sender.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

protocolVersion

@CanIgnoreReturnValue
public PaymentMethodTokenRecipient.Builder protocolVersion(String val)

Sets the protocolVersion.

senderId

@CanIgnoreReturnValue
public PaymentMethodTokenRecipient.Builder senderId(String val)

Sets the sender Id.

recipientId

@CanIgnoreReturnValue
public PaymentMethodTokenRecipient.Builder recipientId(String val)

Sets the recipient Id.

fetchSenderVerifyingKeysWith

@CanIgnoreReturnValue
public PaymentMethodTokenRecipient.Builder fetchSenderVerifyingKeysWith(GooglePaymentsPublicKeysManager googlePaymentsPublicKeysManager)
                                                                                       throws GeneralSecurityException

Fetches verifying public keys of the sender using GooglePaymentsPublicKeysManager.

This is the preferred method of specifying the verifying public keys of the sender.

Throws:

GeneralSecurityException

senderVerifyingKeys

@CanIgnoreReturnValue
public PaymentMethodTokenRecipient.Builder senderVerifyingKeys(String trustedSigningKeysJson)
                                                                              throws GeneralSecurityException

Sets the trusted verifying public keys of the sender.

IMPORTANT: Instead of using this method to set the verifying public keys of the sender, prefer calling fetchSenderVerifyingKeysWith(com.google.crypto.tink.apps.paymentmethodtoken.GooglePaymentsPublicKeysManager) passing it an instance of GooglePaymentsPublicKeysManager. It will take care of fetching fresh keys and caching in memory. Only use this method if you can't use fetchSenderVerifyingKeysWith(com.google.crypto.tink.apps.paymentmethodtoken.GooglePaymentsPublicKeysManager) and be aware you will need to handle Google key rotations yourself.

The given string is a JSON object formatted like the following:

 {
   "keys": [
     {
       "keyValue": "encoded public key",
       "protocolVersion": "ECv1"
     },
     {
       "keyValue": "encoded public key",
       "protocolVersion": "ECv1"
     },
   ],
 }
 

Each public key will be a base64 (no wrapping, padded) version of the key encoded in ASN.1 type SubjectPublicKeyInfo defined in the X.509 standard.

Throws:

GeneralSecurityException

addSenderVerifyingKey

@CanIgnoreReturnValue
public PaymentMethodTokenRecipient.Builder addSenderVerifyingKey(String val)
                                                                                throws GeneralSecurityException

Adds a verifying public key of the sender.

IMPORTANT: Instead of using this method to set the verifying public keys of the sender, prefer calling fetchSenderVerifyingKeysWith(com.google.crypto.tink.apps.paymentmethodtoken.GooglePaymentsPublicKeysManager) passing it an instance of GooglePaymentsPublicKeysManager. It will take care of fetching fresh keys and caching in memory. Only use this method if you can't use fetchSenderVerifyingKeysWith(com.google.crypto.tink.apps.paymentmethodtoken.GooglePaymentsPublicKeysManager) and be aware you will need to handle Google key rotations yourself.

The public key is a base64 (no wrapping, padded) version of the key encoded in ASN.1 type SubjectPublicKeyInfo defined in the X.509 standard.

Multiple keys may be added. This utility will then verify any message signed with any of the private keys corresponding to the public keys added. Adding multiple keys is useful for handling key rotation.

Throws:

GeneralSecurityException

addSenderVerifyingKey

@CanIgnoreReturnValue
public PaymentMethodTokenRecipient.Builder addSenderVerifyingKey(ECPublicKey val)
                                                                                throws GeneralSecurityException

Adds a verifying public key of the sender.

IMPORTANT: Instead of using this method to set the verifying public keys of the sender, prefer calling fetchSenderVerifyingKeysWith(com.google.crypto.tink.apps.paymentmethodtoken.GooglePaymentsPublicKeysManager) passing it an instance of GooglePaymentsPublicKeysManager. It will take care of fetching fresh keys and caching in memory. Only use this method if you can't use fetchSenderVerifyingKeysWith(com.google.crypto.tink.apps.paymentmethodtoken.GooglePaymentsPublicKeysManager) and be aware you will need to handle Google key rotations yourself.

Throws:

GeneralSecurityException

addRecipientPrivateKey

@CanIgnoreReturnValue
public PaymentMethodTokenRecipient.Builder addRecipientPrivateKey(String val)
                                                                                 throws GeneralSecurityException

Adds the decryption private key of the recipient.

It must be base64 encoded PKCS8 private key.

Throws:

GeneralSecurityException

addRecipientPrivateKey

@CanIgnoreReturnValue
public PaymentMethodTokenRecipient.Builder addRecipientPrivateKey(ECPrivateKey val)
                                                                                 throws GeneralSecurityException

Adds the decryption private key of the recipient.

Throws:

GeneralSecurityException

addRecipientKem

@CanIgnoreReturnValue
public PaymentMethodTokenRecipient.Builder addRecipientKem(PaymentMethodTokenRecipientKem kem)

Adds a custom PaymentMethodTokenRecipientKem.

This is useful for clients that store keys in an HSM and need a more control on how the key is used. If you are not using an HSM, you probably should just use addRecipientPrivateKey(java.lang.String).

Since:

1.1.0

build

public PaymentMethodTokenRecipient build()
                                  throws GeneralSecurityException

Throws:

GeneralSecurityException