AbstractClientBuilder (Jedis 7.0.0 API)

java.lang.Object
- redis.clients.jedis.builders.AbstractClientBuilder<T,C>

Type Parameters:

T - the concrete builder type for method chaining

C - the client type that this builder creates

Direct Known Subclasses:

ClusterClientBuilder, MultiDbClientBuilder, SentinelClientBuilder, StandaloneClientBuilder
```
public abstract class AbstractClientBuilder<T extends AbstractClientBuilder<T,C>,C>
extends java.lang.Object
```
Abstract base class for Redis client builders that provides common configuration options.
This class contains shared configuration fields and methods that are common across different Redis client builders (RedisClient.Builder, RedisSentinelClient.Builder, etc.). It helps eliminate code duplication and provides a consistent API for common features.
Common features provided:
- Connection pool configuration
- Client-side caching
- Custom connection providers
- Key preprocessing
- JSON object mapping
- Search dialect configuration

Field Summary

Fields
Modifier and Type	Field and Description
`protected Cache`	`cache`
`protected CacheConfig`	`cacheConfig`
`protected JedisClientConfig`	`clientConfig`
`protected CommandExecutor`	`commandExecutor`
`protected CommandObjects`	`commandObjects`
`protected ConnectionProvider`	`connectionProvider`
`protected JsonObjectMapper`	`jsonObjectMapper`
`protected CommandKeyArgumentPreProcessor`	`keyPreProcessor`
`protected org.apache.commons.pool2.impl.GenericObjectPoolConfig<Connection>`	`poolConfig`
`protected int`	`searchDialect`

Constructor Summary

Constructors
Constructor and Description

AbstractClientBuilder()

Constructors
Constructor and Description
`AbstractClientBuilder()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyCommandObjectsConfiguration(CommandObjects commandObjects)` Applies common configuration to the CommandObjects instance.
`C`	`build()` Builds the Redis client instance using the common build pattern.
`T`	`cache(Cache cache)` Sets the client-side cache for caching Redis responses.
`T`	`cacheConfig(CacheConfig cacheConfig)` Sets the cache configuration for client-side caching.
`T`	`clientConfig(JedisClientConfig clientConfig)` Sets the client configuration for Redis connections.
`T`	`commandExecutor(CommandExecutor commandExecutor)` Sets a custom command executor for executing Redis commands.
`T`	`connectionProvider(ConnectionProvider connectionProvider)` Sets a custom connection provider.
`protected abstract C`	`createClient()` Creates the specific client instance with the provided components.
`protected JedisClientConfig`	`createDefaultClientConfig()` Creates a default client configuration based on the current configuration.
`protected CommandExecutor`	`createDefaultCommandExecutor()` Creates a default command executor based on the current configuration.
`protected CommandObjects`	`createDefaultCommandObjects()` Factory method for creating CommandObjects.
`protected abstract ConnectionProvider`	`createDefaultConnectionProvider()` Creates a default connection provider based on the current configuration.
`T`	`jsonObjectMapper(JsonObjectMapper jsonObjectMapper)` Sets a custom JSON object mapper for JSON operations.
`T`	`keyPreProcessor(CommandKeyArgumentPreProcessor keyPreProcessor)` Sets a key preprocessor for transforming Redis keys before sending commands.
`T`	`poolConfig(org.apache.commons.pool2.impl.GenericObjectPoolConfig<Connection> poolConfig)` Sets the connection pool configuration.
`T`	`searchDialect(int searchDialect)` Sets the default search dialect for RediSearch operations.
`protected abstract T`	`self()` Returns the concrete builder instance for method chaining.
`protected void`	`validateCommonConfiguration()` Validates common configuration parameters.
`protected abstract void`	`validateSpecificConfiguration()` Validates the builder-specific configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - poolConfig
```
protected org.apache.commons.pool2.impl.GenericObjectPoolConfig<Connection> poolConfig
```
  - cache
```
protected Cache cache
```
  - cacheConfig
```
protected CacheConfig cacheConfig
```
  - commandExecutor
```
protected CommandExecutor commandExecutor
```
  - commandObjects
```
protected CommandObjects commandObjects
```
  - connectionProvider
```
protected ConnectionProvider connectionProvider
```
  - keyPreProcessor
```
protected CommandKeyArgumentPreProcessor keyPreProcessor
```
  - jsonObjectMapper
```
protected JsonObjectMapper jsonObjectMapper
```
  - searchDialect
```
protected int searchDialect
```
  - clientConfig
```
protected JedisClientConfig clientConfig
```
- Constructor Detail
  - AbstractClientBuilder
```
public AbstractClientBuilder()
```
- Method Detail
  - clientConfig
```
public T clientConfig(JedisClientConfig clientConfig)
```
    Sets the client configuration for Redis connections.
    The client configuration includes authentication, timeouts, SSL settings, and other connection-specific parameters.
    
    Parameters:
    
    clientConfig - the client configuration
    
    Returns:
    
    this builder
  - self
```
protected abstract T self()
```
    Returns the concrete builder instance for method chaining. This method must be implemented by subclasses to return their own type.
    
    Returns:
    
    the concrete builder instance
  - createDefaultConnectionProvider
```
protected abstract ConnectionProvider createDefaultConnectionProvider()
```
    Creates a default connection provider based on the current configuration.
    
    Returns:
    
    ConnectionProvider
  - createDefaultCommandExecutor
```
protected CommandExecutor createDefaultCommandExecutor()
```
    Creates a default command executor based on the current configuration.
    
    Returns:
    
    CommandExecutor
  - createDefaultClientConfig
