Enum Class ProducerCryptoFailureAction

java.lang.Object

java.lang.Enum<ProducerCryptoFailureAction>

org.apache.pulsar.client.api.v5.auth.ProducerCryptoFailureAction

All Implemented Interfaces:

Serializable, Comparable<ProducerCryptoFailureAction>, Constable

public enum ProducerCryptoFailureAction
extends Enum<ProducerCryptoFailureAction>

Action a producer takes when message encryption fails (e.g. the PublicKeyProvider cannot be reached or returns no key).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL	Fail the send call.
SEND_UNENCRYPTED	Send the message unencrypted instead of failing.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FAIL

public static final ProducerCryptoFailureAction FAIL

Fail the send call. The send future completes exceptionally and the application sees the error.

SEND_UNENCRYPTED

public static final ProducerCryptoFailureAction SEND_UNENCRYPTED

Send the message unencrypted instead of failing. Useful when encryption is opportunistic — for example, during a key-rollout migration.

Method Details

values

public static ProducerCryptoFailureAction[] 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

public static ProducerCryptoFailureAction 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.)

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 name

NullPointerException - if the argument is null