io.lettuce.core

Class RedisAuthenticationHandler<K,V>

java.lang.Object

io.lettuce.core.RedisAuthenticationHandler<K,V>

public class RedisAuthenticationHandler<K,V>
extends Object

Redis authentication handler. Internally used to authenticate a Redis connection. This class is part of the internal API.

Since:

6.6.0

Author:

Ivo Gaydazhiev

Constructor Summary

Constructors

Constructor and Description
RedisAuthenticationHandler(StatefulRedisConnectionImpl<K,V> connection, RedisCredentialsProvider credentialsProvider, Boolean isPubSubConnection) Creates a new RedisAuthenticationHandler.

Method Summary

Modifier and Type	Method and Description
protected void	complete()
static <K,V> RedisAuthenticationHandler<K,V>	createDefaultAuthenticationHandler() Creates a new default RedisAuthenticationHandler.
static <K,V> RedisAuthenticationHandler<K,V>	createHandler(StatefulRedisConnectionImpl<K,V> connection, RedisCredentialsProvider credentialsProvider, Boolean isPubSubConnection, ClientOptions options) Creates a new RedisAuthenticationHandler if the connection supports re-authentication.
protected void	dispatchAuth(RedisCredentials credentials)
void	endTransaction() Marks that the current connection has ended the transaction.
protected void	onError(Throwable e)
protected void	onNext(RedisCredentials credentials)
protected void	postProcess(Collection<? extends RedisCommand<K,V,?>> dispatched) Post-processes a collection of dispatched commands after they are sent to the server.
protected void	postProcess(RedisCommand<K,V,?> toSend) Post-processes the command after it is sent to the server.
protected void	reauthenticate(RedisCredentials credentials) Performs re-authentication with the provided credentials.
void	setCredentials(RedisCredentials credentials) Authenticates the current connection using the provided credentials.
void	startTransaction() Marks that the current connection has started a transaction.
void	subscribe() This method subscribes to a stream of credentials provided by the `StreamingCredentialsProvider`.
void	unsubscribe() Unsubscribes from the current credentials stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedisAuthenticationHandler

public RedisAuthenticationHandler(StatefulRedisConnectionImpl<K,V> connection,
                                  RedisCredentialsProvider credentialsProvider,
                                  Boolean isPubSubConnection)

Creates a new RedisAuthenticationHandler.

Parameters:

connection - the connection to authenticate

credentialsProvider - the implementation of RedisCredentialsProvider to use

isPubSubConnection - true if the connection is a pub/sub connection

Method Detail

createHandler

public static <K,V> RedisAuthenticationHandler<K,V> createHandler(StatefulRedisConnectionImpl<K,V> connection,
                                                                  RedisCredentialsProvider credentialsProvider,
                                                                  Boolean isPubSubConnection,
                                                                  ClientOptions options)

Creates a new RedisAuthenticationHandler if the connection supports re-authentication.

Parameters:

connection - the connection to authenticate

credentialsProvider - the implementation of RedisCredentialsProvider to use

isPubSubConnection - true if the connection is a pub/sub connection

options - the ClientOptions to use

Returns:

a new RedisAuthenticationHandler if the connection supports re-authentication, otherwise an implementation of the RedisAuthenticationHandler that does nothing

Since:

6.6.0

See Also:

RedisCredentialsProvider

createDefaultAuthenticationHandler

public static <K,V> RedisAuthenticationHandler<K,V> createDefaultAuthenticationHandler()

Creates a new default RedisAuthenticationHandler.

The default RedisAuthenticationHandler is used when re-authentication is not supported.

Returns:

a new RedisAuthenticationHandler

Since:

6.6.0

See Also:

RedisCredentialsProvider

subscribe

public void subscribe()

This method subscribes to a stream of credentials provided by the `StreamingCredentialsProvider`.

Each time new credentials are received, the client is re-authenticated. The previous subscription, if any, is disposed of before setting the new subscription.

unsubscribe

public void unsubscribe()

Unsubscribes from the current credentials stream.

complete

protected void complete()

onNext

protected void onNext(RedisCredentials credentials)

onError

protected void onError(Throwable e)

reauthenticate

protected void reauthenticate(RedisCredentials credentials)

Performs re-authentication with the provided credentials.

Parameters:

credentials - the new credentials

postProcess

protected void postProcess(RedisCommand<K,V,?> toSend)

Post-processes the command after it is sent to the server.

If the command type is either RedisCommand.Type#EXEC or RedisCommand.Type#DISCARD, the transaction state is cleared and a check for deferred credentials is initiated.

Parameters:

toSend - the command to post-process

postProcess

protected void postProcess(Collection<? extends RedisCommand<K,V,?>> dispatched)

Post-processes a collection of dispatched commands after they are sent to the server.

This method checks if any of the dispatched commands indicate the completion of a transaction (via RedisCommand.Type#EXEC or RedisCommand.Type#DISCARD). If the transaction is complete, it clears the transaction state and initiates a check for deferred credentials.

Parameters:

dispatched - the collection of dispatched commands to post-process

startTransaction

public void startTransaction()

Marks that the current connection has started a transaction.

During transactions, any re-authentication attempts are deferred until the transaction ends.

endTransaction

public void endTransaction()

Marks that the current connection has ended the transaction.

After a transaction is completed, any deferred re-authentication attempts are dispatched.

setCredentials

public void setCredentials(RedisCredentials credentials)

Authenticates the current connection using the provided credentials.

Unlike using dispatch of RedisAsyncCommands.auth(java.lang.CharSequence), this method defers the AUTH command if the connection is within an active transaction. The authentication command will only be dispatched after the enclosing DISCARD or EXEC command is executed, ensuring that authentication does not interfere with ongoing transactions.

Parameters:

credentials - the RedisCredentials to authenticate the connection. If null, no action is performed.

Behavior:

• If the provided credentials are null, the method exits immediately.
• If a transaction is active (as indicated by inTransaction), the AUTH command is not dispatched immediately but deferred until the transaction ends.
• If no transaction is active, the AUTH command is dispatched immediately using the provided credentials.

See Also:

RedisAsyncCommands.auth(java.lang.CharSequence)

dispatchAuth

protected void dispatchAuth(RedisCredentials credentials)