Package org.springframework.data.redis.connection

Interface RedisConfiguration.WithAuthentication

All Known Subinterfaces:

RedisConfiguration.ClusterConfiguration, RedisConfiguration.DomainSocketConfiguration, RedisConfiguration.SentinelConfiguration, RedisConfiguration.StaticMasterReplicaConfiguration, RedisConfiguration.WithPassword

All Known Implementing Classes:

RedisClusterConfiguration, RedisSentinelConfiguration, RedisSocketConfiguration, RedisStandaloneConfiguration, RedisStaticMasterReplicaConfiguration

Enclosing interface:

RedisConfiguration

public static interface RedisConfiguration.WithAuthentication

RedisConfiguration part suitable for configurations that may use authentication when connecting.

Since:

2.4

Author:

Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method	Description
RedisPassword	getPassword()	Get the RedisPassword to use when connecting.
String	getUsername()	Get the username to use when connecting.
default void	setPassword(char[] password)	Create and set a RedisPassword for given String.
default void	setPassword(String password)	Create and set a RedisPassword for given String.
void	setPassword(RedisPassword password)	Create and set a RedisPassword for given String.
void	setUsername(String username)	Create and set a username with the given String.

Method Details

setUsername

void setUsername(@Nullable
 String username)

Create and set a username with the given String. Requires Redis 6 or newer.

Parameters:

username - the username.

getUsername

@Nullable
String getUsername()

Get the username to use when connecting.

Returns:

null if none set.

setPassword

default void setPassword(@Nullable
 String password)

Create and set a RedisPassword for given String.

Parameters:

password - can be null.

setPassword

default void setPassword(@Nullable
 char[] password)

Create and set a RedisPassword for given String.

Parameters:

password - can be null.

setPassword

void setPassword(RedisPassword password)

Create and set a RedisPassword for given String.

Parameters:

password - must not be null use RedisPassword.none() instead.

getPassword

RedisPassword getPassword()

Get the RedisPassword to use when connecting.

Returns:

RedisPassword.none() if none set.