Class ProducerEncryptionPolicy

java.lang.Object

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

public final class ProducerEncryptionPolicy
extends Object

Producer-side end-to-end encryption configuration.

Construct via builder(). Required: a PublicKeyProvider and at least one key name.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ProducerEncryptionPolicy.Builder	Builder for ProducerEncryptionPolicy.

Method Summary

Modifier and Type	Method	Description
static ProducerEncryptionPolicy.Builder	builder()
ProducerCryptoFailureAction	failureAction()
List<String>	keyNames()
PublicKeyProvider	publicKeyProvider()

Methods inherited from class Object

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

Method Details

publicKeyProvider

public PublicKeyProvider publicKeyProvider()

Returns:

the provider used to load public keys for encryption

keyNames

public List<String> keyNames()

Returns:

the configured key names; the producer encrypts each message's data key with every public key listed here

failureAction

public ProducerCryptoFailureAction failureAction()

Returns:

the action the producer takes when encryption fails

builder

public static ProducerEncryptionPolicy.Builder builder()

Returns:

a new builder for constructing a ProducerEncryptionPolicy