redis.clients.jedis

Class MultiDbConfig.Builder

java.lang.Object

redis.clients.jedis.MultiDbConfig.Builder

Enclosing class:

MultiDbConfig

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

Builder class for creating MultiDbConfig instances with comprehensive configuration options.

The Builder provides a fluent API for configuring all aspects of multi-database failover behavior, including retry logic, circuit breaker settings, and failback mechanisms. It uses sensible defaults based on production best practices while allowing fine-tuning for specific requirements.

See Also:

MultiDbConfig, MultiDbConfig.DatabaseConfig

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs a new Builder with the specified database configurations.
Builder(java.util.List<MultiDbConfig.DatabaseConfig> databaseConfigs) Constructs a new Builder with the specified database configurations.
Builder(MultiDbConfig.DatabaseConfig[] databaseConfigs) Constructs a new Builder with the specified database configurations.

Method Summary

Modifier and Type	Method and Description
MultiDbConfig	build() Builds and returns a new MultiDbConfig instance with all configured settings.
MultiDbConfig.Builder	commandRetry(MultiDbConfig.RetryConfig commandRetry) Sets the encapsulated retry configuration for command execution.
MultiDbConfig.Builder	database(Endpoint endpoint, float weight, JedisClientConfig clientConfig) Adds a database endpoint with custom client configuration.
MultiDbConfig.Builder	database(MultiDbConfig.DatabaseConfig databaseConfig) Adds a pre-configured database configuration.
MultiDbConfig.Builder	delayInBetweenFailoverAttempts(int delayInBetweenFailoverAttempts) Sets the delay in milliseconds between failover attempts.
MultiDbConfig.Builder	failbackCheckInterval(long failbackCheckInterval) Sets the interval between checks for failback opportunities to recovered databases.
MultiDbConfig.Builder	failbackSupported(boolean supported) Sets whether automatic failback to higher-priority databases is supported.
MultiDbConfig.Builder	failureDetector(MultiDbConfig.CircuitBreakerConfig failureDetector) Sets the encapsulated circuit breaker configuration for failure detection.
MultiDbConfig.Builder	fallbackExceptionList(java.util.List<java.lang.Class<? extends java.lang.Throwable>> fallbackExceptionList) Sets the list of exception classes that trigger immediate fallback to the next available database.
MultiDbConfig.Builder	fastFailover(boolean fastFailover) Sets whether to forcefully terminate connections during failover for faster database switching.
MultiDbConfig.Builder	gracePeriod(long gracePeriod) Sets the grace period to keep databases disabled after they become unhealthy.
MultiDbConfig.Builder	maxNumFailoverAttempts(int maxNumFailoverAttempts) Sets the maximum number of failover attempts.
MultiDbConfig.Builder	retryOnFailover(boolean retryOnFailover) Sets whether failed commands should be retried during the failover process.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructs a new Builder with the specified database configurations.

Builder

public Builder(MultiDbConfig.DatabaseConfig[] databaseConfigs)

Constructs a new Builder with the specified database configurations.

Parameters:

databaseConfigs - array of database configurations defining available Redis endpoints

Throws:

JedisValidationException - if databaseConfigs is null or empty

Builder

public Builder(java.util.List<MultiDbConfig.DatabaseConfig> databaseConfigs)

Constructs a new Builder with the specified database configurations.

Parameters:

databaseConfigs - list of database configurations defining available Redis endpoints

Throws:

JedisValidationException - if databaseConfigs is null or empty

Method Detail

database

public MultiDbConfig.Builder database(MultiDbConfig.DatabaseConfig databaseConfig)

Adds a pre-configured database configuration.

This method allows adding a fully configured DatabaseConfig instance, providing maximum flexibility for advanced configurations including custom health check strategies, connection pool settings, etc.

Parameters:

databaseConfig - the pre-configured database configuration

Returns:

this builder

database

public MultiDbConfig.Builder database(Endpoint endpoint,
                                      float weight,
                                      JedisClientConfig clientConfig)

Adds a database endpoint with custom client configuration.

This method allows specifying database-specific configuration such as authentication, SSL settings, timeouts, etc. This configuration will override the default client configuration for this specific database endpoint.

Parameters:

endpoint - the Redis server endpoint

weight - the weight for this endpoint (higher values = higher priority)

clientConfig - the client configuration for this endpoint

Returns:

this builder

commandRetry

public MultiDbConfig.Builder commandRetry(MultiDbConfig.RetryConfig commandRetry)

Sets the encapsulated retry configuration for command execution.

This provides a cleaner API for configuring retry behavior by using a dedicated MultiDbConfig.RetryConfig object.

Parameters:

commandRetry - the retry configuration

Returns:

this builder instance for method chaining

See Also:

MultiDbConfig.RetryConfig

failureDetector

public MultiDbConfig.Builder failureDetector(MultiDbConfig.CircuitBreakerConfig failureDetector)

Sets the encapsulated circuit breaker configuration for failure detection.

