Package org.apache.pulsar.client.api

Enum ConsumerCryptoFailureAction

java.lang.Object

java.lang.Enum<ConsumerCryptoFailureAction>

org.apache.pulsar.client.api.ConsumerCryptoFailureAction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConsumerCryptoFailureAction>

@Public
@Stable
public enum ConsumerCryptoFailureAction
extends java.lang.Enum<ConsumerCryptoFailureAction>

The action a consumer should take when a consumer receives a message that it cannot decrypt.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONSUME	Deliver the encrypted message to the application.
DISCARD	Message is silently acknowledged and not delivered to the application.
FAIL	This is the default option to fail consume messages until crypto succeeds.

Method Summary

Modifier and Type	Method	Description
static ConsumerCryptoFailureAction	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ConsumerCryptoFailureAction[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FAIL

public static final ConsumerCryptoFailureAction FAIL

This is the default option to fail consume messages until crypto succeeds.

DISCARD

public static final ConsumerCryptoFailureAction DISCARD

Message is silently acknowledged and not delivered to the application.

CONSUME

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 Detail

values

public static ConsumerCryptoFailureAction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConsumerCryptoFailureAction c : ConsumerCryptoFailureAction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConsumerCryptoFailureAction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null