redis.clients.jedis

Class DefaultJedisClientConfig

java.lang.Object

redis.clients.jedis.DefaultJedisClientConfig

All Implemented Interfaces:

JedisClientConfig

public final class DefaultJedisClientConfig
extends java.lang.Object
implements JedisClientConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultJedisClientConfig.Builder

Method Summary

Modifier and Type	Method and Description
static DefaultJedisClientConfig.Builder	builder()
static DefaultJedisClientConfig.Builder	builder(java.net.URI redisUri) Creates a new Builder pre-initialized with settings from the provided Redis URI.
static DefaultJedisClientConfig	copyConfig(JedisClientConfig copy) Deprecated. Use DefaultJedisClientConfig.Builder.from(redis.clients.jedis.JedisClientConfig).
static DefaultJedisClientConfig	create(int connectionTimeoutMillis, int soTimeoutMillis, int blockingSocketTimeoutMillis, java.lang.String user, java.lang.String password, int database, java.lang.String clientName, boolean ssl, javax.net.ssl.SSLSocketFactory sslSocketFactory, javax.net.ssl.SSLParameters sslParameters, javax.net.ssl.HostnameVerifier hostnameVerifier, HostAndPortMapper hostAndPortMapper) Deprecated. Use DefaultJedisClientConfig.Builder.
AuthXManager	getAuthXManager()
int	getBlockingSocketTimeoutMillis()
java.lang.String	getClientName()
ClientSetInfoConfig	getClientSetInfoConfig() Modify the behavior of internally executing CLIENT SETINFO command.
int	getConnectionTimeoutMillis()
java.util.function.Supplier<RedisCredentials>	getCredentialsProvider()
int	getDatabase()
HostAndPortMapper	getHostAndPortMapper()
javax.net.ssl.HostnameVerifier	getHostnameVerifier()
java.lang.String	getPassword()
RedisProtocol	getRedisProtocol()
int	getSocketTimeoutMillis()
SslOptions	getSslOptions() TLS/SSL configuration.
javax.net.ssl.SSLParameters	getSslParameters() Deprecated. since 7.4.2, use getSslOptions() instead.
javax.net.ssl.SSLSocketFactory	getSslSocketFactory() Deprecated. since 7.4.2, use getSslOptions() instead.
java.lang.String	getUser()
boolean	isReadOnlyForRedisClusterReplicas() Execute READONLY command to connections.
boolean	isSsl() Whether TLS/SSL should be used for connections.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getRedisProtocol

public RedisProtocol getRedisProtocol()

Specified by:

getRedisProtocol in interface JedisClientConfig

getConnectionTimeoutMillis

public int getConnectionTimeoutMillis()

Specified by:

getConnectionTimeoutMillis in interface JedisClientConfig

Returns:

Connection timeout in milliseconds

getSocketTimeoutMillis

public int getSocketTimeoutMillis()

Specified by:

getSocketTimeoutMillis in interface JedisClientConfig

Returns:

Socket timeout in milliseconds

getBlockingSocketTimeoutMillis

public int getBlockingSocketTimeoutMillis()

Specified by:

getBlockingSocketTimeoutMillis in interface JedisClientConfig

Returns:

Socket timeout (in milliseconds) to use during blocking operation. Default is '0', which means to block forever.

getUser

public java.lang.String getUser()

Specified by:

getUser in interface JedisClientConfig

Returns:

Redis ACL user

getPassword

public java.lang.String getPassword()

Specified by:

getPassword in interface JedisClientConfig

getCredentialsProvider

public java.util.function.Supplier<RedisCredentials> getCredentialsProvider()

Specified by:

getCredentialsProvider in interface JedisClientConfig

getAuthXManager

public AuthXManager getAuthXManager()

Specified by:

getAuthXManager in interface JedisClientConfig

getDatabase

public int getDatabase()

Specified by:

getDatabase in interface JedisClientConfig

getClientName

public java.lang.String getClientName()

Specified by:

getClientName in interface JedisClientConfig

isSsl

public boolean isSsl()

Description copied from interface: JedisClientConfig

Whether TLS/SSL should be used for connections.

A TLS connection is established when this returns true or when JedisClientConfig.getSslOptions() returns a non-null value. If both are provided, JedisClientConfig.getSslOptions() takes precedence.

Specified by:

isSsl in interface JedisClientConfig

Returns:

