BaseMasterSlaveServersConfig (Redisson 3.5.1 API)

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

Type Parameters:

T - config type

Direct Known Subclasses:

ClusterServersConfig, MasterSlaveServersConfig, ReplicatedServersConfig, SentinelServersConfig
```
public class BaseMasterSlaveServersConfig<T extends BaseMasterSlaveServersConfig<T>>
extends Object
```
Author:

Nikita Koksharov

Constructor Summary

Constructors
Constructor and Description

BaseMasterSlaveServersConfig()

Constructors
Constructor and Description
`BaseMasterSlaveServersConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`checkSkipSlavesInit()`
`String`	`getClientName()`
`int`	`getConnectTimeout()`
`long`	`getDnsMonitoringInterval()`
`int`	`getFailedAttempts()`
`int`	`getIdleConnectionTimeout()`
`LoadBalancer`	`getLoadBalancer()`
`int`	`getMasterConnectionMinimumIdleSize()`
`int`	`getMasterConnectionPoolSize()`
`String`	`getPassword()`
`int`	`getPingTimeout()`
`ReadMode`	`getReadMode()`
`int`	`getReconnectionTimeout()`
`int`	`getRetryAttempts()`
`int`	`getRetryInterval()`
`int`	`getSlaveConnectionMinimumIdleSize()`
`int`	`getSlaveConnectionPoolSize()`
`int`	`getSlaveSubscriptionConnectionMinimumIdleSize()` Deprecated.
`int`	`getSlaveSubscriptionConnectionPoolSize()` Deprecated.
`URI`	`getSslKeystore()`
`String`	`getSslKeystorePassword()`
`SslProvider`	`getSslProvider()`
`URI`	`getSslTruststore()`
`String`	`getSslTruststorePassword()`
`int`	`getSubscriptionConnectionMinimumIdleSize()`
`int`	`getSubscriptionConnectionPoolSize()`
`SubscriptionMode`	`getSubscriptionMode()`
`int`	`getSubscriptionsPerConnection()`
`int`	`getTimeout()`
`boolean`	`isSslEnableEndpointIdentification()`
`T`	`setClientName(String clientName)` Setup connection name during connection init via CLIENT SETNAME command
`T`	`setConnectTimeout(int connectTimeout)` Timeout during connecting to any Redis server.
`T`	`setDnsMonitoringInterval(long dnsMonitoringInterval)` Interval in milliseconds to check the endpoint's DNS Applications must ensure the JVM DNS cache TTL is low enough to support this.
`T`	`setFailedAttempts(int slaveFailedAttempts)` Redis server will be excluded from the internal list of available nodes when sequential unsuccessful execution attempts of any Redis command on this server reaches `failedAttempts`.
`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`	`setLoadBalancer(LoadBalancer loadBalancer)` Сonnection load balancer to multiple Redis slave servers.
`T`	`setMasterConnectionMinimumIdleSize(int masterConnectionMinimumIdleSize)` Redis 'master' node minimum idle connection amount for each slave node Default is `10`
`T`	`setMasterConnectionPoolSize(int masterConnectionPoolSize)` Redis 'master' server connection pool size.
`T`	`setPassword(String password)` Password for Redis authentication.
`T`	`setPingTimeout(int pingTimeout)` Ping timeout used in `Node.ping` and `Node.pingAll` operation
`T`	`setReadMode(ReadMode readMode)` Set node type used for read operation.
`T`	`setReconnectionTimeout(int slaveRetryTimeout)` Reconnection attempt timeout to Redis server when it has been excluded from internal list of available servers.
`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`	`setSlaveConnectionMinimumIdleSize(int slaveConnectionMinimumIdleSize)` Redis 'slave' node minimum idle connection amount for each slave node Default is `10`
`T`	`setSlaveConnectionPoolSize(int slaveConnectionPoolSize)` Redis 'slave' servers connection pool size for each slave node.
`T`	`setSlaveSubscriptionConnectionMinimumIdleSize(int slaveSubscriptionConnectionMinimumIdleSize)` Deprecated. use `setSubscriptionConnectionMinimumIdleSize(int)`
`T`	`setSlaveSubscriptionConnectionPoolSize(int slaveSubscriptionConnectionPoolSize)` Deprecated. use `setSubscriptionConnectionPoolSize(int)`
`T`	`setSslEnableEndpointIdentification(boolean sslEnableEndpointIdentification)` Enables SSL endpoint identification.
`T`	`setSslKeystore(URI sslKeystore)` Defines path to SSL keystore
`T`	`setSslKeystorePassword(String sslKeystorePassword)` Defines password for SSL keystore
`T`	`setSslProvider(SslProvider sslProvider)` Defines SSL provider used to handle SSL connections.
`T`	`setSslTruststore(URI sslTruststore)` Defines path to SSL truststore
`T`	`setSslTruststorePassword(String sslTruststorePassword)` Defines password for SSL truststore
`T`	`setSubscriptionConnectionMinimumIdleSize(int subscriptionConnectionMinimumIdleSize)` Redis 'slave' node minimum idle subscription (pub/sub) connection amount for each slave node.
`T`	`setSubscriptionConnectionPoolSize(int subscriptionConnectionPoolSize)` Redis 'slave' node maximum subscription (pub/sub) connection pool size for each slave node Default is `50`
`T`	`setSubscriptionMode(SubscriptionMode subscriptionMode)` Set node type used for subscription operation.
`T`	`setSubscriptionsPerConnection(int subscriptionsPerConnection)` Subscriptions per Redis connection limit Default is 5
`T`	`setTimeout(int timeout)` Redis server response timeout.

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

- Constructor Detail
  - BaseMasterSlaveServersConfig
```
public BaseMasterSlaveServersConfig()
```
- Method Detail
  - setSlaveConnectionPoolSize
```
public T setSlaveConnectionPoolSize(int slaveConnectionPoolSize)
```
    Redis 'slave' servers connection pool size for each slave node.
    Default is 64
    
    Parameters:
    
    slaveConnectionPoolSize - - size of pool
    
    Returns:
    
    config
    
    See Also:
    
    setSlaveConnectionMinimumIdleSize(int)
  - getSlaveConnectionPoolSize
```
public int getSlaveConnectionPoolSize()
```
  - setMasterConnectionPoolSize
```
public T setMasterConnectionPoolSize(int masterConnectionPoolSize)
```
    Redis 'master' server connection pool size.
    Default is 64
    
    Parameters:
    
    masterConnectionPoolSize - - pool size
    
    Returns:
    
    config
    
    See Also:
    
    setMasterConnectionMinimumIdleSize(int)
  - getMasterConnectionPoolSize
```
public int getMasterConnectionPoolSize()
```
  - setLoadBalancer
```
public T setLoadBalancer(LoadBalancer loadBalancer)
```
    Сonnection load balancer to multiple Redis slave servers. Uses Round-robin algorithm by default
    
    Parameters:
    
    loadBalancer - object
    
    Returns:
    
    config
    
    See Also:
    
    RandomLoadBalancer, RoundRobinLoadBalancer, WeightedRoundRobinBalancer
  - getLoadBalancer
```
public LoadBalancer getLoadBalancer()
```
  - setSlaveSubscriptionConnectionPoolSize
```
@Deprecated
public T setSlaveSubscriptionConnectionPoolSize(int slaveSubscriptionConnectionPoolSize)
```
    Deprecated. use setSubscriptionConnectionPoolSize(int)
    
    Parameters:
    
    slaveSubscriptionConnectionPoolSize - - pool size
    
    Returns:
    
    config
  - getSlaveSubscriptionConnectionPoolSize
```
@Deprecated
public int getSlaveSubscriptionConnectionPoolSize()
```
    Deprecated.
  - setSubscriptionConnectionPoolSize
```
public T setSubscriptionConnectionPoolSize(int subscriptionConnectionPoolSize)
```
    Redis 'slave' node maximum subscription (pub/sub) connection pool size for each slave node
    Default is 50
    
    Parameters:
    
    subscriptionConnectionPoolSize - - pool size
    
    Returns:
    
    config
    
    See Also:
    
    setSubscriptionConnectionMinimumIdleSize(int)
  - getSubscriptionConnectionPoolSize
```
public int getSubscriptionConnectionPoolSize()
```
  - setSlaveConnectionMinimumIdleSize
```
public T setSlaveConnectionMinimumIdleSize(int slaveConnectionMinimumIdleSize)
```
    Redis 'slave' node minimum idle connection amount for each slave node
    Default is 10
    
    Parameters:
    
    slaveConnectionMinimumIdleSize - - pool size
    
    Returns:
    
    config
    
    See Also:
    
    setSlaveConnectionPoolSize(int)
  - getSlaveConnectionMinimumIdleSize
```
public int getSlaveConnectionMinimumIdleSize()
```
  - setMasterConnectionMinimumIdleSize
```
public T setMasterConnectionMinimumIdleSize(int masterConnectionMinimumIdleSize)
```
    Redis 'master' node minimum idle connection amount for each slave node
    Default is 10
    
    Parameters:
    
    masterConnectionMinimumIdleSize - - pool size
    
    Returns:
    
    config
    
    See Also:
    
    setMasterConnectionPoolSize(int)
  - getMasterConnectionMinimumIdleSize
```
public int getMasterConnectionMinimumIdleSize()
```
  - setSlaveSubscriptionConnectionMinimumIdleSize
```
@Deprecated
public T setSlaveSubscriptionConnectionMinimumIdleSize(int slaveSubscriptionConnectionMinimumIdleSize)
```
    Deprecated. use setSubscriptionConnectionMinimumIdleSize(int)
    
    Parameters:
    
    slaveSubscriptionConnectionMinimumIdleSize - - pool size
    
    Returns:
    
    config
  - getSlaveSubscriptionConnectionMinimumIdleSize
```
@Deprecated
public int getSlaveSubscriptionConnectionMinimumIdleSize()
```
    Deprecated.
  - setSubscriptionConnectionMinimumIdleSize
```
public T setSubscriptionConnectionMinimumIdleSize(int subscriptionConnectionMinimumIdleSize)
```
    Redis 'slave' node minimum idle subscription (pub/sub) connection amount for each slave node.
    Default is 1
    
    Parameters:
    
    subscriptionConnectionMinimumIdleSize - - pool size
    
    Returns:
    
    config
    
    See Also:
    
    setSubscriptionConnectionPoolSize(int)
  - getSubscriptionConnectionMinimumIdleSize
```
public int getSubscriptionConnectionMinimumIdleSize()
```
  - setReadMode
```
public T setReadMode(ReadMode readMode)
```
    Set node type used for read operation.
    Default is SLAVE
    
    Parameters:
    
    readMode - param
    
    Returns:
    
    config
  - getReadMode
```
public ReadMode getReadMode()
```
  - checkSkipSlavesInit
```
public boolean checkSkipSlavesInit()
```
  - setSubscriptionMode
```
public T setSubscriptionMode(SubscriptionMode subscriptionMode)
```
    Set node type used for subscription operation.
    Default is SLAVE
    
    Parameters:
    
    subscriptionMode - param
    
    Returns:
    
    config
  - getSubscriptionMode
```
public SubscriptionMode getSubscriptionMode()
```
  - setDnsMonitoringInterval
```
public T setDnsMonitoringInterval(long dnsMonitoringInterval)
```
    Interval in milliseconds to check the endpoint's DNS
    Applications must ensure the JVM DNS cache TTL is low enough to support this.
    Set -1 to disable.
    Default is 5000.
    
    Parameters:
    
    dnsMonitoringInterval - time
    
    Returns:
    
    config
  - getDnsMonitoringInterval
```
public long getDnsMonitoringInterval()
```
  - 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()
```
  - 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
    
    See Also:
    
    retryAttempts
  - 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
    
    Parameters:
    
    clientName - - name of client
    
    Returns:
    
    config
  - getClientName
