Package org.springframework.data.redis.connection.lettuce

Class LettuceClientConfiguration.LettuceClientConfigurationBuilder

java.lang.Object

org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceClientConfigurationBuilder

Direct Known Subclasses:

LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder

Enclosing interface:

LettuceClientConfiguration

public static class LettuceClientConfiguration.LettuceClientConfigurationBuilder
extends Object

Author:

Mark Paluch, Christoph Strobl

Method Summary

Modifier and Type	Method	Description
LettuceClientConfiguration.LettuceClientConfigurationBuilder	apply(io.lettuce.core.RedisURI redisUri)	Apply SSL settings, command timeout, and client name from a RedisURI.
LettuceClientConfiguration	build()	Build the LettuceClientConfiguration with the configuration applied from this builder.
LettuceClientConfiguration.LettuceClientConfigurationBuilder	clientName(String clientName)	Configure a clientName to be set with CLIENT SETNAME.
LettuceClientConfiguration.LettuceClientConfigurationBuilder	clientOptions(io.lettuce.core.ClientOptions clientOptions)	Configure ClientOptions.
LettuceClientConfiguration.LettuceClientConfigurationBuilder	clientResources(io.lettuce.core.resource.ClientResources clientResources)	Configure ClientResources.
LettuceClientConfiguration.LettuceClientConfigurationBuilder	commandTimeout(Duration timeout)	Configure a command timeout.
LettuceClientConfiguration.LettuceClientConfigurationBuilder	readFrom(io.lettuce.core.ReadFrom readFrom)	Configure ReadFrom.
LettuceClientConfiguration.LettuceClientConfigurationBuilder	redisCredentialsProviderFactory(RedisCredentialsProviderFactory redisCredentialsProviderFactory)	Configure a RedisCredentialsProviderFactory to obtain RedisCredentialsProvider instances to support credential rotation.
LettuceClientConfiguration.LettuceClientConfigurationBuilder	shutdownQuietPeriod(Duration shutdownQuietPeriod)	Configure the shutdown quiet period.
LettuceClientConfiguration.LettuceClientConfigurationBuilder	shutdownTimeout(Duration shutdownTimeout)	Configure a shutdown timeout.
LettuceClientConfiguration.LettuceSslClientConfigurationBuilder	useSsl()	Enable SSL connections.

Methods inherited from class java.lang.Object

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

Method Details

apply

public LettuceClientConfiguration.LettuceClientConfigurationBuilder apply(io.lettuce.core.RedisURI redisUri)

Apply SSL settings, command timeout, and client name from a RedisURI.

Parameters:

redisUri - the connection URI.

Returns:

this builder.

Since:

2.5.3

useSsl

public LettuceClientConfiguration.LettuceSslClientConfigurationBuilder useSsl()

Enable SSL connections.

Returns:

LettuceClientConfiguration.LettuceSslClientConfigurationBuilder.

clientResources

public LettuceClientConfiguration.LettuceClientConfigurationBuilder clientResources(io.lettuce.core.resource.ClientResources clientResources)

Configure ClientResources.

Parameters:

clientResources - must not be null.

Returns:

this builder.

Throws:

IllegalArgumentException - if clientResources is null.

clientOptions

public LettuceClientConfiguration.LettuceClientConfigurationBuilder clientOptions(io.lettuce.core.ClientOptions clientOptions)

Configure ClientOptions.

Parameters:

clientOptions - must not be null.

Returns:

this builder.

Throws:

IllegalArgumentException - if clientOptions is null.

readFrom

public LettuceClientConfiguration.LettuceClientConfigurationBuilder readFrom(io.lettuce.core.ReadFrom readFrom)

Configure ReadFrom. Enables Master/Replica operations if configured.

Parameters:

readFrom - must not be null.

Returns:

this builder.

Throws:

IllegalArgumentException - if readFrom is null.

Since:

2.1

redisCredentialsProviderFactory

public LettuceClientConfiguration.LettuceClientConfigurationBuilder redisCredentialsProviderFactory(RedisCredentialsProviderFactory redisCredentialsProviderFactory)

Configure a RedisCredentialsProviderFactory to obtain RedisCredentialsProvider instances to support credential rotation.

Parameters:

redisCredentialsProviderFactory - must not be null.

Returns:

this builder.

Throws:

IllegalArgumentException - if redisCredentialsProviderFactory is null.

Since:

3.0

clientName

public LettuceClientConfiguration.LettuceClientConfigurationBuilder clientName(String clientName)

Configure a clientName to be set with CLIENT SETNAME.

Parameters:

clientName - must not be null or empty.

Returns:

this builder.

Throws:

IllegalArgumentException - if clientName is null or empty.

Since:

2.1

commandTimeout

public LettuceClientConfiguration.LettuceClientConfigurationBuilder commandTimeout(Duration timeout)

Configure a command timeout.

Parameters:

timeout - must not be null.

Returns:

this builder.

Throws:

IllegalArgumentException - if timeout is null.

shutdownTimeout

public LettuceClientConfiguration.LettuceClientConfigurationBuilder shutdownTimeout(Duration shutdownTimeout)

Configure a shutdown timeout.

Parameters:

shutdownTimeout - must not be null.

Returns:

this builder.

Throws:

IllegalArgumentException - if shutdownTimeout is null.

shutdownQuietPeriod

public LettuceClientConfiguration.LettuceClientConfigurationBuilder shutdownQuietPeriod(Duration shutdownQuietPeriod)

Configure the shutdown quiet period.

Parameters:

shutdownQuietPeriod - must not be null.

Returns:

this builder.

Throws:

IllegalArgumentException - if shutdownQuietPeriod is null.

Since:

2.2

build

public LettuceClientConfiguration build()

Build the LettuceClientConfiguration with the configuration applied from this builder.

Returns:

a new LettuceClientConfiguration object.