io.lettuce.core.failover.api

Interface BaseRedisMultiDbConnection

All Known Subinterfaces:

StatefulRedisMultiDbConnection<K,V>, StatefulRedisMultiDbPubSubConnection<K,V>

All Known Implementing Classes:

StatefulRedisMultiDbConnectionImpl, StatefulRedisMultiDbPubSubConnectionImpl

@Experimental
public interface BaseRedisMultiDbConnection

Since:

7.4

Author:

Ali Takavci

Method Summary

Modifier and Type	Method and Description
void	addDatabase(DatabaseConfig databaseConfig) Add a new database to the multi-database connection.
void	addDatabase(RedisURI redisURI, float weight) Add a new database to the multi-database connection.
CircuitBreaker	getCircuitBreaker(RedisURI endpoint) Get the circuit breaker for a specific endpoint.
RedisURI	getCurrentEndpoint() Get the current database endpoint.
Iterable<RedisURI>	getEndpoints() Get all available database endpoints.
boolean	isHealthy(RedisURI endpoint) Check if an endpoint is healthy (health status is HEALTHY and circuit breaker is CLOSED).
void	removeDatabase(RedisURI redisURI) Remove a database from the multi-database connection.
void	switchToDatabase(RedisURI redisURI) Switch to a different database.

Method Detail

switchToDatabase

void switchToDatabase(RedisURI redisURI)

Switch to a different database.

Parameters:

redisURI - the Redis URI of the database to switch to, must not be null

Throws:

IllegalArgumentException - if the database does not exist

getCurrentEndpoint

RedisURI getCurrentEndpoint()

Get the current database endpoint.

Returns:

the current database endpoint

getEndpoints

Iterable<RedisURI> getEndpoints()

Get all available database endpoints.

Returns:

an iterable of all database endpoints

isHealthy

boolean isHealthy(RedisURI endpoint)

Check if an endpoint is healthy (health status is HEALTHY and circuit breaker is CLOSED).

Parameters:

endpoint - the Redis endpoint URI

Returns:

true if the endpoint is healthy (HEALTHY status and CLOSED circuit breaker), false otherwise

Throws:

IllegalArgumentException - if the endpoint is not known

getCircuitBreaker

CircuitBreaker getCircuitBreaker(RedisURI endpoint)

Get the circuit breaker for a specific endpoint.

Parameters:

endpoint - the Redis endpoint URI

Returns:

the circuit breaker for the endpoint

Throws:

IllegalArgumentException - if the endpoint is not known

addDatabase

void addDatabase(RedisURI redisURI,
                 float weight)

Add a new database to the multi-database connection.

Parameters:

redisURI - the Redis URI for the new database, must not be null

weight - the weight for load balancing, must be greater than 0

Throws:

IllegalArgumentException - if the database already exists or parameters are invalid

addDatabase

void addDatabase(DatabaseConfig databaseConfig)

Add a new database to the multi-database connection.

Parameters:

databaseConfig - the database configuration, must not be null

Throws:

IllegalArgumentException - if the database already exists or configuration is invalid

removeDatabase

void removeDatabase(RedisURI redisURI)

Remove a database from the multi-database connection.

Parameters:

redisURI - the Redis URI of the database to remove, must not be null

Throws:

IllegalArgumentException - if the database does not exist

UnsupportedOperationException - if attempting to remove the currently active database