```
public String getClientName()
```
  - setPingTimeout
```
public T setPingTimeout(int pingTimeout)
```
    Ping timeout used in Node.ping and Node.pingAll operation
    
    Parameters:
    
    pingTimeout - - timeout in milliseconds
    
    Returns:
    
    config
  - getPingTimeout
```
public int getPingTimeout()
```
  - 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.
    
    Parameters:
    
    idleConnectionTimeout - - timeout in milliseconds
    
    Returns:
    
    config
  - getIdleConnectionTimeout
```
public int getIdleConnectionTimeout()
```
  - setReconnectionTimeout
```
public T setReconnectionTimeout(int slaveRetryTimeout)
```
    Reconnection attempt timeout to Redis server when it has been excluded from internal list of available servers.
    On every such timeout event Redisson tries to connect to disconnected Redis server.
    Default is 3000
    
    Parameters:
    
    slaveRetryTimeout - - retry timeout in milliseconds
    
    Returns:
    
    config
    
    See Also:
    
    failedAttempts
  - getReconnectionTimeout
```
public int getReconnectionTimeout()
```
  - setFailedAttempts
```
public T setFailedAttempts(int slaveFailedAttempts)
```
    Redis server will be excluded from the internal list of available nodes when sequential unsuccessful execution attempts of any Redis command on this server reaches failedAttempts.
    Default is 3
    
    Parameters:
    
    slaveFailedAttempts - - attempts
    
    Returns:
    
    config
  - getFailedAttempts
