BaseConfig (Redisson 3.13.6 API)

java.lang.Object
- org.redisson.config.BaseConfig<T>

Type Parameters:

T - config type

Direct Known Subclasses:

BaseMasterSlaveServersConfig, SingleServerConfig
```
public class BaseConfig<T extends BaseConfig<T>>
extends Object
```
Author:

Nikita Koksharov

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getClientName()`
`int`	`getConnectTimeout()`
`int`	`getIdleConnectionTimeout()`
`String`	`getPassword()`
`int`	`getPingConnectionInterval()`
`int`	`getRetryAttempts()`
`int`	`getRetryInterval()`
`URL`	`getSslKeystore()`
`String`	`getSslKeystorePassword()`
`SslProvider`	`getSslProvider()`
`URL`	`getSslTruststore()`
`String`	`getSslTruststorePassword()`
`int`	`getSubscriptionsPerConnection()`
`int`	`getTimeout()`
`String`	`getUsername()`
`boolean`	`isKeepAlive()`
`boolean`	`isSslEnableEndpointIdentification()`
`boolean`	`isTcpNoDelay()`
`T`	`setClientName(String clientName)` Setup connection name during connection init via CLIENT SETNAME command Default is `null`
`T`	`setConnectTimeout(int connectTimeout)` Timeout during connecting to any Redis server.
`T`	`setIdleConnectionTimeout(int idleConnectionTimeout)` If pooled connection not used for a `timeout` time and current connections amount bigger than minimum idle connections pool size, then it will closed and removed from pool.
`T`	`setKeepAlive(boolean keepAlive)` Enables TCP keepAlive for connection Default is `false`
`T`	`setPassword(String password)` Password for Redis authentication.
`T`	`setPingConnectionInterval(int pingConnectionInterval)` Defines PING command sending interval per connection to Redis.
`T`	`setRetryAttempts(int retryAttempts)` Error will be thrown if Redis command can't be sent to Redis server after `retryAttempts`.
`T`	`setRetryInterval(int retryInterval)` Defines time interval for another one attempt send Redis command if it hasn't been sent already.
`T`	`setSslEnableEndpointIdentification(boolean sslEnableEndpointIdentification)` Enables SSL endpoint identification.
`T`	`setSslKeystore(URL sslKeystore)` Defines path to SSL keystore Default is `null`
`T`	`setSslKeystorePassword(String sslKeystorePassword)` Defines password for SSL keystore Default is `null`
`T`	`setSslProvider(SslProvider sslProvider)` Defines SSL provider used to handle SSL connections.
`T`	`setSslTruststore(URL sslTruststore)` Defines path to SSL truststore Default is `null`
`T`	`setSslTruststorePassword(String sslTruststorePassword)` Defines password for SSL truststore Default is `null`
`T`	`setSubscriptionsPerConnection(int subscriptionsPerConnection)` Subscriptions per Redis connection limit Default is `5`
`T`	`setTcpNoDelay(boolean tcpNoDelay)` Enables TCP noDelay for connection Default is `false`
`T`	`setTimeout(int timeout)` Redis server response timeout.
`T`	`setUsername(String username)` Username for Redis authentication.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setSubscriptionsPerConnection
```
public T setSubscriptionsPerConnection(int subscriptionsPerConnection)
```
    Subscriptions per Redis connection limit
    Default is 5
    
    Parameters:
    
    subscriptionsPerConnection - amount
    
    Returns:
    
    config
  - getSubscriptionsPerConnection
```
public int getSubscriptionsPerConnection()
```
  - setPassword
```
public T setPassword(String password)
```
    Password for Redis authentication. Should be null if not needed.
    Default is null
    
    Parameters:
    
    password - for connection
    
    Returns:
    
    config
  - getPassword
```
public String getPassword()
```
  - setUsername
```
public T setUsername(String username)
```
    Username for Redis authentication. Should be null if not needed
    Default is null
    Requires Redis 6.0+
    
    Parameters:
    
    username - for connection
    
    Returns:
    
    config
  - getUsername
```
public String getUsername()
```
  - setRetryAttempts
```
public T setRetryAttempts(int retryAttempts)
```
    Error will be thrown if Redis command can't be sent to Redis server after retryAttempts. But if it sent successfully then timeout will be started.
    Default is 3 attempts
    
    Parameters:
    
    retryAttempts - - retry attempts
    
    Returns:
    
    config
    
    See Also:
    
    timeout
  - getRetryAttempts
```
public int getRetryAttempts()
```
  - setRetryInterval
```
public T setRetryInterval(int retryInterval)
```
    Defines time interval for another one attempt send Redis command if it hasn't been sent already.
    Default is 1500 milliseconds
    
    Parameters:
    
    retryInterval - - time in milliseconds
    
    Returns:
    
    config
  - getRetryInterval
```
public int getRetryInterval()
```
  - setTimeout
```
public T setTimeout(int timeout)
```
    Redis server response timeout. Starts to countdown when Redis command has been successfully sent.
    Default is 3000 milliseconds
    
    Parameters:
    
    timeout - in milliseconds
    
    Returns:
    
    config
  - getTimeout
```
public int getTimeout()
```
  - setClientName
```
public T setClientName(String clientName)
```
    Setup connection name during connection init via CLIENT SETNAME command
    Default is null
    
    Parameters:
    
    clientName - - name of client
    
    Returns:
    
    config
  - getClientName
```
public String getClientName()
```
  - setConnectTimeout
```
public T setConnectTimeout(int connectTimeout)
```
    Timeout during connecting to any Redis server.
    Default is 10000 milliseconds.
    
    Parameters:
    
    connectTimeout - - timeout in milliseconds
    
    Returns:
    
    config
  - getConnectTimeout
```
public int getConnectTimeout()
```
  - setIdleConnectionTimeout
```
public T setIdleConnectionTimeout(int idleConnectionTimeout)
```
    If pooled connection not used for a timeout time and current connections amount bigger than minimum idle connections pool size, then it will closed and removed from pool.
    Default is 10000 milliseconds.
    
    Parameters:
    
    idleConnectionTimeout - - timeout in milliseconds
    
    Returns:
    
    config
  - getIdleConnectionTimeout
```
public int getIdleConnectionTimeout()
```
  - isSslEnableEndpointIdentification
```
public boolean isSslEnableEndpointIdentification()
```
  - setSslEnableEndpointIdentification
```
public T setSslEnableEndpointIdentification(boolean sslEnableEndpointIdentification)
```
    Enables SSL endpoint identification.
    Default is true
    
    Parameters:
    
    sslEnableEndpointIdentification - - boolean value
    
    Returns:
    
    config
  - getSslProvider
```
public SslProvider getSslProvider()
```
  - setSslProvider
```
public T setSslProvider(SslProvider sslProvider)
```
    Defines SSL provider used to handle SSL connections.
    Default is JDK
    
    Parameters:
    
    sslProvider - - ssl provider
    
    Returns:
    
    config
  - getSslTruststore
```
public URL getSslTruststore()
```
  - setSslTruststore
```
public T setSslTruststore(URL sslTruststore)
```
    Defines path to SSL truststore
    Default is null
    
    Parameters:
    
    sslTruststore - - path
    
    Returns:
    
    config
  - getSslTruststorePassword
```
public String getSslTruststorePassword()
```
  - setSslTruststorePassword
```
public T setSslTruststorePassword(String sslTruststorePassword)
```
    Defines password for SSL truststore
    Default is null
    
    Parameters:
    
    sslTruststorePassword - - password
    
    Returns:
    
    config
  - getSslKeystore
```
public URL getSslKeystore()
```
  - setSslKeystore
```
public T setSslKeystore(URL sslKeystore)
```
    Defines path to SSL keystore
    Default is null
    
    Parameters:
    
    sslKeystore - - path to keystore
    
    Returns:
    
    config
  - getSslKeystorePassword
```
public String getSslKeystorePassword()
```
  - setSslKeystorePassword
```
public T setSslKeystorePassword(String sslKeystorePassword)
```
    Defines password for SSL keystore
    Default is null
    
    Parameters:
    
    sslKeystorePassword - - password
    
    Returns:
    
    config
  - getPingConnectionInterval
```
public int getPingConnectionInterval()
```
  - setPingConnectionInterval
```
public T setPingConnectionInterval(int pingConnectionInterval)
```
    Defines PING command sending interval per connection to Redis. 0 means disable.
    Default is 30000
    
    Parameters:
    
    pingConnectionInterval - - time in milliseconds
    
    Returns:
    
    config
  - isKeepAlive
```
public boolean isKeepAlive()
```
  - setKeepAlive
```
public T setKeepAlive(boolean keepAlive)
```
    Enables TCP keepAlive for connection
    Default is false
    
    Parameters:
    
    keepAlive - - boolean value
    
    Returns:
    
    config
  - isTcpNoDelay
```
public boolean isTcpNoDelay()
```
  - setTcpNoDelay
```
public T setTcpNoDelay(boolean tcpNoDelay)
```
    Enables TCP noDelay for connection
    Default is false
    
    Parameters:
    
    tcpNoDelay - - boolean value
    
    Returns:
    
    config

Class BaseConfig<T extends BaseConfig<T>>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setSubscriptionsPerConnection

getSubscriptionsPerConnection

setPassword

getPassword

setUsername

getUsername

setRetryAttempts

getRetryAttempts

setRetryInterval

getRetryInterval

setTimeout

getTimeout

setClientName

getClientName

setConnectTimeout

getConnectTimeout

setIdleConnectionTimeout

getIdleConnectionTimeout

isSslEnableEndpointIdentification

setSslEnableEndpointIdentification

getSslProvider

setSslProvider

getSslTruststore

setSslTruststore

getSslTruststorePassword

setSslTruststorePassword

getSslKeystore

setSslKeystore

getSslKeystorePassword

setSslKeystorePassword

getPingConnectionInterval

setPingConnectionInterval

isKeepAlive

setKeepAlive

isTcpNoDelay

setTcpNoDelay