io.lettuce.core

Enum ClientOptions.ReauthenticateBehavior

java.lang.Object

java.lang.Enum<ClientOptions.ReauthenticateBehavior>

io.lettuce.core.ClientOptions.ReauthenticateBehavior

All Implemented Interfaces:

Serializable, Comparable<ClientOptions.ReauthenticateBehavior>

Enclosing class:

ClientOptions

public static enum ClientOptions.ReauthenticateBehavior
extends Enum<ClientOptions.ReauthenticateBehavior>

Defines the re-authentication behavior of the Redis client.

Certain implementations of the RedisCredentialsProvider could emit new credentials at runtime. This setting controls how the driver reacts to these newly emitted credentials.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT This is the default behavior.
ON_NEW_CREDENTIALS Automatically triggers re-authentication whenever new credentials are emitted by a RedisCredentialsProvider that supports streaming, as indicated by RedisCredentialsProvider.supportsStreaming().

Method Summary

Modifier and Type	Method and Description
static ClientOptions.ReauthenticateBehavior	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClientOptions.ReauthenticateBehavior[]	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

DEFAULT

public static final ClientOptions.ReauthenticateBehavior DEFAULT

This is the default behavior. The client will fetch current credentials from the underlying RedisCredentialsProvider only when the driver needs to, e.g. when the connection is first established or when it is re-established after a disconnect.

No re-authentication is performed when new credentials are emitted by a RedisCredentialsProvider that supports streaming. The client does not subscribe to or react to any updates in the credential stream provided by RedisCredentialsProvider.credentials().

ON_NEW_CREDENTIALS

public static final ClientOptions.ReauthenticateBehavior ON_NEW_CREDENTIALS

Automatically triggers re-authentication whenever new credentials are emitted by a RedisCredentialsProvider that supports streaming, as indicated by RedisCredentialsProvider.supportsStreaming().

When this behavior is enabled, the client subscribes to the credential stream provided by RedisCredentialsProvider.credentials() and issues an AUTH command to the Redis server each time new credentials are received. This behavior supports dynamic credential scenarios, such as token-based authentication, or credential rotation where credentials are refreshed periodically to maintain access.

Note: AUTH commands issued as part of this behavior may interleave with user-submitted commands, as the client performs re-authentication independently of user command flow.

Method Detail

values

public static ClientOptions.ReauthenticateBehavior[] 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 (ClientOptions.ReauthenticateBehavior c : ClientOptions.ReauthenticateBehavior.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClientOptions.ReauthenticateBehavior valueOf(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:

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

NullPointerException - if the argument is null