Package org.apache.pulsar.client.api
Enum Class ConsumerCryptoFailureAction
java.lang.Object
java.lang.Enum<ConsumerCryptoFailureAction>
org.apache.pulsar.client.api.ConsumerCryptoFailureAction
- All Implemented Interfaces:
Serializable
,Comparable<ConsumerCryptoFailureAction>
,Constable
The action a consumer should take when a consumer receives a
message that it cannot decrypt.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ConsumerCryptoFailureAction
Returns the enum constant of this class with the specified name.static ConsumerCryptoFailureAction[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FAIL
This is the default option to fail consume messages until crypto succeeds. -
DISCARD
Message is silently acknowledged and not delivered to the application. -
CONSUME
Deliver the encrypted message to the application. It's the application's responsibility to decrypt the message.If message is also compressed, decompression will fail. If message contain batch messages, client will not be able to retrieve individual messages in the batch.
Delivered encrypted message contains
EncryptionContext
which contains encryption and compression information in it using which application can decrypt consumed message payload.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-