Class ConsumerEncryptionPolicy

java.lang.Object

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

public final class ConsumerEncryptionPolicy
extends Object

Consumer-side end-to-end decryption configuration.

Construct via builder(). The PrivateKeyProvider is required when failureAction() is ConsumerCryptoFailureAction.FAIL (the default — strict mode); for ConsumerCryptoFailureAction.DISCARD or ConsumerCryptoFailureAction.CONSUME the provider may be omitted, in which case the consumer just relies on the failure action to decide what to do with encrypted messages it can't decrypt.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ConsumerEncryptionPolicy.Builder	builder()
ConsumerCryptoFailureAction	failureAction()
PrivateKeyProvider	privateKeyProvider()

Methods inherited from class Object

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

Method Details

privateKeyProvider

public PrivateKeyProvider privateKeyProvider()

Returns:

the provider used to load private keys for decryption, or null when the consumer doesn't decrypt and falls back to the failure action (DISCARD or CONSUME)

failureAction

public ConsumerCryptoFailureAction failureAction()

Returns:

the action the consumer takes when decryption fails

builder

public static ConsumerEncryptionPolicy.Builder builder()

Returns:

a new builder for constructing a ConsumerEncryptionPolicy