```
public int getFailedAttempts()
```
  - 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 URI getSslTruststore()
```
  - setSslTruststore
```
public T setSslTruststore(URI sslTruststore)
```
    Defines path to SSL truststore
    
    Parameters:
    
    sslTruststore - - path
    
    Returns:
    
    config
  - getSslTruststorePassword
```
public String getSslTruststorePassword()
```
  - setSslTruststorePassword
```
public T setSslTruststorePassword(String sslTruststorePassword)
```
    Defines password for SSL truststore
    
    Parameters:
    
    sslTruststorePassword - - password
    
    Returns:
    
    config
  - getSslKeystore
```
public URI getSslKeystore()
```
  - setSslKeystore
```
public T setSslKeystore(URI sslKeystore)
```
    Defines path to SSL keystore
    
    Parameters:
    
    sslKeystore - - path to keystore
    
    Returns:
    
    config
  - getSslKeystorePassword
```
public String getSslKeystorePassword()
```
  - setSslKeystorePassword
```
public T setSslKeystorePassword(String sslKeystorePassword)
```
    Defines password for SSL keystore
    
    Parameters:
    
    sslKeystorePassword - - password
    
    Returns:
    
    config

Class BaseMasterSlaveServersConfig<T extends BaseMasterSlaveServersConfig<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseMasterSlaveServersConfig

Method Detail

setSlaveConnectionPoolSize

getSlaveConnectionPoolSize

setMasterConnectionPoolSize

getMasterConnectionPoolSize

setLoadBalancer

getLoadBalancer

setSlaveSubscriptionConnectionPoolSize

getSlaveSubscriptionConnectionPoolSize

setSubscriptionConnectionPoolSize

getSubscriptionConnectionPoolSize

setSlaveConnectionMinimumIdleSize

getSlaveConnectionMinimumIdleSize

setMasterConnectionMinimumIdleSize

getMasterConnectionMinimumIdleSize

setSlaveSubscriptionConnectionMinimumIdleSize

getSlaveSubscriptionConnectionMinimumIdleSize

setSubscriptionConnectionMinimumIdleSize

getSubscriptionConnectionMinimumIdleSize

setReadMode

getReadMode

checkSkipSlavesInit

setSubscriptionMode

getSubscriptionMode

setDnsMonitoringInterval

getDnsMonitoringInterval

setSubscriptionsPerConnection

getSubscriptionsPerConnection

setPassword

getPassword

setRetryAttempts

getRetryAttempts

setRetryInterval

getRetryInterval

setTimeout

getTimeout

setClientName

getClientName

setPingTimeout

getPingTimeout

setConnectTimeout

getConnectTimeout

setIdleConnectionTimeout

getIdleConnectionTimeout

setReconnectionTimeout

getReconnectionTimeout

setFailedAttempts

getFailedAttempts

isSslEnableEndpointIdentification

setSslEnableEndpointIdentification

getSslProvider

setSslProvider

getSslTruststore

setSslTruststore

getSslTruststorePassword

setSslTruststorePassword

getSslKeystore

setSslKeystore

getSslKeystorePassword

setSslKeystorePassword