Enum Class ConsumerCryptoFailureAction

All Implemented Interfaces:
Serializable, Comparable<ConsumerCryptoFailureAction>, Constable

@Public @Stable public enum ConsumerCryptoFailureAction extends Enum<ConsumerCryptoFailureAction>
The action a consumer should take when a consumer receives a message that it cannot decrypt.
  • Enum Constant Details

    • FAIL

      public static final ConsumerCryptoFailureAction FAIL
      This is the default option to fail consume messages until crypto succeeds.

      public static final ConsumerCryptoFailureAction DISCARD
      Message is silently acknowledged and not delivered to the application.

      public static final ConsumerCryptoFailureAction 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

      public static ConsumerCryptoFailureAction[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ConsumerCryptoFailureAction valueOf(String name)
      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.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null