Class RedisClusterConfiguration

java.lang.Object

org.springframework.data.redis.connection.RedisClusterConfiguration

All Implemented Interfaces:

RedisConfiguration, RedisConfiguration.ClusterConfiguration, RedisConfiguration.WithAuthentication, RedisConfiguration.WithPassword

public class RedisClusterConfiguration
extends Object
implements RedisConfiguration, RedisConfiguration.ClusterConfiguration

Configuration class used to set up a RedisConnection via RedisConnectionFactory for connecting to Redis Cluster. Useful when setting up a highly available Redis environment.

Since:

1.7

Author:

Christoph Strobl, Mark Paluch, John Blum

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	Description
RedisClusterConfiguration()	Creates a new, default RedisClusterConfiguration.
RedisClusterConfiguration(Collection<String> clusterNodes)	Creates a new RedisClusterConfiguration for given hostPort combinations.

Method Summary

Modifier and Type	Method	Description
void	addClusterNode(RedisNode node)	Add a cluster node to configuration.
RedisClusterConfiguration	clusterNode(String host, Integer port)
RedisClusterConfiguration	clusterNode(RedisNode node)
boolean	equals(@Nullable Object obj)
Set<RedisNode>	getClusterNodes()	Returns an Set of cluster nodes.
@Nullable Integer	getMaxRedirects()
RedisPassword	getPassword()	Get the RedisPassword to use when connecting.
@Nullable String	getUsername()	Get the username to use when connecting.
int	hashCode()
static RedisClusterConfiguration	of(PropertySource<?> propertySource)	Creates a new RedisClusterConfiguration looking up configuration values from the given PropertySource.
void	setClusterNodes(Iterable<RedisNode> nodes)	Set cluster nodes to connect to.
void	setMaxRedirects(int maxRedirects)
void	setPassword(RedisPassword password)	Create and set a RedisPassword for given String.
void	setUsername(@Nullable String username)	Create and set a username with the given String.

Methods inherited from class java.lang.Object

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

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

getDatabaseOrElse, getPasswordOrElse

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

setPassword, setPassword

Constructor Details

RedisClusterConfiguration

public RedisClusterConfiguration()

Creates a new, default RedisClusterConfiguration.

RedisClusterConfiguration

public RedisClusterConfiguration(Collection<String> clusterNodes)

Creates a new RedisClusterConfiguration for given hostPort combinations.

 clusterHostAndPorts[0] = 127.0.0.1:23679
 clusterHostAndPorts[1] = 127.0.0.1:23680 ...
 

Parameters:

clusterNodes - must not be null.

Method Details

of

public static RedisClusterConfiguration of(PropertySource<?> propertySource)

Creates a new RedisClusterConfiguration looking up configuration values from the given PropertySource.

 spring.redis.cluster.nodes=127.0.0.1:23679,127.0.0.1:23680,127.0.0.1:23681
 spring.redis.cluster.max-redirects=3
 

Parameters:

propertySource - must not be null.

Returns:

a new RedisClusterConfiguration configured from the given PropertySource.

Since:

3.3

setClusterNodes

public void setClusterNodes(Iterable<RedisNode> nodes)

Set cluster nodes to connect to.

Parameters:

nodes - must not be null.

getClusterNodes

public Set<RedisNode> getClusterNodes()

Description copied from interface: RedisConfiguration.ClusterConfiguration

Returns an Set of cluster nodes.

Specified by:

getClusterNodes in interface RedisConfiguration.ClusterConfiguration

Returns:

Set of cluster nodes. Never null.

addClusterNode

public void addClusterNode(RedisNode node)

Add a cluster node to configuration.

Parameters:

node - must not be null.

clusterNode

public RedisClusterConfiguration clusterNode(String host,
 Integer port)

Parameters:

host - Redis cluster node host name or ip address.

port - Redis cluster node port.

Returns:

this.

clusterNode

public RedisClusterConfiguration clusterNode(RedisNode node)

Returns:

this.

setMaxRedirects

public void setMaxRedirects(int maxRedirects)

Parameters:

maxRedirects - the max number of redirects to follow.

getMaxRedirects

public @Nullable Integer getMaxRedirects()

Specified by:

getMaxRedirects in interface RedisConfiguration.ClusterConfiguration

Returns:

max number of redirects to follow or null if not set.

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

public @Nullable 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.

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.

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.

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object