redis.clients.jedis.builders

Class ClusterClientBuilder<C extends JedisCluster>

java.lang.Object

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

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

Direct Known Subclasses:

JedisCluster.Builder

public abstract class ClusterClientBuilder<C extends JedisCluster>
extends AbstractClientBuilder<ClusterClientBuilder<C>,C>

Builder for creating JedisCluster instances (Redis Cluster connections).

This builder provides methods specific to Redis Cluster deployments, including cluster nodes configuration, retry settings, and topology refresh configuration.

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
ClusterClientBuilder()

Method Summary

Modifier and Type	Method and Description
protected CommandExecutor	createDefaultCommandExecutor() Creates a default command executor based on the current configuration.
protected CommandObjects	createDefaultCommandObjects() Factory method for creating CommandObjects.
protected ConnectionProvider	createDefaultConnectionProvider() Creates a default connection provider based on the current configuration.
ClusterClientBuilder<C>	maxAttempts(int maxAttempts) Sets the maximum number of attempts for cluster operations.
ClusterClientBuilder<C>	maxTotalRetriesDuration(java.time.Duration maxTotalRetriesDuration) Sets the maximum total duration for retries across all attempts.
ClusterClientBuilder<C>	nodes(java.util.Set<HostAndPort> nodes) Sets the cluster nodes to connect to.
protected ClusterClientBuilder<C>	self() Returns the concrete builder instance for method chaining.
ClusterClientBuilder<C>	topologyRefreshPeriod(java.time.Duration topologyRefreshPeriod) Sets the topology refresh period for cluster slot mapping updates.
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, 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

ClusterClientBuilder

public ClusterClientBuilder()

Method Detail

nodes

public ClusterClientBuilder<C> nodes(java.util.Set<HostAndPort> nodes)

Sets the cluster nodes to connect to.

At least one node must be specified. The client will discover other nodes in the cluster automatically.

Parameters:

nodes - the set of cluster nodes

Returns:

this builder

maxAttempts

public ClusterClientBuilder<C> maxAttempts(int maxAttempts)

Sets the maximum number of attempts for cluster operations.

When a cluster operation fails (e.g., due to node failure or slot migration), the client will retry up to this many times before giving up.

Parameters:

maxAttempts - the maximum number of attempts (must be positive)

Returns:

this builder

maxTotalRetriesDuration

public ClusterClientBuilder<C> maxTotalRetriesDuration(java.time.Duration maxTotalRetriesDuration)

Sets the maximum total duration for retries across all attempts.

This provides a time-based limit on retries in addition to the attempt-based limit. If not set, it will be calculated as socketTimeout * maxAttempts.

Parameters:

maxTotalRetriesDuration - the maximum total retry duration

Returns:

this builder

topologyRefreshPeriod

public ClusterClientBuilder<C> topologyRefreshPeriod(java.time.Duration topologyRefreshPeriod)

Sets the topology refresh period for cluster slot mapping updates.

The client will periodically refresh its view of the cluster topology to handle slot migrations and node changes. A shorter period provides faster adaptation to cluster changes but increases overhead.

Parameters:

topologyRefreshPeriod - the topology refresh period

Returns:

this builder

self

protected ClusterClientBuilder<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<ClusterClientBuilder<C extends JedisCluster>,C extends JedisCluster>

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<ClusterClientBuilder<C extends JedisCluster>,C extends JedisCluster>

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<ClusterClientBuilder<C extends JedisCluster>,C extends JedisCluster>

Returns:

CommandExecutor

createDefaultCommandObjects

protected CommandObjects createDefaultCommandObjects()

Description copied from class: AbstractClientBuilder

Factory method for creating CommandObjects. Subclasses may override to provide specialized CommandObjects implementations (e.g., ClusterCommandObjects).

Overrides:

createDefaultCommandObjects in class AbstractClientBuilder<ClusterClientBuilder<C extends JedisCluster>,C extends JedisCluster>

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<ClusterClientBuilder<C extends JedisCluster>,C extends JedisCluster>