```
protected JedisClientConfig createDefaultClientConfig()
```
    Creates a default client configuration based on the current configuration.
    
    Returns:
    
    JedisClientConfig
  - createDefaultCommandObjects
```
protected CommandObjects createDefaultCommandObjects()
```
    Factory method for creating CommandObjects. Subclasses may override to provide specialized CommandObjects implementations (e.g., ClusterCommandObjects).
  - createClient
```
protected abstract C createClient()
```
    Creates the specific client instance with the provided components.
    This method is called by the generic build() method to instantiate the concrete client type. Each builder implementation should create their specific client type (JedisPooled, JedisCluster, etc.) using the parameters provided to the builder.
    
    Returns:
    
    the configured Redis client instance
  - validateSpecificConfiguration
```
protected abstract void validateSpecificConfiguration()
```
    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.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the configuration is invalid
  - build
```
public C build()
```
    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
    Returns:
    
    the configured Redis client instance
  - poolConfig
```
public T poolConfig(org.apache.commons.pool2.impl.GenericObjectPoolConfig<Connection> poolConfig)
```
    Sets the connection pool configuration.
    The pool configuration controls how connections are managed, including maximum number of connections, idle timeout, and other pooling parameters.
    
    Parameters:
    
    poolConfig - the pool configuration
    
    Returns:
    
    this builder
  - cache
```
public T cache(Cache cache)
```
    Sets the client-side cache for caching Redis responses.
    Client-side caching can improve performance by storing frequently accessed data locally, reducing the number of round trips to the Redis server.
    
    Parameters:
    
    cache - the cache instance
    
    Returns:
    
    this builder
  - cacheConfig
```
public T cacheConfig(CacheConfig cacheConfig)
```
    Sets the cache configuration for client-side caching.
    Client-side caching can improve performance by storing frequently accessed data locally. The cache will be created from this configuration during the build process.
    
    Parameters:
    
    cacheConfig - the cache configuration
    
    Returns:
    
    this builder
  - connectionProvider
```
public T connectionProvider(ConnectionProvider connectionProvider)
```
    Sets a custom connection provider.
    When a custom connection provider is set, other connection-related configuration may be ignored as the provider is responsible for managing connections. The specific behavior depends on the concrete builder implementation.
    
    Parameters:
    
    connectionProvider - the connection provider
    
    Returns:
    
    this builder
  - commandExecutor
```
public T commandExecutor(CommandExecutor commandExecutor)
```
    Sets a custom command executor for executing Redis commands.
    The command executor is responsible for sending commands to Redis and processing the responses.
    
    Parameters:
    
    commandExecutor - the command executor
    
    Returns:
    
    this builder
  - keyPreProcessor
```
public T keyPreProcessor(CommandKeyArgumentPreProcessor keyPreProcessor)
```
    Sets a key preprocessor for transforming Redis keys before sending commands.
    The key preprocessor allows you to modify keys before they are sent to Redis, for example to add prefixes, apply transformations, or implement key routing logic.
    Example usage:
```
 
 CommandKeyArgumentPreProcessor keyProcessor = key -> "myapp:" + key;
 builder.keyPreProcessor(keyProcessor);
 
 
```
    Parameters:
    
    keyPreProcessor - the key preprocessor
    
    Returns:
    
    this builder
  - jsonObjectMapper
```
public T jsonObjectMapper(JsonObjectMapper jsonObjectMapper)
```
    Sets a custom JSON object mapper for JSON operations.
    The JSON object mapper is used for serializing and deserializing objects in JSON commands (RedisJSON module). If not set, a default Gson-based mapper will be used.
    Example usage:
```
 {
   @code
   JsonObjectMapper customMapper = new MyCustomJsonMapper();
   builder.jsonObjectMapper(customMapper);
 }
 
```
    Parameters:
    
    jsonObjectMapper - the JSON object mapper
    
    Returns:
    
    this builder
  - searchDialect
```
public T searchDialect(int searchDialect)
```
    Sets the default search dialect for RediSearch operations.
    The search dialect determines the query syntax and features available for RediSearch commands. Different dialects support different query features and syntax variations.
    Default is 2.
    
    Parameters:
    
    searchDialect - the search dialect version
    
    Returns:
    
    this builder
    
    Throws:
    
    java.lang.IllegalArgumentException - if dialect is 0 (not allowed)
  - applyCommandObjectsConfiguration
```
public void applyCommandObjectsConfiguration(CommandObjects commandObjects)
```
    Applies common configuration to the CommandObjects instance.
    This method is called by concrete builders to configure the CommandObjects with the common settings like key preprocessor, JSON mapper, and search dialect.
    
    Parameters:
    
    commandObjects - the CommandObjects instance to configure
  - validateCommonConfiguration
```
protected void validateCommonConfiguration()
```
    Validates common configuration parameters.
    This method can be called by concrete builders to validate the common configuration before building the client.
    
    Throws:
    
    java.lang.IllegalArgumentException - if any common configuration is invalid

Class AbstractClientBuilder<T extends AbstractClientBuilder<T,C>,C>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

poolConfig

cache

cacheConfig

commandExecutor

commandObjects

connectionProvider

keyPreProcessor

jsonObjectMapper

searchDialect

clientConfig

Constructor Detail

AbstractClientBuilder

Method Detail

clientConfig

self

createDefaultConnectionProvider

createDefaultCommandExecutor

createDefaultClientConfig

createDefaultCommandObjects

createClient

validateSpecificConfiguration

build

poolConfig

cache

cacheConfig

connectionProvider

commandExecutor

keyPreProcessor

jsonObjectMapper

searchDialect

applyCommandObjectsConfiguration

validateCommonConfiguration