io.lettuce.core

Interface RedisCredentialsProvider

All Known Subinterfaces:

RedisCredentialsProvider.ImmediateRedisCredentialsProvider

All Known Implementing Classes:

StaticCredentialsProvider, TokenBasedRedisCredentialsProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface RedisCredentialsProvider

Interface for loading RedisCredentials that are used for authentication. A commonly-used implementation is StaticCredentialsProvider for a fixed set of credentials.

Credentials are requested by the driver after connecting to the server. Therefore, credential retrieval is subject to complete within the connection creation timeout to avoid connection failures.

Since:

6.2

Author:

Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RedisCredentialsProvider.ImmediateRedisCredentialsProvider Extension to RedisCredentialsProvider that resolves credentials immediately without the need to defer the credential resolution.

Method Summary

Modifier and Type	Method and Description
default Flux<RedisCredentials>	credentials() Returns a Flux emitting RedisCredentials that can be used to authorize a Redis connection.
static RedisCredentialsProvider	from(Supplier<RedisCredentials> supplier) Creates a new RedisCredentialsProvider from a given Supplier.
Mono<RedisCredentials>	resolveCredentials() Returns RedisCredentials that can be used to authorize a Redis connection.
default boolean	supportsStreaming() Some implementations of the RedisCredentialsProvider may support streaming new credentials, based on some event that originates outside the driver.

Method Detail

resolveCredentials

Mono<RedisCredentials> resolveCredentials()

Returns RedisCredentials that can be used to authorize a Redis connection. Each implementation of RedisCredentialsProvider can choose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key management system, or load new credentials when credentials are rotated. If an error occurs during the loading of credentials or credentials could not be found, a runtime exception will be raised.

Returns:

a Mono emitting RedisCredentials that can be used to authorize a Redis connection.

from

static RedisCredentialsProvider from(Supplier<RedisCredentials> supplier)

Creates a new RedisCredentialsProvider from a given Supplier.

Parameters:

supplier - must not be null.

Returns:

the RedisCredentials using credentials from Supplier.

supportsStreaming

default boolean supportsStreaming()

Some implementations of the RedisCredentialsProvider may support streaming new credentials, based on some event that originates outside the driver. In this case they should indicate that so the RedisAuthenticationHandler is able to process these new credentials.

Returns:

whether the RedisCredentialsProvider supports streaming credentials.

credentials

default Flux<RedisCredentials> credentials()

Returns a Flux emitting RedisCredentials that can be used to authorize a Redis connection. For implementations that support streaming credentials (as indicated by supportsStreaming() returning true), this method can emit multiple credentials over time, typically based on external events like token renewal or rotation. For implementations that do not support streaming credentials (where supportsStreaming() returns false), this method throws an UnsupportedOperationException by default.

Returns:

a Flux emitting RedisCredentials, or throws an exception if streaming is not supported.

Throws:

UnsupportedOperationException - if the provider does not support streaming credentials.