redis.clients.jedis.builders

Class MultiDbClientBuilder<C>

java.lang.Object

redis.clients.jedis.builders.AbstractClientBuilder<MultiDbClientBuilder<C>,C>

redis.clients.jedis.builders.MultiDbClientBuilder<C>

Type Parameters:

C - the client type that this builder creates

Direct Known Subclasses:

MultiDbClient.Builder

@Experimental
public abstract class MultiDbClientBuilder<C>
extends AbstractClientBuilder<MultiDbClientBuilder<C>,C>

Builder for creating multi-db Redis clients with multi-endpoint support.

This builder provides methods specific to multi-db Redis deployments, including multiple weighted endpoints, circuit breaker configuration, health checks, and automatic failover/failback capabilities.

Key Features:

• Multi-Endpoint Configuration: Add multiple Redis endpoints with individual weights
• Circuit Breaker Integration: Built-in circuit breaker with configurable thresholds
• Health Monitoring: Automatic health checks with configurable strategies
• Event Handling: Listen to database switch events for monitoring and alerting
• Flexible Configuration: Support for both simple and advanced multi-database configurations

Usage Examples:

 MultiDbClient client = MultiDbClient.builder()
                 .multiDbConfig(
                         MultiDbConfig.builder()
                                 .database(
                                         DatabaseConfig.builder(
                                                         east,
                                                         DefaultJedisClientConfig.builder().credentials(credentialsEast).build())
                                                 .weight(100.0f)
                                                 .build())
                                 .database(DatabaseConfig.builder(
                                                 west,
                                                 DefaultJedisClientConfig.builder().credentials(credentialsWest).build())
                                         .weight(50.0f).build())
                                 .failureDetector(MultiDbConfig.CircuitBreakerConfig.builder()
                                         .failureRateThreshold(50.0f)
                                         .build())
                                 .commandRetry(MultiDbConfig.RetryConfig.builder()
                                         .maxAttempts(3)
                                         .build())
                                 .build()
                 )
                 .databaseSwitchListener(event ->
                     System.out.println("Switched to: " + event.getEndpoint()))
                 .build();
 

Since:

7.0.0

Author:

Ivo Gaydazhiev

Field Summary

Fields inherited from class redis.clients.jedis.builders.AbstractClientBuilder

cache, cacheConfig, clientConfig, commandExecutor, commandObjects, connectionProvider, jsonObjectMapper, keyPreProcessor, poolConfig, searchDialect

Constructor Summary

Constructors

Constructor and Description
MultiDbClientBuilder()

Method Summary

Modifier and Type	Method and Description
protected CommandExecutor	createDefaultCommandExecutor() Creates a default command executor based on the current configuration.
protected ConnectionProvider	createDefaultConnectionProvider() Creates a default connection provider based on the current configuration.
MultiDbClientBuilder<C>	databaseSwitchListener(java.util.function.Consumer<DatabaseSwitchEvent> listener) Sets a listener for database switch events.
MultiDbClientBuilder<C>	multiDbConfig(MultiDbConfig config) Sets the multi-database configuration.
protected MultiDbClientBuilder<C>	self() Returns the concrete builder instance for method chaining.
protected void	validateSpecificConfiguration() Validates the builder-specific configuration.

Methods inherited from class redis.clients.jedis.builders.AbstractClientBuilder

applyCommandObjectsConfiguration, build, cache, cacheConfig, clientConfig, commandExecutor, connectionProvider, createClient, createDefaultClientConfig, createDefaultCommandObjects, jsonObjectMapper, keyPreProcessor, poolConfig, searchDialect, validateCommonConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiDbClientBuilder

public MultiDbClientBuilder()

Method Detail

multiDbConfig

public MultiDbClientBuilder<C> multiDbConfig(MultiDbConfig config)

Sets the multi-database configuration.

This configuration controls circuit breaker behavior, retry logic, health checks, failback settings, and other resilience features. If not provided, default configuration will be used.

Parameters:

config - the multi-database configuration

Returns:

this builder

databaseSwitchListener

public MultiDbClientBuilder<C> databaseSwitchListener(java.util.function.Consumer<DatabaseSwitchEvent> listener)

Sets a listener for database switch events.

The listener will be called whenever the client switches from one endpoint to another, providing information about the switch reason and the new active endpoint. This is useful for monitoring, alerting, and logging purposes.

Parameters:

listener - the database switch event listener

Returns:

this builder

self

protected MultiDbClientBuilder<C> self()

Description copied from class: AbstractClientBuilder

Returns the concrete builder instance for method chaining. This method must be implemented by subclasses to return their own type.

Specified by:

self in class AbstractClientBuilder<MultiDbClientBuilder<C>,C>

Returns:

the concrete builder instance

createDefaultConnectionProvider

protected ConnectionProvider createDefaultConnectionProvider()

Description copied from class: AbstractClientBuilder

Creates a default connection provider based on the current configuration.

Specified by:

createDefaultConnectionProvider in class AbstractClientBuilder<MultiDbClientBuilder<C>,C>

Returns:

ConnectionProvider

createDefaultCommandExecutor

protected CommandExecutor createDefaultCommandExecutor()

Description copied from class: AbstractClientBuilder

Creates a default command executor based on the current configuration.

Overrides:

createDefaultCommandExecutor in class AbstractClientBuilder<MultiDbClientBuilder<C>,C>

Returns:

CommandExecutor

validateSpecificConfiguration

protected void validateSpecificConfiguration()

Description copied from class: AbstractClientBuilder

Validates the builder-specific configuration.

This method is called by the generic build() method to validate configuration specific to each builder type. Implementations should call validateCommonConfiguration() and then perform their own specific validation.

Specified by:

validateSpecificConfiguration in class AbstractClientBuilder<MultiDbClientBuilder<C>,C>