LettuceClientConfiguration (Spring Data Redis 2.0.6.RELEASE API)

All Known Subinterfaces:

LettucePoolingClientConfiguration
```
public interface LettuceClientConfiguration
```
Redis client configuration for lettuce. This configuration provides optional configuration elements such as ClientResources and ClientOptions specific to Lettuce client features.
Providing optional elements allows a more specific configuration of the client:
- Whether to use SSL
- Whether to verify peers using SSL
- Whether to use StartTLS
- Optional ClientResources
- Optional ClientOptions
- Client timeout
- Shutdown timeout
Since:

2.0

Author:

Mark Paluch, Christoph Strobl

See Also:

RedisStandaloneConfiguration, RedisSentinelConfiguration, RedisClusterConfiguration

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`LettuceClientConfiguration.LettuceClientConfigurationBuilder`
`static class`	`LettuceClientConfiguration.LettuceSslClientConfigurationBuilder` Builder for SSL-related `LettuceClientConfiguration`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static LettuceClientConfiguration.LettuceClientConfigurationBuilder`	`builder()` Creates a new `LettuceClientConfiguration.LettuceClientConfigurationBuilder` to build `LettuceClientConfiguration` to be used with the Lettuce client.
`static LettuceClientConfiguration`	`defaultConfiguration()` Creates a default `LettuceClientConfiguration` with: SSL no Peer Verification yes Start TLS no Client Options none Client Resources none Connect Timeout 60 Seconds Shutdown Timeout 100 Milliseconds
`Optional<io.lettuce.core.ClientOptions>`	`getClientOptions()`
`Optional<io.lettuce.core.resource.ClientResources>`	`getClientResources()`
`Duration`	`getCommandTimeout()`
`Duration`	`getShutdownTimeout()`
`boolean`	`isStartTls()`
`boolean`	`isUseSsl()`
`boolean`	`isVerifyPeer()`

- Method Detail
  - isUseSsl
```
boolean isUseSsl()
```
    Returns:
    
    true to use SSL, false to use unencrypted connections.
  - isVerifyPeer
```
boolean isVerifyPeer()
```
    Returns:
    
    true to verify peers when using SSL.
  - isStartTls
```
boolean isStartTls()
```
    Returns:
    
    true to use Start TLS (true if the first write request shouldn't be encrypted).
  - getClientResources
```
Optional<io.lettuce.core.resource.ClientResources> getClientResources()
```
    Returns:
    
    the optional ClientResources.
  - getClientOptions
```
Optional<io.lettuce.core.ClientOptions> getClientOptions()
```
    Returns:
    
    the optional ClientOptions.
  - getCommandTimeout
```
Duration getCommandTimeout()
```
    Returns:
    
    the timeout.
  - getShutdownTimeout
```
Duration getShutdownTimeout()
```
    Returns:
    
    the shutdown timeout used to close the client.
    
    See Also:
    
    AbstractRedisClient.shutdown(long, long, TimeUnit)
  - builder
```
static LettuceClientConfiguration.LettuceClientConfigurationBuilder builder()
```
    Creates a new LettuceClientConfiguration.LettuceClientConfigurationBuilder to build LettuceClientConfiguration to be used with the Lettuce client.
    
    Returns:
    
    a new LettuceClientConfiguration.LettuceClientConfigurationBuilder to build LettuceClientConfiguration.
  - defaultConfiguration
```
static LettuceClientConfiguration defaultConfiguration()
```
    Creates a default LettuceClientConfiguration with:
    
    SSL
    
    no
    
    Peer Verification
    
    yes
    
    Start TLS
    
    no
    
    Client Options
    
    none
    
    Client Resources
    
    none
    
    Connect Timeout
    
    60 Seconds
    
    Shutdown Timeout
    
    100 Milliseconds
    
    Returns:
    
    a LettuceClientConfiguration with defaults.

Interface LettuceClientConfiguration

Nested Class Summary

Method Summary

Method Detail

isUseSsl

isVerifyPeer

isStartTls

getClientResources

getClientOptions

getCommandTimeout

getShutdownTimeout

builder

defaultConfiguration