This provides a cleaner API for configuring circuit breaker behavior by using a dedicated MultiDbConfig.CircuitBreakerConfig object.

Parameters:

failureDetector - the circuit breaker configuration

Returns:

this builder instance for method chaining

See Also:

MultiDbConfig.CircuitBreakerConfig

fallbackExceptionList

public MultiDbConfig.Builder fallbackExceptionList(java.util.List<java.lang.Class<? extends java.lang.Throwable>> fallbackExceptionList)

Sets the list of exception classes that trigger immediate fallback to the next available database.

When these exceptions occur, the system will immediately attempt to failover to the next available database without waiting for circuit breaker thresholds. This enables fast failover for specific error conditions.

Default exceptions:

• CallNotPermittedException - Circuit breaker is open
• ConnectionFailoverException - Connection-level failover required

Parameters:

fallbackExceptionList - list of exception classes that trigger immediate fallback

Returns:

this builder instance for method chaining

retryOnFailover

public MultiDbConfig.Builder retryOnFailover(boolean retryOnFailover)

Sets whether failed commands should be retried during the failover process.

When enabled, commands that fail during failover will be retried according to the configured retry settings on the new database. When disabled, failed commands during failover will immediately return the failure to the caller.

Trade-offs:

• Enabled: Better resilience, potentially longer response times
• Disabled: Faster failover, some operations may fail (default)

Parameters:

retryOnFailover - true to retry failed commands during failover, false otherwise

Returns:

this builder instance for method chaining

failbackSupported

public MultiDbConfig.Builder failbackSupported(boolean supported)

Sets whether automatic failback to higher-priority databases is supported.

When enabled, the system will automatically monitor failed da using health checks and failback to higher-priority (higher weight) databases when they recover. When disabled, failback must be triggered manually.

Requirements for automatic failback:

• Health checks must be enabled on database configurations
• Grace period must elapse after database becomes unhealthy
• Higher-priority database must pass health checks

Parameters:

supported - true to enable automatic failback, false for manual failback only

Returns:

this builder instance for method chaining

failbackCheckInterval

public MultiDbConfig.Builder failbackCheckInterval(long failbackCheckInterval)

Sets the interval between checks for failback opportunities to recovered databases.

This controls how frequently the system checks if a higher-priority database has recovered and is available for failback. Lower values provide faster failback response but increase monitoring overhead.

Typical Values:

• 1-2 seconds: Fast failback for critical applications
• 5 seconds: Balanced approach (default)
• 10-30 seconds: Conservative monitoring for stable environments

Parameters:

failbackCheckInterval - interval in milliseconds between failback checks

Returns:

this builder instance for method chaining

gracePeriod

public MultiDbConfig.Builder gracePeriod(long gracePeriod)

Sets the grace period to keep databases disabled after they become unhealthy.

After a database is marked as unhealthy, it remains disabled for this grace period before being eligible for failback, even if health checks indicate recovery. This prevents rapid oscillation between databases during intermittent failures.

Considerations:

• Short periods (5-10s): Faster recovery, risk of oscillation
• Medium periods (10-30s): Balanced stability (default: 10s)
• Long periods (60s+): Maximum stability, slower recovery

Parameters:

gracePeriod - grace period in milliseconds

Returns:

this builder instance for method chaining

fastFailover

public MultiDbConfig.Builder fastFailover(boolean fastFailover)

Sets whether to forcefully terminate connections during failover for faster database switching.

When enabled, existing connections to the failed database are immediately closed during failover, potentially reducing failover time but may cause some in-flight operations to fail. When disabled, connections are closed gracefully.

Trade-offs:

• Enabled: Faster failover, potential operation failures
• Disabled: Graceful failover, potentially slower (default)

Parameters:

fastFailover - true for fast failover, false for graceful failover

Returns:

this builder instance for method chaining

maxNumFailoverAttempts

public MultiDbConfig.Builder maxNumFailoverAttempts(int maxNumFailoverAttempts)

Sets the maximum number of failover attempts.

This setting controls how many times the system will attempt to failover to a different database before giving up. For example, if set to 3, the system will make 1 initial attempt plus 2 failover attempts for a total of 3 attempts.

Default:

Parameters:

maxNumFailoverAttempts - maximum number of failover attempts

Returns:

this builder instance for method chaining

delayInBetweenFailoverAttempts

public MultiDbConfig.Builder delayInBetweenFailoverAttempts(int delayInBetweenFailoverAttempts)

Sets the delay in milliseconds between failover attempts.

This setting controls how long the system will wait before attempting to failover to a different database. For example, if set to 1000, the system will wait 1 second before attempting to failover to a different database.

Default: milliseconds

Parameters:

delayInBetweenFailoverAttempts - delay in milliseconds between failover attempts

Returns:

this builder instance for method chaining

build

public MultiDbConfig build()

Builds and returns a new MultiDbConfig instance with all configured settings.

This method creates the final configuration object by copying all builder settings to the configuration instance. The builder can be reused after calling build() to create additional configurations with different settings.

Returns:

a new MultiDbConfig instance with the configured settings