org.springframework.data.redis.connection

Class RedisSentinelConfiguration

java.lang.Object

org.springframework.data.redis.connection.RedisSentinelConfiguration

public class RedisSentinelConfiguration
extends Object

Configuration class used for setting up RedisConnection via RedisConnectionFactory using connecting to Redis Sentinel(s). Useful when setting up a high availability Redis environment.

Since:

1.4

Author:

Christoph Strobl, Thomas Darimont

Constructor Summary

Constructors

Constructor and Description
RedisSentinelConfiguration() Creates new RedisSentinelConfiguration.
RedisSentinelConfiguration(PropertySource<?> propertySource) Creates RedisSentinelConfiguration looking up values in given PropertySource.
RedisSentinelConfiguration(String master, Set<String> sentinelHostAndPorts) Creates RedisSentinelConfiguration for given hostPort combinations.

Method Summary

Modifier and Type	Method and Description
void	addSentinel(RedisNode sentinel) Add sentinel.
NamedNode	getMaster() Get the Sentinel master node.
Set<RedisNode>	getSentinels() Returns an Collections.unmodifiableSet(Set) of Sentinels.
RedisSentinelConfiguration	master(NamedNode master)
RedisSentinelConfiguration	master(String master)
RedisSentinelConfiguration	sentinel(RedisNode sentinel)
RedisSentinelConfiguration	sentinel(String host, Integer port)
void	setMaster(NamedNode master) Set the master.
void	setMaster(String name) Set the master node via its name.
void	setSentinels(Iterable<RedisNode> sentinels) Set Sentinels to connect to.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisSentinelConfiguration

public RedisSentinelConfiguration()

Creates new RedisSentinelConfiguration.

RedisSentinelConfiguration

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

Creates 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

public RedisSentinelConfiguration(PropertySource<?> propertySource)

Creates RedisSentinelConfiguration looking up values in 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 Detail

setSentinels

public void setSentinels(Iterable<RedisNode> sentinels)

Set Sentinels to connect to.

Parameters:

sentinels - must not be null.

getSentinels

public Set<RedisNode> getSentinels()

Returns an Collections.unmodifiableSet(Set) of Sentinels.

Returns:

Set of sentinels. Never null.

addSentinel

public void addSentinel(RedisNode sentinel)

Add sentinel.

Parameters:

sentinel - must not be null.

setMaster

public void setMaster(String name)

Set the master node via its name.

Parameters:

name - must not be null.

setMaster

public void setMaster(NamedNode master)

Set the master.

Parameters:

master - must not be null.

getMaster

public NamedNode getMaster()

Get the Sentinel master node.

Returns:

master

public RedisSentinelConfiguration master(String master)

Parameters:

master -

Returns:

See Also:

setMaster(String)

master

public RedisSentinelConfiguration master(NamedNode master)

Parameters:

master -

Returns:

See Also:

setMaster(NamedNode)

sentinel

public RedisSentinelConfiguration sentinel(RedisNode sentinel)

Parameters:

sentinel -

Returns:

See Also:

addSentinel(RedisNode)

sentinel

public RedisSentinelConfiguration sentinel(String host,
                                           Integer port)

Parameters:

host -

port -

Returns:

See Also:

sentinel(RedisNode)