Package org.springframework.data.redis.connection

Class RedisSentinelConfiguration

java.lang.Object

org.springframework.data.redis.connection.RedisSentinelConfiguration

All Implemented Interfaces:

RedisConfiguration, RedisConfiguration.SentinelConfiguration, RedisConfiguration.WithAuthentication, RedisConfiguration.WithDatabaseIndex, RedisConfiguration.WithPassword

public class RedisSentinelConfiguration
extends Object
implements RedisConfiguration, RedisConfiguration.SentinelConfiguration

Configuration class used to set up a RedisConnection with RedisConnectionFactory for connecting to Redis Sentinel(s). Useful when setting up a highly available Redis environment.

Since:

1.4

Author:

Christoph Strobl, Thomas Darimont, Mark Paluch, Vikas Garg, John Blum, Samuel Klose, Mustapha Zorgati

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
RedisSentinelConfiguration()	Creates a new, default RedisSentinelConfiguration.
RedisSentinelConfiguration(String master, Set<String> sentinelHostAndPorts)	Creates a new RedisSentinelConfiguration for given hostPort combinations.
RedisSentinelConfiguration(PropertySource<?> propertySource)	Deprecated. since 3.3, use of(PropertySource) instead.

Method Summary

Modifier and Type	Method	Description
void	addSentinel(RedisNode sentinel)	Add sentinel.
boolean	equals(Object obj)
int	getDatabase()	Get the database index to use.
NamedNode	getMaster()	Get the Sentinel master node.
RedisPassword	getPassword()	Get the RedisPassword to use when connecting.
RedisPassword	getSentinelPassword()	Returns the RedisPassword to use when connecting to a Redis Sentinel.
Set<RedisNode>	getSentinels()	Returns an Collections.unmodifiableSet(Set) of Sentinels.
String	getSentinelUsername()	Get the username to use when connecting.
String	getUsername()	Get the username to use when connecting.
int	hashCode()
RedisSentinelConfiguration	master(String master)
RedisSentinelConfiguration	master(NamedNode master)
static RedisSentinelConfiguration	of(PropertySource<?> propertySource)	Construct a new RedisSentinelConfiguration from the given PropertySource.
RedisSentinelConfiguration	sentinel(String host, Integer port)
RedisSentinelConfiguration	sentinel(RedisNode sentinel)
void	setDatabase(int index)	Set the database index to use.
void	setMaster(NamedNode master)	Set the master node.
void	setPassword(RedisPassword password)	Create and set a RedisPassword for given String.
void	setSentinelPassword(RedisPassword sentinelPassword)	Set a RedisPassword to be used when authenticating with Redis Sentinel.
void	setSentinels(Iterable<RedisNode> sentinels)	Set Sentinels to connect to.
void	setSentinelUsername(String sentinelUsername)	Create and set a username with the given String.
void	setUsername(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.SentinelConfiguration

getDataNodePassword, getDataNodeUsername, setMaster, setSentinelPassword, setSentinelPassword

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

setPassword, setPassword

Constructor Details

RedisSentinelConfiguration

public RedisSentinelConfiguration()

Creates a new, default RedisSentinelConfiguration.

RedisSentinelConfiguration

public RedisSentinelConfiguration(String master,
 Set<String> sentinelHostAndPorts)

Creates a new RedisSentinelConfiguration for given hostPort combinations.

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

Parameters:

sentinelHostAndPorts - must not be null.

Since:

1.5

RedisSentinelConfiguration

@Deprecated(since="3.3")
public RedisSentinelConfiguration(PropertySource<?> propertySource)

Deprecated.

since 3.3, use of(PropertySource) instead. This constructor will be made private in the next major release.

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

 spring.redis.sentinel.master=myMaster
 spring.redis.sentinel.nodes=127.0.0.1:23679,127.0.0.1:23680,127.0.0.1:23681
 

Parameters:

propertySource - must not be null.

Since:

1.5

Method Details

of

public static RedisSentinelConfiguration of(PropertySource<?> propertySource)

Construct a new RedisSentinelConfiguration from the given PropertySource.

Parameters:

propertySource - must not be null.

Returns:

a new RedisSentinelConfiguration configured from the given PropertySource.

Since:

3.3

setSentinels

public void setSentinels(Iterable<RedisNode> sentinels)

Set Sentinels to connect to.

Parameters:

sentinels - must not be null.

getSentinels

public Set<RedisNode> getSentinels()

Description copied from interface: RedisConfiguration.SentinelConfiguration

Returns an Collections.unmodifiableSet(Set) of Sentinels.

Specified by:

getSentinels in interface RedisConfiguration.SentinelConfiguration

Returns:

Set of sentinels. Never null.

addSentinel

public void addSentinel(RedisNode sentinel)

Add sentinel.

Parameters:

sentinel - must not be null.

setMaster

public void setMaster(NamedNode master)

Description copied from interface: RedisConfiguration.SentinelConfiguration

Set the master node.

Specified by:

setMaster in interface RedisConfiguration.SentinelConfiguration

Parameters:

master - must not be null.

getMaster

@Nullable
public NamedNode getMaster()

Description copied from interface: RedisConfiguration.SentinelConfiguration

Get the Sentinel master node.

Specified by:

getMaster in interface RedisConfiguration.SentinelConfiguration

Returns:

get the master node or null if not set.

master

public RedisSentinelConfiguration master(String master)

Parameters:

master - The master node name.

Returns:

this.

See Also:

• RedisConfiguration.SentinelConfiguration.setMaster(String)

master

public RedisSentinelConfiguration master(NamedNode master)

Parameters:

master - the master node

Returns:

this.

See Also:

• setMaster(NamedNode)

sentinel

public RedisSentinelConfiguration sentinel(RedisNode sentinel)

Parameters:

sentinel - the node to add as sentinel.

Returns:

this.

See Also:

• addSentinel(RedisNode)

sentinel

public RedisSentinelConfiguration sentinel(String host,
 Integer port)

Parameters:

host - redis sentinel node host name or ip.

port - redis sentinel port.

Returns:

this.

See Also:

• sentinel(RedisNode)

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.

getSentinelUsername

@Nullable
public String getSentinelUsername()

Description copied from interface: RedisConfiguration.SentinelConfiguration

Get the username to use when connecting.

Specified by:

getSentinelUsername in interface RedisConfiguration.SentinelConfiguration

Returns:

null if none set.

setSentinelUsername

public void setSentinelUsername(@Nullable
 String sentinelUsername)

Description copied from interface: RedisConfiguration.SentinelConfiguration

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

Specified by:

setSentinelUsername in interface RedisConfiguration.SentinelConfiguration

Parameters:

sentinelUsername - the username for sentinel.

setSentinelPassword

public void setSentinelPassword(RedisPassword sentinelPassword)

Description copied from interface: RedisConfiguration.SentinelConfiguration

Set a RedisPassword to be used when authenticating with Redis Sentinel.

Specified by:

setSentinelPassword in interface RedisConfiguration.SentinelConfiguration

Parameters:

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

getSentinelPassword

public RedisPassword getSentinelPassword()

Description copied from interface: RedisConfiguration.SentinelConfiguration

Returns the RedisPassword to use when connecting to a Redis Sentinel.
Can be set via RedisConfiguration.SentinelConfiguration.setSentinelPassword(RedisPassword) or RedisPassword.none() if no password has been set.

Specified by:

getSentinelPassword in interface RedisConfiguration.SentinelConfiguration

Returns:

the RedisPassword for authenticating with Redis Sentinel.

equals

public boolean equals(@Nullable
 Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object