Package org.springframework.data.redis.connection.lettuce

Class LettuceSentinelConnection

java.lang.Object

org.springframework.data.redis.connection.lettuce.LettuceSentinelConnection

All Implemented Interfaces:

Closeable, AutoCloseable, RedisSentinelCommands, RedisSentinelConnection

public class LettuceSentinelConnection
extends Object
implements RedisSentinelConnection

Since:

1.5

Author:

Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Modifier	Constructor	Description
	LettuceSentinelConnection(io.lettuce.core.RedisClient redisClient)	Creates a LettuceSentinelConnection using a supplied RedisClient.
protected	LettuceSentinelConnection(io.lettuce.core.sentinel.api.StatefulRedisSentinelConnection<String,String> connection)	Creates a LettuceSentinelConnection using a supplied redis connection.
	LettuceSentinelConnection(String host, int port)	Creates a LettuceSentinelConnection with a client for the supplied host and port.
	LettuceSentinelConnection(String host, int port, io.lettuce.core.resource.ClientResources clientResources)	Creates a LettuceSentinelConnection with a client for the supplied host and port and reuse existing ClientResources.
	LettuceSentinelConnection(LettuceConnectionProvider connectionProvider)	Creates a LettuceSentinelConnection using a LettuceConnectionProvider.
	LettuceSentinelConnection(RedisNode sentinel)	Creates a LettuceSentinelConnection with a dedicated client for a supplied RedisNode.

Method Summary

Modifier and Type	Method	Description
void	close()
void	failover(NamedNode master)	Force a failover as if the master was not reachable.
boolean	isOpen()
List<RedisServer>	masters()	Get a Collection of monitored masters and their state.
void	monitor(RedisServer server)	Tell sentinel to start monitoring a new master with the specified RedisNode.getName(), RedisNode.getHost(), RedisNode.getPort(), and RedisServer.getQuorum().
void	remove(String masterName)
void	remove(NamedNode master)	Removes given master.
List<RedisServer>	replicas(NamedNode master)	Show list of replicas for given master.
List<RedisServer>	slaves(String masterName)

Methods inherited from class java.lang.Object

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

Constructor Details

LettuceSentinelConnection

public LettuceSentinelConnection(RedisNode sentinel)

Creates a LettuceSentinelConnection with a dedicated client for a supplied RedisNode.

Parameters:

sentinel - The sentinel to connect to.

LettuceSentinelConnection

public LettuceSentinelConnection(String host,
 int port)

Creates a LettuceSentinelConnection with a client for the supplied host and port.

Parameters:

host - must not be null.

port - sentinel port.

LettuceSentinelConnection

public LettuceSentinelConnection(String host,
 int port,
 io.lettuce.core.resource.ClientResources clientResources)

Creates a LettuceSentinelConnection with a client for the supplied host and port and reuse existing ClientResources.

Parameters:

host - must not be null.

port - sentinel port.

clientResources - must not be null.

LettuceSentinelConnection

public LettuceSentinelConnection(io.lettuce.core.RedisClient redisClient)

Creates a LettuceSentinelConnection using a supplied RedisClient.

Parameters:

redisClient - must not be null.

LettuceSentinelConnection

protected LettuceSentinelConnection(io.lettuce.core.sentinel.api.StatefulRedisSentinelConnection<String,String> connection)

Creates a LettuceSentinelConnection using a supplied redis connection.

Parameters:

connection - native Lettuce connection, must not be null

LettuceSentinelConnection

public LettuceSentinelConnection(LettuceConnectionProvider connectionProvider)

Creates a LettuceSentinelConnection using a LettuceConnectionProvider.

Parameters:

connectionProvider - must not be null.

Since:

2.0

Method Details

failover

public void failover(NamedNode master)

Description copied from interface: RedisSentinelCommands

Force a failover as if the master was not reachable.

Specified by:

failover in interface RedisSentinelCommands

Parameters:

master - must not be null.

masters

public List<RedisServer> masters()

Description copied from interface: RedisSentinelCommands

Get a Collection of monitored masters and their state.

Specified by:

masters in interface RedisSentinelCommands

Returns:

Collection of RedisServers. Never null.

replicas

public List<RedisServer> replicas(NamedNode master)

Description copied from interface: RedisSentinelCommands

Show list of replicas for given master.

Specified by:

replicas in interface RedisSentinelCommands

Parameters:

master - must not be null.

Returns:

Collection of RedisServers. Never null.

slaves

public List<RedisServer> slaves(String masterName)

Parameters:

masterName -

Returns:

See Also:

• RedisSentinelCommands.replicas(org.springframework.data.redis.connection.NamedNode)

remove

public void remove(NamedNode master)

Description copied from interface: RedisSentinelCommands

Removes given master. The server will no longer be monitored and will no longer be returned by RedisSentinelCommands.masters().

Specified by:

remove in interface RedisSentinelCommands

Parameters:

master - must not be null.

remove

public void remove(String masterName)

Parameters:

masterName -

See Also:

• RedisSentinelCommands.remove(org.springframework.data.redis.connection.NamedNode)

monitor

public void monitor(RedisServer server)

Description copied from interface: RedisSentinelCommands

Tell sentinel to start monitoring a new master with the specified RedisNode.getName(), RedisNode.getHost(), RedisNode.getPort(), and RedisServer.getQuorum().

Specified by:

monitor in interface RedisSentinelCommands

Parameters:

server - must not be null.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface RedisSentinelConnection

Returns:

true if connected to server