redis.clients.jedis

Class MultiDbConfig.DatabaseConfig

java.lang.Object

redis.clients.jedis.MultiDbConfig.DatabaseConfig

Enclosing class:

MultiDbConfig

public static class MultiDbConfig.DatabaseConfig
extends java.lang.Object

Configuration class for individual Redis database endpoints within a multi-database setup.

Each DatabaseConfig represents a single Redis endpoint that can participate in the multi-database failover system. It encapsulates the connection details, weight for priority-based selection, and health check configuration for that endpoint.

See Also:

MultiDbConfig.DatabaseConfig.Builder, MultiDbConfig.StrategySupplier, HealthCheckStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiDbConfig.DatabaseConfig.Builder Builder class for creating DatabaseConfig instances with fluent configuration API.

Constructor Summary

Constructors

Constructor and Description
DatabaseConfig(Endpoint endpoint, JedisClientConfig clientConfig) Constructs a DatabaseConfig with basic endpoint and client configuration.
DatabaseConfig(Endpoint endpoint, JedisClientConfig clientConfig, org.apache.commons.pool2.impl.GenericObjectPoolConfig<Connection> connectionPoolConfig) Constructs a DatabaseConfig with endpoint, client, and connection pool configuration.

Method Summary

Modifier and Type	Method and Description
static MultiDbConfig.DatabaseConfig.Builder	builder(Endpoint endpoint, JedisClientConfig clientConfig) Creates a new Builder instance for configuring a DatabaseConfig.
org.apache.commons.pool2.impl.GenericObjectPoolConfig<Connection>	getConnectionPoolConfig() Returns the connection pool configuration for this database.
Endpoint	getEndpoint() Returns the Redis endpoint (host and port) for this database.
MultiDbConfig.StrategySupplier	getHealthCheckStrategySupplier() Returns the health check strategy supplier for this database.
JedisClientConfig	getJedisClientConfig() Returns the Jedis client configuration for this database.
float	getWeight() Returns the weight value used for database selection priority.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseConfig

public DatabaseConfig(Endpoint endpoint,
                      JedisClientConfig clientConfig)

Constructs a DatabaseConfig with basic endpoint and client configuration.

This constructor creates a database configuration with default settings: weight of 1.0f and PingStrategy for health checks. Use the MultiDbConfig.DatabaseConfig.Builder for more advanced configuration options.

Parameters:

endpoint - the Redis endpoint (host and port)

clientConfig - the Jedis client configuration

Throws:

java.lang.IllegalArgumentException - if endpoint or clientConfig is null

DatabaseConfig

public DatabaseConfig(Endpoint endpoint,
                      JedisClientConfig clientConfig,
                      org.apache.commons.pool2.impl.GenericObjectPoolConfig<Connection> connectionPoolConfig)

Constructs a DatabaseConfig with endpoint, client, and connection pool configuration.

This constructor allows specification of connection pool settings in addition to basic endpoint configuration. Default weight of 1.0f and PingStrategy for health checks are used.

Parameters:

endpoint - the Redis endpoint (host and port)

clientConfig - the Jedis client configuration

connectionPoolConfig - the connection pool configuration

Throws:

java.lang.IllegalArgumentException - if endpoint or clientConfig is null

Method Detail

getEndpoint

public Endpoint getEndpoint()

Returns the Redis endpoint (host and port) for this database.

Returns:

the host and port information

builder

public static MultiDbConfig.DatabaseConfig.Builder builder(Endpoint endpoint,
                                                           JedisClientConfig clientConfig)

Creates a new Builder instance for configuring a DatabaseConfig.

Parameters:

endpoint - the Redis endpoint (host and port)

clientConfig - the Jedis client configuration

Returns:

new Builder instance

Throws:

java.lang.IllegalArgumentException - if endpoint or clientConfig is null

getJedisClientConfig

public JedisClientConfig getJedisClientConfig()

Returns the Jedis client configuration for this database.

Returns:

the client configuration containing connection settings and authentication

getConnectionPoolConfig

public org.apache.commons.pool2.impl.GenericObjectPoolConfig<Connection> getConnectionPoolConfig()

Returns the connection pool configuration for this database.

Returns:

the connection pool configuration, may be null if not specified

getWeight

public float getWeight()

Returns the weight value used for database selection priority.

Higher weight values indicate higher priority. During failover, databases are selected in descending order of weight (highest weight first).

Returns:

the weight value, default is 1.0f

getHealthCheckStrategySupplier

public MultiDbConfig.StrategySupplier getHealthCheckStrategySupplier()

Returns the health check strategy supplier for this database.

The strategy supplier is used to create health check instances that monitor this database's availability. Returns null if health checks are disabled.

Returns:

the health check strategy supplier, or null if health checks are disabled

See Also:

MultiDbConfig.StrategySupplier, HealthCheckStrategy