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

Interface JedisClientConfiguration

public interface JedisClientConfiguration

Redis client configuration for jedis. This configuration provides optional configuration elements such as SSLSocketFactory and JedisPoolConfig specific to jedis client features.

Providing optional elements allows a more specific configuration of the client:

• Whether to use SSL
• Optional SSLSocketFactory
• Optional SSLParameters
• Optional HostnameVerifier
• Whether to use connection-pooling
• Optional GenericObjectPoolConfig
• Optional client name
• Connect timeout
• Read timeout

Since:

2.0

Author:

Mark Paluch, Christoph Strobl, Chao Chang

See Also:

• Jedis
• RedisStandaloneConfiguration
• RedisSentinelConfiguration
• RedisClusterConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JedisClientConfiguration.DefaultJedisClientConfigurationBuilder	Default JedisClientConfiguration.JedisClientConfigurationBuilder implementation to build an immutable JedisClientConfiguration.
static interface	JedisClientConfiguration.JedisClientConfigurationBuilder	Builder for JedisClientConfiguration.
static interface	JedisClientConfiguration.JedisPoolingClientConfigurationBuilder	Builder for Pooling-related JedisClientConfiguration.
static interface	JedisClientConfiguration.JedisSslClientConfigurationBuilder	Builder for SSL-related JedisClientConfiguration.

Method Summary

Modifier and Type	Method	Description
static JedisClientConfiguration.JedisClientConfigurationBuilder	builder()	Creates a new JedisClientConfiguration.JedisClientConfigurationBuilder to build JedisClientConfiguration to be used with the jedis client.
static JedisClientConfiguration	defaultConfiguration()	Creates a default JedisClientConfiguration.
Optional<String>	getClientName()
Duration	getConnectTimeout()
Optional<JedisClientConfigBuilderCustomizer>	getCustomizer()
Optional<HostnameVerifier>	getHostnameVerifier()
Optional<org.apache.commons.pool2.impl.GenericObjectPoolConfig>	getPoolConfig()
Duration	getReadTimeout()
Optional<SSLParameters>	getSslParameters()
Optional<SSLSocketFactory>	getSslSocketFactory()
boolean	isUsePooling()
boolean	isUseSsl()

Method Details

getCustomizer

Optional<JedisClientConfigBuilderCustomizer> getCustomizer()

Returns:

the optional JedisClientConfigBuilderCustomizer.

Since:

3.4

isUseSsl

boolean isUseSsl()

Returns:

true to use SSL, false to use unencrypted connections.

getSslSocketFactory

Optional<SSLSocketFactory> getSslSocketFactory()

Returns:

the optional SSLSocketFactory.

getSslParameters

Optional<SSLParameters> getSslParameters()

Returns:

the optional SSLParameters.

getHostnameVerifier

Optional<HostnameVerifier> getHostnameVerifier()

Returns:

the optional HostnameVerifier.

isUsePooling

boolean isUsePooling()

Returns:

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

getPoolConfig

Optional<org.apache.commons.pool2.impl.GenericObjectPoolConfig> getPoolConfig()

Returns:

the optional GenericObjectPoolConfig.

getClientName

Optional<String> getClientName()

Returns:

the optional client name to be set with CLIENT SETNAME.

getConnectTimeout

Duration getConnectTimeout()

Returns:

the connection timeout.

See Also:

• Socket.connect(SocketAddress, int)

getReadTimeout

Duration getReadTimeout()

Returns:

the read timeout.

See Also:

• Socket.setSoTimeout(int)

builder

static JedisClientConfiguration.JedisClientConfigurationBuilder builder()

Creates a new JedisClientConfiguration.JedisClientConfigurationBuilder to build JedisClientConfiguration to be used with the jedis client.

Returns:

a new JedisClientConfiguration.JedisClientConfigurationBuilder to build JedisClientConfiguration.

defaultConfiguration

static JedisClientConfiguration defaultConfiguration()

Creates a default JedisClientConfiguration.

Customizer

none

SSL enabled

no

Pooling enabled

no

Client Name

[not set]

Read Timeout

2000 msec

Connect Timeout

2000 msec

Returns:

a JedisClientConfiguration with defaults.