Package io.lettuce.core

Class StaticCredentialsProvider

java.lang.Object

io.lettuce.core.StaticCredentialsProvider

All Implemented Interfaces:

RedisCredentialsProvider, RedisCredentialsProvider.ImmediateRedisCredentialsProvider

public class StaticCredentialsProvider
extends Object
implements RedisCredentialsProvider, RedisCredentialsProvider.ImmediateRedisCredentialsProvider

Static implementation of RedisCredentialsProvider.

Since:

6.2

Author:

Mark Paluch

Nested Class Summary

Nested classes/interfaces inherited from interface io.lettuce.core.RedisCredentialsProvider

RedisCredentialsProvider.ImmediateRedisCredentialsProvider

Constructor Summary

Constructors

Constructor	Description
StaticCredentialsProvider(RedisCredentials credentials)	Create a static StaticCredentialsProvider object from RedisCredentials.
StaticCredentialsProvider(String username, char[] password)	Create a static StaticCredentialsProvider object from username and password.

Method Summary

Modifier and Type	Method	Description
Mono<RedisCredentials>	resolveCredentials()	Returns RedisCredentials that can be used to authorize a Redis connection.
RedisCredentials	resolveCredentialsNow()	Returns RedisCredentials that can be used to authorize a Redis connection.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticCredentialsProvider

public StaticCredentialsProvider(String username,
                                 char[] password)

Create a static StaticCredentialsProvider object from username and password.

Parameters:

username - can be null.

password - can be null.

StaticCredentialsProvider

public StaticCredentialsProvider(RedisCredentials credentials)

Create a static StaticCredentialsProvider object from RedisCredentials. The snapshot of the given credentials is used to create a static representation to avoid credentials changes if the RedisCredentials change over time.

Parameters:

credentials - must not be null.

Method Detail

resolveCredentials

public Mono<RedisCredentials> resolveCredentials()

Description copied from interface: RedisCredentialsProvider

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.

Specified by:

resolveCredentials in interface RedisCredentialsProvider

Specified by:

resolveCredentials in interface RedisCredentialsProvider.ImmediateRedisCredentialsProvider

Returns:

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

resolveCredentialsNow

public RedisCredentials resolveCredentialsNow()

Description copied from interface: RedisCredentialsProvider.ImmediateRedisCredentialsProvider

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.

Specified by:

resolveCredentialsNow in interface RedisCredentialsProvider.ImmediateRedisCredentialsProvider

Returns:

the resolved RedisCredentials that can be used to authorize a Redis connection.