JedisClientConfig (Jedis 8.0.0 API)

All Known Implementing Classes:

DefaultJedisClientConfig
```
public interface JedisClientConfig
```

Method Summary

All Methods Instance Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default AuthXManager`	`getAuthXManager()`
`default int`	`getBlockingSocketTimeoutMillis()`
`default java.lang.String`	`getClientName()`
`default ClientSetInfoConfig`	`getClientSetInfoConfig()` Modify the behavior of internally executing CLIENT SETINFO command.
`default CommandKeyArgumentPreProcessor`	`getCommandKeyArgumentPreProcessor()` Optional key argument pre-processor applied to every command before it is sent.
`default int`	`getConnectionTimeoutMillis()`
`default java.util.function.Supplier<RedisCredentials>`	`getCredentialsProvider()`
`default int`	`getDatabase()`
`default HostAndPortMapper`	`getHostAndPortMapper()`
`default javax.net.ssl.HostnameVerifier`	`getHostnameVerifier()`
`default JsonObjectMapper`	`getJsonObjectMapper()` Optional JSON object mapper used by RedisJSON commands.
`default java.lang.String`	`getPassword()`
`default RedisProtocol`	`getRedisProtocol()`
`default int`	`getSearchDialect()` Default search dialect applied to RediSearch commands when the caller does not specify one.
`default int`	`getSocketTimeoutMillis()`
`default SslOptions`	`getSslOptions()` TLS/SSL configuration.
`default javax.net.ssl.SSLParameters`	`getSslParameters()` Deprecated. since 7.4.2, use `getSslOptions()` instead.
`default javax.net.ssl.SSLSocketFactory`	`getSslSocketFactory()` Deprecated. since 7.4.2, use `getSslOptions()` instead.
`default java.lang.String`	`getUser()`
`default boolean`	`isAutoNegotiateProtocol()` Whether the client should auto-negotiate the highest RESP protocol available with the server when no protocol is explicitly requested.
`default boolean`	`isReadOnlyForRedisClusterReplicas()` Execute READONLY command to connections.
`default boolean`	`isSsl()` Whether TLS/SSL should be used for connections.

- Method Detail
  - getRedisProtocol
```
default RedisProtocol getRedisProtocol()
```
  - isAutoNegotiateProtocol
```
default boolean isAutoNegotiateProtocol()
```
    Whether the client should auto-negotiate the highest RESP protocol available with the server when no protocol is explicitly requested.
    When this returns true and getRedisProtocol() is null, the client sends HELLO 3 on connect and gracefully falls back to RESP2 if the server does not support RESP3. When false and the protocol is null, the client preserves the legacy behaviour of skipping HELLO entirely and assuming RESP2 on the wire.
    
    When getRedisProtocol() is non-null, this flag is ignored — the requested protocol is enforced strictly.
    
    The legacy Jedis class does not support RESP3 wire format, so it ignores this flag and emits a warning when callers leave it enabled.
    
    Returns:
    
    true to auto-negotiate the protocol (default), false to preserve legacy HELLO-less behaviour
  - getConnectionTimeoutMillis
```
default int getConnectionTimeoutMillis()
```
    Returns:
    
    Connection timeout in milliseconds
  - getSocketTimeoutMillis
```
default int getSocketTimeoutMillis()
```
    Returns:
    
    Socket timeout in milliseconds
  - getBlockingSocketTimeoutMillis
```
default int getBlockingSocketTimeoutMillis()
```
    Returns:
    
    Socket timeout (in milliseconds) to use during blocking operation. Default is '0', which means to block forever.
  - getUser
```
default java.lang.String getUser()
```
    Returns:
    
    Redis ACL user
  - getPassword
```
default java.lang.String getPassword()
```
  - getCredentialsProvider
```
default java.util.function.Supplier<RedisCredentials> getCredentialsProvider()
```
  - getAuthXManager
```
default AuthXManager getAuthXManager()
```
  - getDatabase
```
default int getDatabase()
```
  - getClientName
```
default java.lang.String getClientName()
```
  - isSsl
```
default boolean isSsl()
```
    Whether TLS/SSL should be used for connections.
    A TLS connection is established when this returns true or when getSslOptions() returns a non-null value. If both are provided, getSslOptions() takes precedence.
    
    Returns:
    
    true if TLS/SSL is enabled, false otherwise
    
    See Also:
    
    getSslOptions()
  - getSslSocketFactory
```
@Deprecated
default javax.net.ssl.SSLSocketFactory getSslSocketFactory()
```
    Deprecated. since 7.4.2, use getSslOptions() instead.
    
    Custom SSLSocketFactory to use for TLS connections.
    Consulted only when getSslOptions() returns null. Implementations should return null to use the JVM default.
    
    Returns:
    
    custom SSL socket factory, or null to use the default
    
    See Also:
    
    getSslOptions()
  - getSslParameters
```
@Deprecated
default javax.net.ssl.SSLParameters getSslParameters()
```
    Deprecated. since 7.4.2, use getSslOptions() instead.
    
    Custom SSLParameters to apply to TLS sockets.
    Consulted only when getSslOptions() returns null. Implementations should return null to let the client apply defaults (which enable HTTPS hostname verification).
    
    Returns:
    
    custom SSL parameters, or null for defaults
    
    See Also:
    
    getSslOptions()
  - getSslOptions
```
default SslOptions getSslOptions()
```
    TLS/SSL configuration. Recommended way to configure TLS connections.
    When non-null, TLS is enabled and this takes precedence over getSslSocketFactory() and getSslParameters(). Implementations should return null to fall back to isSsl() / getSslSocketFactory() / getSslParameters().
    
    Returns:
    
    TLS configuration, or null if not configured
    
    See Also:
    
    SslOptions, SslVerifyMode
  - getHostnameVerifier
```
default javax.net.ssl.HostnameVerifier getHostnameVerifier()
```
  - getHostAndPortMapper
```
default HostAndPortMapper getHostAndPortMapper()
```
  - isReadOnlyForRedisClusterReplicas
```
default boolean isReadOnlyForRedisClusterReplicas()
```
    Execute READONLY command to connections.
    READONLY command is specific to Redis Cluster replica nodes. So this config param is only intended for Redis Cluster connections.
    
    Returns:
    
    true - to execute READONLY command to connection(s). false - otherwise.
  - getClientSetInfoConfig
```
default ClientSetInfoConfig getClientSetInfoConfig()
```
    Modify the behavior of internally executing CLIENT SETINFO command.
    
    Returns:
    
    CLIENT SETINFO config
  - getCommandKeyArgumentPreProcessor
```
default CommandKeyArgumentPreProcessor getCommandKeyArgumentPreProcessor()
```
    Optional key argument pre-processor applied to every command before it is sent. Returning null disables key rewriting.
    Not supported by the legacy Jedis class — only the UnifiedJedis family (RedisClient, RedisClusterClient, RedisSentinelClient, MultiDbClient) honours this value.
  - getJsonObjectMapper
```
default JsonObjectMapper getJsonObjectMapper()
```
    Optional JSON object mapper used by RedisJSON commands. Returning null falls back to the library default (Gson-based).
    Not supported by the legacy Jedis class — only the UnifiedJedis family (RedisClient, RedisClusterClient, RedisSentinelClient, MultiDbClient) honours this value.
  - getSearchDialect
```
default int getSearchDialect()
```
    Default search dialect applied to RediSearch commands when the caller does not specify one. Defaults to SearchProtocol.DEFAULT_DIALECT.
    Not supported by the legacy Jedis class — only the UnifiedJedis family (RedisClient, RedisClusterClient, RedisSentinelClient, MultiDbClient) honours this value.

Interface JedisClientConfig

Method Summary

Method Detail

getRedisProtocol

isAutoNegotiateProtocol

getConnectionTimeoutMillis

getSocketTimeoutMillis

getBlockingSocketTimeoutMillis

getUser

getPassword

getCredentialsProvider

getAuthXManager

getDatabase

getClientName

isSsl

getSslSocketFactory

getSslParameters

getSslOptions

getHostnameVerifier

getHostAndPortMapper

isReadOnlyForRedisClusterReplicas

getClientSetInfoConfig

getCommandKeyArgumentPreProcessor

getJsonObjectMapper

getSearchDialect