Class ProducerEncryptionPolicy.Builder

java.lang.Object

org.apache.pulsar.client.api.v5.config.ProducerEncryptionPolicy.Builder

Enclosing class:

ProducerEncryptionPolicy

public static final class ProducerEncryptionPolicy.Builder
extends Object

Builder for ProducerEncryptionPolicy.

Method Summary

Modifier and Type	Method	Description
ProducerEncryptionPolicy	build()
ProducerEncryptionPolicy.Builder	failureAction(ProducerCryptoFailureAction failureAction)	Action to take when encryption fails.
ProducerEncryptionPolicy.Builder	keyName(String keyName)	Single key name shortcut — equivalent to keyNames(List.of(name)).
ProducerEncryptionPolicy.Builder	keyNames(String... keyNames)	Multiple key names.
ProducerEncryptionPolicy.Builder	publicKeyProvider(PublicKeyProvider publicKeyProvider)	Provider used to load public keys.

Methods inherited from class Object

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

Method Details

publicKeyProvider

public ProducerEncryptionPolicy.Builder publicKeyProvider(PublicKeyProvider publicKeyProvider)

Provider used to load public keys. Required.

Parameters:

publicKeyProvider - the public-key provider

Returns:

this builder

keyName

public ProducerEncryptionPolicy.Builder keyName(String keyName)

Single key name shortcut — equivalent to keyNames(List.of(name)).

Parameters:

keyName - the key name

Returns:

this builder

keyNames

public ProducerEncryptionPolicy.Builder keyNames(String... keyNames)

Multiple key names. The producer encrypts each message's data key with every public key listed here, so any consumer with one of the matching private keys can decrypt.

Parameters:

keyNames - one or more key names

Returns:

this builder

failureAction

public ProducerEncryptionPolicy.Builder failureAction(ProducerCryptoFailureAction failureAction)

Action to take when encryption fails. Default: ProducerCryptoFailureAction.FAIL.

Parameters:

failureAction - the failure action

Returns:

this builder

build

public ProducerEncryptionPolicy build()

Returns:

a new ProducerEncryptionPolicy instance