Package org.springframework.data.redis.connection.jedis

Interface JedisClientConfiguration.JedisClientConfigurationBuilder

All Known Implementing Classes:

JedisClientConfiguration.DefaultJedisClientConfigurationBuilder

Enclosing interface:

JedisClientConfiguration

public static interface JedisClientConfiguration.JedisClientConfigurationBuilder

Builder for JedisClientConfiguration.

Method Summary

Modifier and Type	Method	Description
JedisClientConfiguration	build()	Build the JedisClientConfiguration with the configuration applied from this builder.
JedisClientConfiguration.JedisClientConfigurationBuilder	clientName(String clientName)	Configure a clientName to be set with CLIENT SETNAME.
JedisClientConfiguration.JedisClientConfigurationBuilder	connectTimeout(Duration connectTimeout)	Configure a connection timeout.
JedisClientConfiguration.JedisClientConfigurationBuilder	customize(JedisClientConfigBuilderCustomizer customizer)	Configure a JedisClientConfigBuilderCustomizer to configure JedisClientConfig.
JedisClientConfiguration.JedisClientConfigurationBuilder	readTimeout(Duration readTimeout)	Configure a read timeout.
JedisClientConfiguration.JedisPoolingClientConfigurationBuilder	usePooling()	Enable connection-pooling.
JedisClientConfiguration.JedisSslClientConfigurationBuilder	useSsl()	Enable SSL connections.

Method Details

customize

JedisClientConfiguration.JedisClientConfigurationBuilder customize(JedisClientConfigBuilderCustomizer customizer)

Configure a JedisClientConfigBuilderCustomizer to configure JedisClientConfig.

Returns:

JedisClientConfiguration.JedisClientConfigurationBuilder.

Since:

3.4

useSsl

JedisClientConfiguration.JedisSslClientConfigurationBuilder useSsl()

Enable SSL connections.

Returns:

JedisClientConfiguration.JedisSslClientConfigurationBuilder.

usePooling

JedisClientConfiguration.JedisPoolingClientConfigurationBuilder usePooling()

Enable connection-pooling.

Applies only to single node Redis. Sentinel and Cluster modes use always connection-pooling regardless of the pooling setting.

Returns:

JedisClientConfiguration.JedisPoolingClientConfigurationBuilder.

clientName

JedisClientConfiguration.JedisClientConfigurationBuilder clientName(String clientName)

Configure a clientName to be set with CLIENT SETNAME.

Parameters:

clientName - must not be null.

Returns:

this builder.

Throws:

IllegalArgumentException - if clientName is null.

readTimeout

JedisClientConfiguration.JedisClientConfigurationBuilder readTimeout(Duration readTimeout)

Configure a read timeout.

Parameters:

readTimeout - must not be null.

Returns:

this builder.

Throws:

IllegalArgumentException - if readTimeout is null.

connectTimeout

JedisClientConfiguration.JedisClientConfigurationBuilder connectTimeout(Duration connectTimeout)

Configure a connection timeout.

Parameters:

connectTimeout - must not be null.

Returns:

this builder.

Throws:

IllegalArgumentException - if connectTimeout is null.

build

JedisClientConfiguration build()

Build the JedisClientConfiguration with the configuration applied from this builder.

Returns:

a new JedisClientConfiguration object.