org.springframework.data.redis.connection

Class RedisStaticMasterReplicaConfiguration

java.lang.Object

org.springframework.data.redis.connection.RedisStaticMasterReplicaConfiguration

All Implemented Interfaces:

RedisConfiguration, RedisConfiguration.StaticMasterReplicaConfiguration, RedisConfiguration.WithAuthentication, RedisConfiguration.WithDatabaseIndex, RedisConfiguration.WithPassword

public class RedisStaticMasterReplicaConfiguration
extends Object
implements RedisConfiguration, RedisConfiguration.StaticMasterReplicaConfiguration

Configuration class used for setting up RedisConnection via RedisConnectionFactory using the provided Master / Replica configuration to nodes know to not change address. Eg. when connecting to AWS ElastiCache with Read Replicas.
Note: Redis is undergoing a nomenclature change where the term replica is used synonymously to slave. Please also note that a Master/Replica connection cannot be used for Pub/Sub operations.

Since:

2.1

Author:

Mark Paluch, Christoph Strobl, Tamer Soliman

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.redis.connection.RedisConfiguration

RedisConfiguration.ClusterConfiguration, RedisConfiguration.DomainSocketConfiguration, RedisConfiguration.SentinelConfiguration, RedisConfiguration.StaticMasterReplicaConfiguration, RedisConfiguration.WithAuthentication, RedisConfiguration.WithDatabaseIndex, RedisConfiguration.WithDomainSocket, RedisConfiguration.WithHostAndPort, RedisConfiguration.WithPassword

Constructor Summary

Constructors

Constructor and Description
RedisStaticMasterReplicaConfiguration(String hostName) Create a new RedisConfiguration.StaticMasterReplicaConfiguration given hostName.
RedisStaticMasterReplicaConfiguration(String hostName, int port) Create a new RedisConfiguration.StaticMasterReplicaConfiguration given hostName and port.

Method Summary

Modifier and Type	Method and Description
void	addNode(String hostName, int port) Add a node to the list of nodes given hostName.
int	getDatabase() Get the database index to use.
List<RedisStandaloneConfiguration>	getNodes()
RedisPassword	getPassword() Get the RedisPassword to use when connecting.
String	getUsername() Get the username to use when connecting.
RedisStaticMasterReplicaConfiguration	node(String hostName) Add a node to the list of nodes given hostName.
RedisStaticMasterReplicaConfiguration	node(String hostName, int port) Add a node to the list of nodes given hostName and port.
void	setDatabase(int index) Set the database index to use.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.redis.connection.RedisConfiguration

getDatabaseOrElse, getDatabaseOrElse, getHostOrElse, getPasswordOrElse, getPasswordOrElse, getPortOrElse, getUsernameOrElse, isAuthenticationAware, isClusterConfiguration, isDatabaseIndexAware, isDomainSocketConfiguration, isHostAndPortAware, isSentinelConfiguration, isStaticMasterReplicaConfiguration

Methods inherited from interface org.springframework.data.redis.connection.RedisConfiguration.WithAuthentication

setPassword, setPassword

Constructor Detail

RedisStaticMasterReplicaConfiguration

public RedisStaticMasterReplicaConfiguration(String hostName)

Create a new RedisConfiguration.StaticMasterReplicaConfiguration given hostName.

Parameters:

hostName - must not be null or empty.

RedisStaticMasterReplicaConfiguration

public RedisStaticMasterReplicaConfiguration(String hostName,
                                             int port)

Create a new RedisConfiguration.StaticMasterReplicaConfiguration given hostName and port.

Parameters:

hostName - must not be null or empty.

port - a valid TCP port (1-65535).

Method Detail

addNode

public void addNode(String hostName,
                    int port)

Add a node to the list of nodes given hostName.

Parameters:

hostName - must not be null or empty.

port - a valid TCP port (1-65535).

node

public RedisStaticMasterReplicaConfiguration node(String hostName)

Add a node to the list of nodes given hostName.

Parameters:

hostName - must not be null or empty.

Returns:

this RedisConfiguration.StaticMasterReplicaConfiguration.

node

public RedisStaticMasterReplicaConfiguration node(String hostName,
                                                  int port)

Add a node to the list of nodes given hostName and port.

Parameters:

hostName - must not be null or empty.

port - a valid TCP port (1-65535).

Returns:

this RedisConfiguration.StaticMasterReplicaConfiguration.

getDatabase

public int getDatabase()

Description copied from interface: RedisConfiguration.WithDatabaseIndex

Get the database index to use.

Specified by:

getDatabase in interface RedisConfiguration.WithDatabaseIndex

Returns:

zero by default.

setDatabase

public void setDatabase(int index)

Description copied from interface: RedisConfiguration.WithDatabaseIndex

Set the database index to use.

Specified by:

setDatabase in interface RedisConfiguration.WithDatabaseIndex

setUsername

public void setUsername(@Nullable
                        String username)

Description copied from interface: RedisConfiguration.WithAuthentication

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

Specified by:

setUsername in interface RedisConfiguration.WithAuthentication

Parameters:

username - the username.

getUsername

@Nullable
public String getUsername()

Description copied from interface: RedisConfiguration.WithAuthentication

Get the username to use when connecting.

Specified by:

getUsername in interface RedisConfiguration.WithAuthentication

Returns:

null if none set.

getPassword

public RedisPassword getPassword()

Description copied from interface: RedisConfiguration.WithAuthentication

Get the RedisPassword to use when connecting.

Specified by:

getPassword in interface RedisConfiguration.WithAuthentication

Returns:

RedisPassword.none() if none set.

setPassword

public void setPassword(RedisPassword password)

Description copied from interface: RedisConfiguration.WithAuthentication

Create and set a RedisPassword for given String.

Specified by:

setPassword in interface RedisConfiguration.WithAuthentication

Parameters:

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

getNodes

public List<RedisStandaloneConfiguration> getNodes()

Specified by:

getNodes in interface RedisConfiguration.StaticMasterReplicaConfiguration

Returns:

unmodifiable List of nodes.