redis.clients.jedis

Class MultiDbConfig.DatabaseConfig.Builder

java.lang.Object

redis.clients.jedis.MultiDbConfig.DatabaseConfig.Builder

Enclosing class:

MultiDbConfig.DatabaseConfig

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

Builder class for creating DatabaseConfig instances with fluent configuration API.

The Builder provides a convenient way to configure database settings including connection pooling, weight-based priority, and health check strategies. All configuration methods return the builder instance for method chaining.

Default Values:

• Weight: 1.0f (standard priority)
• Health Check: PingStrategy.DEFAULT
• Connection Pool: null (uses default pooling)

Constructor Summary

Constructors

Constructor and Description
Builder(Endpoint endpoint, JedisClientConfig clientConfig) Constructs a new Builder with required endpoint and client configuration.

Method Summary

Modifier and Type	Method and Description
MultiDbConfig.DatabaseConfig	build() Builds and returns a new DatabaseConfig instance with the configured settings.
MultiDbConfig.DatabaseConfig.Builder	connectionPoolConfig(org.apache.commons.pool2.impl.GenericObjectPoolConfig<Connection> connectionPoolConfig) Sets the connection pool configuration for this database.
MultiDbConfig.DatabaseConfig.Builder	healthCheckEnabled(boolean healthCheckEnabled) Enables or disables health checks for this database.
MultiDbConfig.DatabaseConfig.Builder	healthCheckStrategy(HealthCheckStrategy healthCheckStrategy) Sets a specific health check strategy instance for this database.
MultiDbConfig.DatabaseConfig.Builder	healthCheckStrategySupplier(MultiDbConfig.StrategySupplier healthCheckStrategySupplier) Sets a custom health check strategy supplier for this database.
MultiDbConfig.DatabaseConfig.Builder	weight(float weight) Sets the weight value for database selection priority.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(Endpoint endpoint,
               JedisClientConfig clientConfig)

Constructs a new Builder with required endpoint and client configuration.

Parameters:

endpoint - the Redis endpoint (host and port)

clientConfig - the Jedis client configuration

Throws:

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

Method Detail

connectionPoolConfig

public MultiDbConfig.DatabaseConfig.Builder connectionPoolConfig(org.apache.commons.pool2.impl.GenericObjectPoolConfig<Connection> connectionPoolConfig)

Sets the connection pool configuration for this database.

Connection pooling helps manage connections efficiently and provides better performance under load. If not specified, default pooling behavior will be used.

Parameters:

connectionPoolConfig - the connection pool configuration

Returns:

this builder instance for method chaining

weight

public MultiDbConfig.DatabaseConfig.Builder weight(float weight)

Sets the weight value for database selection priority.

Weight determines the priority order for database selection during failover. Databases with higher weights are preferred over those with lower weights. The system will attempt to use the highest-weight healthy database available.

Examples:

• 1.0f: Standard priority (default)
• 0.8f: Lower priority (secondary database)
• 0.1f: Lowest priority (backup database)

Parameters:

weight - the weight value for priority-based selection

Returns:

this builder instance for method chaining

healthCheckStrategySupplier

public MultiDbConfig.DatabaseConfig.Builder healthCheckStrategySupplier(MultiDbConfig.StrategySupplier healthCheckStrategySupplier)

Sets a custom health check strategy supplier for this database.

The strategy supplier creates health check instances that monitor this database's availability. Different databases can use different health check strategies based on their specific requirements.

Parameters:

healthCheckStrategySupplier - the health check strategy supplier

Returns:

this builder instance for method chaining

Throws:

java.lang.IllegalArgumentException - if healthCheckStrategySupplier is null

See Also:

MultiDbConfig.StrategySupplier, HealthCheckStrategy

healthCheckStrategy

public MultiDbConfig.DatabaseConfig.Builder healthCheckStrategy(HealthCheckStrategy healthCheckStrategy)

Sets a specific health check strategy instance for this database.

This is a convenience method that wraps the provided strategy in a supplier that always returns the same instance. Use this when you have a pre-configured strategy instance.

Note: The same strategy instance will be reused, so ensure it's thread-safe if multiple databases might use it.

Parameters:

healthCheckStrategy - the health check strategy instance

Returns:

this builder instance for method chaining

Throws:

java.lang.IllegalArgumentException - if healthCheckStrategy is null

See Also:

#healthCheckStrategySupplier(StrategySupplier)

healthCheckEnabled

public MultiDbConfig.DatabaseConfig.Builder healthCheckEnabled(boolean healthCheckEnabled)

Enables or disables health checks for this database.

When health checks are disabled (false), the database will not be proactively monitored for availability. This means:

• No background health check threads will be created
• Failback to this database must be triggered manually
• The database is assumed to be healthy unless circuit breaker opens

When health checks are enabled (true) and no strategy supplier was previously set, the default PingStrategy.DEFAULT will be used.

Parameters:

healthCheckEnabled - true to enable health checks, false to disable

Returns:

this builder instance for method chaining

build

public MultiDbConfig.DatabaseConfig build()

Builds and returns a new DatabaseConfig instance with the configured settings.

Returns:

a new DatabaseConfig instance