redis.clients.jedis

Class DefaultJedisClientConfig.Builder

java.lang.Object

redis.clients.jedis.DefaultJedisClientConfig.Builder

Enclosing class:

DefaultJedisClientConfig

public static class DefaultJedisClientConfig.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
DefaultJedisClientConfig.Builder	authXManager(AuthXManager authXManager)
DefaultJedisClientConfig.Builder	blockingSocketTimeoutMillis(int blockingSocketTimeoutMillis)
DefaultJedisClientConfig	build()
DefaultJedisClientConfig.Builder	clientName(java.lang.String clientName)
DefaultJedisClientConfig.Builder	clientSetInfoConfig(ClientSetInfoConfig setInfoConfig)
DefaultJedisClientConfig.Builder	connectionTimeoutMillis(int connectionTimeoutMillis)
DefaultJedisClientConfig.Builder	credentials(RedisCredentials credentials)
DefaultJedisClientConfig.Builder	credentialsProvider(java.util.function.Supplier<RedisCredentials> credentials)
DefaultJedisClientConfig.Builder	database(int database)
DefaultJedisClientConfig.Builder	from(JedisClientConfig instance)
DefaultJedisClientConfig.Builder	hostAndPortMapper(HostAndPortMapper hostAndPortMapper)
DefaultJedisClientConfig.Builder	hostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)
DefaultJedisClientConfig.Builder	password(java.lang.String password)
DefaultJedisClientConfig.Builder	protocol(RedisProtocol protocol)
DefaultJedisClientConfig.Builder	readOnlyForRedisClusterReplicas()
DefaultJedisClientConfig.Builder	resp3() Shortcut to protocol(RedisProtocol) with RedisProtocol.RESP3.
DefaultJedisClientConfig.Builder	socketTimeoutMillis(int socketTimeoutMillis)
DefaultJedisClientConfig.Builder	ssl(boolean ssl) Deprecated. since 7.4.2, use sslOptions(SslOptions) instead. For TLS with JVM defaults use sslOptions(SslOptions.defaults()).
DefaultJedisClientConfig.Builder	sslOptions(SslOptions sslOptions) Recommended way to configure TLS/SSL connections.
DefaultJedisClientConfig.Builder	sslParameters(javax.net.ssl.SSLParameters sslParameters) Deprecated. since 7.4.2, use sslOptions(SslOptions) instead.
DefaultJedisClientConfig.Builder	sslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory) Deprecated. since 7.4.2, use sslOptions(SslOptions) instead.
DefaultJedisClientConfig.Builder	timeoutMillis(int timeoutMillis)
DefaultJedisClientConfig.Builder	user(java.lang.String user)

Methods inherited from class java.lang.Object

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

Method Detail

build

public DefaultJedisClientConfig build()

resp3

public DefaultJedisClientConfig.Builder resp3()

Shortcut to protocol(RedisProtocol) with RedisProtocol.RESP3.

Returns:

this

protocol

public DefaultJedisClientConfig.Builder protocol(RedisProtocol protocol)

timeoutMillis

public DefaultJedisClientConfig.Builder timeoutMillis(int timeoutMillis)

connectionTimeoutMillis

public DefaultJedisClientConfig.Builder connectionTimeoutMillis(int connectionTimeoutMillis)

socketTimeoutMillis

public DefaultJedisClientConfig.Builder socketTimeoutMillis(int socketTimeoutMillis)

blockingSocketTimeoutMillis

public DefaultJedisClientConfig.Builder blockingSocketTimeoutMillis(int blockingSocketTimeoutMillis)

user

public DefaultJedisClientConfig.Builder user(java.lang.String user)

password

public DefaultJedisClientConfig.Builder password(java.lang.String password)

credentials

public DefaultJedisClientConfig.Builder credentials(RedisCredentials credentials)

credentialsProvider

public DefaultJedisClientConfig.Builder credentialsProvider(java.util.function.Supplier<RedisCredentials> credentials)

database

public DefaultJedisClientConfig.Builder database(int database)

clientName

public DefaultJedisClientConfig.Builder clientName(java.lang.String clientName)

ssl

@Deprecated
public DefaultJedisClientConfig.Builder ssl(boolean ssl)

Deprecated. since 7.4.2, use sslOptions(SslOptions) instead. For TLS with JVM defaults use sslOptions(SslOptions.defaults()).

Enable TLS/SSL for connections.

TLS is enabled when either ssl(true) or sslOptions(SslOptions) is set. sslOptions(SslOptions) takes precedence; otherwise TLS uses sslSocketFactory(SSLSocketFactory) and sslParameters(SSLParameters).

Parameters:

ssl - true to enable TLS/SSL

Returns:

this

sslSocketFactory

@Deprecated
public DefaultJedisClientConfig.Builder sslSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory)

Deprecated. since 7.4.2, use sslOptions(SslOptions) instead.

sslParameters

@Deprecated
public DefaultJedisClientConfig.Builder sslParameters(javax.net.ssl.SSLParameters sslParameters)

Deprecated. since 7.4.2, use sslOptions(SslOptions) instead.

sslOptions

public DefaultJedisClientConfig.Builder sslOptions(SslOptions sslOptions)

Recommended way to configure TLS/SSL connections.

When set, TLS is enabled and sslSocketFactory(SSLSocketFactory) / sslParameters(SSLParameters) are ignored.

Parameters:

sslOptions - TLS configuration

Returns:

this

See Also:

SslOptions

hostnameVerifier

public DefaultJedisClientConfig.Builder hostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)

hostAndPortMapper

public DefaultJedisClientConfig.Builder hostAndPortMapper(HostAndPortMapper hostAndPortMapper)

clientSetInfoConfig

public DefaultJedisClientConfig.Builder clientSetInfoConfig(ClientSetInfoConfig setInfoConfig)

readOnlyForRedisClusterReplicas

public DefaultJedisClientConfig.Builder readOnlyForRedisClusterReplicas()

authXManager

public DefaultJedisClientConfig.Builder authXManager(AuthXManager authXManager)

from

public DefaultJedisClientConfig.Builder from(JedisClientConfig instance)