true if TLS/SSL is enabled, false otherwise

See Also:

JedisClientConfig.getSslOptions()

getSslSocketFactory

@Deprecated
public javax.net.ssl.SSLSocketFactory getSslSocketFactory()

Deprecated. since 7.4.2, use getSslOptions() instead.

Description copied from interface: JedisClientConfig

Custom SSLSocketFactory to use for TLS connections.

Consulted only when JedisClientConfig.getSslOptions() returns null. Implementations should return null to use the JVM default.

Specified by:

getSslSocketFactory in interface JedisClientConfig

Returns:

custom SSL socket factory, or null to use the default

See Also:

JedisClientConfig.getSslOptions()

getSslParameters

@Deprecated
public javax.net.ssl.SSLParameters getSslParameters()

Deprecated. since 7.4.2, use getSslOptions() instead.

Description copied from interface: JedisClientConfig

Custom SSLParameters to apply to TLS sockets.

Consulted only when JedisClientConfig.getSslOptions() returns null. Implementations should return null to let the client apply defaults (which enable HTTPS hostname verification).

Specified by:

getSslParameters in interface JedisClientConfig

Returns:

custom SSL parameters, or null for defaults

See Also:

JedisClientConfig.getSslOptions()

getSslOptions

public SslOptions getSslOptions()

Description copied from interface: JedisClientConfig

TLS/SSL configuration. Recommended way to configure TLS connections.

When non-null, TLS is enabled and this takes precedence over JedisClientConfig.getSslSocketFactory() and JedisClientConfig.getSslParameters(). Implementations should return null to fall back to JedisClientConfig.isSsl() / JedisClientConfig.getSslSocketFactory() / JedisClientConfig.getSslParameters().

Specified by:

getSslOptions in interface JedisClientConfig

Returns:

TLS configuration, or null if not configured

See Also:

SslOptions, SslVerifyMode

getHostnameVerifier

public javax.net.ssl.HostnameVerifier getHostnameVerifier()

Specified by:

getHostnameVerifier in interface JedisClientConfig

getHostAndPortMapper

public HostAndPortMapper getHostAndPortMapper()

Specified by:

getHostAndPortMapper in interface JedisClientConfig

getClientSetInfoConfig

public ClientSetInfoConfig getClientSetInfoConfig()

Description copied from interface: JedisClientConfig

Modify the behavior of internally executing CLIENT SETINFO command.

Specified by:

getClientSetInfoConfig in interface JedisClientConfig

Returns:

CLIENT SETINFO config

isReadOnlyForRedisClusterReplicas

public boolean isReadOnlyForRedisClusterReplicas()

Description copied from interface: JedisClientConfig

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.

Specified by:

isReadOnlyForRedisClusterReplicas in interface JedisClientConfig

Returns:

true - to execute READONLY command to connection(s). false - otherwise.

builder

public static DefaultJedisClientConfig.Builder builder()

builder

public static DefaultJedisClientConfig.Builder builder(java.net.URI redisUri)

Creates a new Builder pre-initialized with settings from the provided Redis URI.

The URI format is: redis[s]://[username:password@]host:port[/database][?protocol=version]

Settings extracted from URI:

• Credentials (username/password) if present in URI
• Database index if specified in path
• SSL enabled if scheme is "rediss"
• Protocol version if specified in query parameters

Parameters:

redisUri - the Redis URI to extract settings from

Returns:

a new Builder pre-initialized from the URI

create

@Deprecated
public static DefaultJedisClientConfig create(int connectionTimeoutMillis,
                                                          int soTimeoutMillis,
                                                          int blockingSocketTimeoutMillis,
                                                          java.lang.String user,
                                                          java.lang.String password,
                                                          int database,
                                                          java.lang.String clientName,
                                                          boolean ssl,
                                                          javax.net.ssl.SSLSocketFactory sslSocketFactory,
                                                          javax.net.ssl.SSLParameters sslParameters,
                                                          javax.net.ssl.HostnameVerifier hostnameVerifier,
                                                          HostAndPortMapper hostAndPortMapper)

Deprecated. Use DefaultJedisClientConfig.Builder.

copyConfig

@Deprecated
public static DefaultJedisClientConfig copyConfig(JedisClientConfig copy)

Deprecated. Use DefaultJedisClientConfig.Builder.from(redis.clients.jedis.JedisClientConfig).