redis.clients.jedis.builders

Class SentinelClientBuilder<C>

java.lang.Object

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

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

Direct Known Subclasses:

JedisSentineled.Builder, RedisSentinelClient.Builder

public abstract class SentinelClientBuilder<C>
extends AbstractClientBuilder<SentinelClientBuilder<C>,C>

Builder for creating JedisSentineled instances (Redis Sentinel connections).

This builder provides methods specific to Redis Sentinel deployments, including master name configuration, sentinel nodes configuration, and separate client configurations for master and sentinel connections.

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

Method Summary

Modifier and Type	Method and Description
C	build() Builds the Redis client instance using the common build pattern.
protected ConnectionProvider	createDefaultConnectionProvider() Creates a default connection provider based on the current configuration.
SentinelClientBuilder<C>	masterName(java.lang.String masterName) Sets the master name for the Redis Sentinel configuration.
protected SentinelClientBuilder<C>	self() Returns the concrete builder instance for method chaining.
SentinelClientBuilder<C>	sentinelClientConfig(JedisClientConfig sentinelClientConfig) Sets the client configuration for Sentinel connections.
SentinelClientBuilder<C>	sentinelReconnectDelay(Delay reconnectDelay) Sets the delay between re-subscribing to sentinel node after a disconnection.
SentinelClientBuilder<C>	sentinels(java.util.Set<HostAndPort> sentinels) Sets the sentinel nodes to connect to.
protected void	validateSpecificConfiguration() Validates the builder-specific configuration.

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

applyCommandObjectsConfiguration, cache, cacheConfig, clientConfig, commandExecutor, connectionProvider, createClient, createDefaultClientConfig, createDefaultCommandExecutor, 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

SentinelClientBuilder

public SentinelClientBuilder()

Method Detail

masterName

public SentinelClientBuilder<C> masterName(java.lang.String masterName)

Sets the master name for the Redis Sentinel configuration.

This is the name of the Redis master as configured in the Sentinel instances. The Sentinel will monitor this master and provide failover capabilities.

Parameters:

masterName - the master name (must not be null or empty)

Returns:

this builder

sentinels

public SentinelClientBuilder<C> sentinels(java.util.Set<HostAndPort> sentinels)

Sets the sentinel nodes to connect to.

At least one sentinel must be specified. The client will use these sentinels to discover the current master and monitor for failover events.

Parameters:

sentinels - the set of sentinel nodes

Returns:

this builder

sentinelClientConfig

public SentinelClientBuilder<C> sentinelClientConfig(JedisClientConfig sentinelClientConfig)

Sets the client configuration for Sentinel connections.

This configuration is used for connections to the Sentinel instances. It may have different authentication credentials and settings than the master connections.

Parameters:

sentinelClientConfig - the client configuration for sentinel connections

Returns:

this builder

sentinelReconnectDelay

public SentinelClientBuilder<C> sentinelReconnectDelay(Delay reconnectDelay)

Sets the delay between re-subscribing to sentinel node after a disconnection.

In case connection to sentinel nodes is lost, the client will try to reconnect to them. This method sets the delay between re-subscribing to sentinel nodes after a disconnection.

Parameters:

reconnectDelay - the delay between re-subscribing to sentinel nodes after a disconnection

Returns:

this builder

self

protected SentinelClientBuilder<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<SentinelClientBuilder<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<SentinelClientBuilder<C>,C>

Returns:

ConnectionProvider

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<SentinelClientBuilder<C>,C>

build

public C build()

Description copied from class: AbstractClientBuilder

Builds the Redis client instance using the common build pattern.

This method implements the common build pattern shared across all builder types:

1. Validates configuration (both common and builder-specific)
2. Creates cache from cacheConfig if provided
3. Creates default connection provider if not already set
4. Creates default command executor if not already set
5. Applies common configuration to command objects
6. Creates and returns the specific client instance

Overrides:

build in class AbstractClientBuilder<SentinelClientBuilder<C>,C>

Returns:

the configured Redis client instance