redis.clients.jedis.builders

Class StandaloneClientBuilder<C>

java.lang.Object

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

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

Direct Known Subclasses:

JedisPooled.Builder, RedisClient.Builder

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

Builder for creating RedisClient instances (standalone Redis connections).

This builder provides methods specific to standalone Redis deployments, including host/port configuration, URI-based configuration, and client configuration options.

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

Method Summary

Modifier and Type	Method and Description
protected ConnectionProvider	createDefaultConnectionProvider() Creates a default connection provider based on the current configuration.
StandaloneClientBuilder<C>	fromURI(java.lang.String uriString) Deprecated. Use hostAndPort(String, int) combined with AbstractClientBuilder.clientConfig(JedisClientConfig) for explicit configuration. This method will be removed in Jedis 8.0.0. Migration example: // Old (deprecated): builder.fromURI("redis://user:pass@localhost:6379/2") // New (recommended): builder.hostAndPort("localhost", 6379) .clientConfig(DefaultJedisClientConfig.builder() .user("user") .password("pass") .database(2) .build())
StandaloneClientBuilder<C>	fromURI(java.net.URI uri) Deprecated. Use hostAndPort(HostAndPort) combined with AbstractClientBuilder.clientConfig(JedisClientConfig) for explicit configuration. This method will be removed in Jedis 8.0.0. See fromURI(String) for migration example.
StandaloneClientBuilder<C>	hostAndPort(HostAndPort hostAndPort) Sets the Redis server host and port.
StandaloneClientBuilder<C>	hostAndPort(java.lang.String host, int port) Sets the Redis server host and port.
protected StandaloneClientBuilder<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, 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

StandaloneClientBuilder

public StandaloneClientBuilder()

Method Detail

hostAndPort

public StandaloneClientBuilder<C> hostAndPort(java.lang.String host,
                                              int port)

Sets the Redis server host and port.

Parameters:

host - the Redis server hostname

port - the Redis server port

Returns:

this builder

hostAndPort

public StandaloneClientBuilder<C> hostAndPort(HostAndPort hostAndPort)

Sets the Redis server host and port.

Parameters:

hostAndPort - the Redis server host and port

Returns:

this builder

self

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

fromURI

@Deprecated
public StandaloneClientBuilder<C> fromURI(java.lang.String uriString)

Deprecated. Use hostAndPort(String, int) combined with AbstractClientBuilder.clientConfig(JedisClientConfig) for explicit configuration. This method will be removed in Jedis 8.0.0.

Migration example:

             // Old (deprecated):
             builder.fromURI("redis://user:pass@localhost:6379/2")

             // New (recommended):
             builder.hostAndPort("localhost", 6379)
                    .clientConfig(DefaultJedisClientConfig.builder()
                        .user("user")
                        .password("pass")
                        .database(2)
                        .build())
             

Sets the Redis server URI from a string.

This method extracts connection parameters from the URI and merges them into the current client configuration. If a client configuration was previously set via AbstractClientBuilder.clientConfig(JedisClientConfig), only the values explicitly provided in the URI will override the existing configuration. Values not present in the URI will be preserved from the existing configuration.

This method sets:

• Host and port from the URI (always set)
• Client configuration with URI-derived values (merged with existing config if present)

URI values override existing config values when:

• URI contains user/password - overrides existing credentials
• URI contains database - overrides existing database
• URI contains protocol parameter - overrides existing protocol
• URI uses rediss:// scheme - enables SSL

Examples:

 // Credentials from config are preserved (URI has no credentials)
 builder.clientConfig(configWithCredentials).fromURI("redis://localhost:6379")

 // URI credentials override config credentials
 builder.clientConfig(configWithCredentials).fromURI("redis://user:pass@localhost:6379")

 // Config completely overrides URI (last wins)
 builder.fromURI("redis://user:pass@localhost:6379").clientConfig(newConfig)
 

Parameters:

uriString - the Redis server URI string

Returns:

this builder

fromURI

@Deprecated
public StandaloneClientBuilder<C> fromURI(java.net.URI uri)

Deprecated. Use hostAndPort(HostAndPort) combined with AbstractClientBuilder.clientConfig(JedisClientConfig) for explicit configuration. This method will be removed in Jedis 8.0.0. See fromURI(String) for migration example.

Sets the Redis server URI.

This method extracts connection parameters from the URI and merges them into the current client configuration. If a client configuration was previously set via AbstractClientBuilder.clientConfig(JedisClientConfig), only the values explicitly provided in the URI will override the existing configuration. Values not present in the URI will be preserved from the existing configuration.

This method sets:

• Host and port from the URI (always set)
• Client configuration with URI-derived values (merged with existing config if present)

URI values override existing config values when:

• URI contains user/password - overrides existing credentials
• URI contains database - overrides existing database
• URI contains protocol parameter - overrides existing protocol
• URI uses rediss:// scheme - enables SSL

Examples:

 // Credentials from config are preserved (URI has no credentials)
 builder.clientConfig(configWithCredentials).fromURI(uri)

 // URI credentials override config credentials
 builder.clientConfig(configWithCredentials).fromURI(uriWithCredentials)

 // Config completely overrides URI (last wins)
 builder.fromURI(uriWithCredentials).clientConfig(newConfig)
 

Parameters:

uri - the Redis server URI

Returns:

this builder