MasterSlaveServersConfig (Redisson 2.12.5 API)

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

public class MasterSlaveServersConfig
extends BaseMasterSlaveServersConfig<MasterSlaveServersConfig>

Author:: Nikita Koksharov

Constructor Summary

Constructors
Constructor and Description

MasterSlaveServersConfig()

Constructors
Constructor and Description
`MasterSlaveServersConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`MasterSlaveServersConfig`	`addSlaveAddress(String... addresses)` Add Redis slave server address.
`MasterSlaveServersConfig`	`addSlaveAddress(URI slaveAddress)`
`String`	`getClientName()`
`int`	`getConnectTimeout()`
`int`	`getDatabase()`
`int`	`getIdleConnectionTimeout()`
`URI`	`getMasterAddress()`
`String`	`getPassword()`
`int`	`getPingConnectionInterval()`
`int`	`getPingTimeout()`
`int`	`getRetryAttempts()`
`int`	`getRetryInterval()`
`Set<URI>`	`getSlaveAddresses()`
`URI`	`getSslKeystore()`
`String`	`getSslKeystorePassword()`
`SslProvider`	`getSslProvider()`
`URI`	`getSslTruststore()`
`String`	`getSslTruststorePassword()`
`int`	`getSubscriptionsPerConnection()`
`int`	`getTimeout()`
`boolean`	`isKeepAlive()`
`boolean`	`isSslEnableEndpointIdentification()`
`boolean`	`isTcpNoDelay()`
`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.
`MasterSlaveServersConfig`	`setDatabase(int database)` Database index used for Redis connection Default is `0`
`T`	`setFailedAttempts(int slaveFailedAttempts)` Deprecated.
`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`
`MasterSlaveServersConfig`	`setMasterAddress(String masterAddress)` Set Redis master server address.
`MasterSlaveServersConfig`	`setMasterAddress(URI masterAddress)`
`T`	`setPassword(String password)` Password for Redis authentication.
`T`	`setPingConnectionInterval(int pingConnectionInterval)` Defines PING command sending interval per connection to Redis.
`T`	`setPingTimeout(int pingTimeout)` Ping timeout used in `Node.ping` and `Node.pingAll` operation
`T`	`setReconnectionTimeout(int slaveRetryTimeout)` Deprecated.
`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.
`void`	`setSlaveAddresses(Set<URI> readAddresses)`
`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`	`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.

Methods inherited from class org.redisson.config.BaseMasterSlaveServersConfig
checkSkipSlavesInit, getDnsMonitoringInterval, getFailedSlaveCheckInterval, getFailedSlaveReconnectionInterval, getLoadBalancer, getMasterConnectionMinimumIdleSize, getMasterConnectionPoolSize, getReadMode, getSlaveConnectionMinimumIdleSize, getSlaveConnectionPoolSize, getSlaveSubscriptionConnectionMinimumIdleSize, getSlaveSubscriptionConnectionPoolSize, getSubscriptionConnectionMinimumIdleSize, getSubscriptionConnectionPoolSize, getSubscriptionMode, setDnsMonitoringInterval, setFailedSlaveCheckInterval, setFailedSlaveReconnectionInterval, setLoadBalancer, setMasterConnectionMinimumIdleSize, setMasterConnectionPoolSize, setReadMode, setSlaveConnectionMinimumIdleSize, setSlaveConnectionPoolSize, setSlaveSubscriptionConnectionMinimumIdleSize, setSlaveSubscriptionConnectionPoolSize, setSubscriptionConnectionMinimumIdleSize, setSubscriptionConnectionPoolSize, setSubscriptionMode

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

- Constructor Detail
  - MasterSlaveServersConfig
```
public MasterSlaveServersConfig()
```
- Method Detail
  - setMasterAddress
```
public MasterSlaveServersConfig setMasterAddress(String masterAddress)
```
    Set Redis master server address. Use follow format -- host:port
    
    Parameters:
    
    masterAddress - of Redis
    
    Returns:
    
    config
  - getMasterAddress
```
public URI getMasterAddress()
```
  - setMasterAddress
```
public MasterSlaveServersConfig setMasterAddress(URI masterAddress)
```
  - addSlaveAddress
```
public MasterSlaveServersConfig addSlaveAddress(String... addresses)
```
    Add Redis slave server address. Use follow format -- host:port
    
    Parameters:
    
    addresses - of Redis
    
    Returns:
    
    config
  - addSlaveAddress
```
public MasterSlaveServersConfig addSlaveAddress(URI slaveAddress)
```
  - getSlaveAddresses
```
public Set<URI> getSlaveAddresses()
```
  - setSlaveAddresses
```
public void setSlaveAddresses(Set<URI> readAddresses)
```
  - setDatabase
```
public MasterSlaveServersConfig setDatabase(int database)
```
    Database index used for Redis connection Default is 0
    
    Parameters:
    
    database - number
    
    Returns:
    
    config
  - getDatabase
```
public int getDatabase()
```
  - 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
```
@Deprecated
public T setReconnectionTimeout(int slaveRetryTimeout)
```
    Deprecated.
  - setFailedAttempts
```
@Deprecated
public T setFailedAttempts(int slaveFailedAttempts)
```
    Deprecated.
  - 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
  - getPingConnectionInterval
```
public int getPingConnectionInterval()
```
  - setPingConnectionInterval
```
public T setPingConnectionInterval(int pingConnectionInterval)
```
    Defines PING command sending interval per connection to Redis. 0 means disable.
    Default is 0
    
    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 MasterSlaveServersConfig

Constructor Summary

Method Summary

Methods inherited from class org.redisson.config.BaseMasterSlaveServersConfig

Methods inherited from class java.lang.Object

Constructor Detail

MasterSlaveServersConfig

Method Detail

setMasterAddress

getMasterAddress

setMasterAddress

addSlaveAddress

addSlaveAddress

getSlaveAddresses

setSlaveAddresses

setDatabase

getDatabase

setSubscriptionsPerConnection

getSubscriptionsPerConnection

setPassword

getPassword

setRetryAttempts

getRetryAttempts

setRetryInterval

getRetryInterval

setTimeout

getTimeout

setClientName

getClientName

setPingTimeout

getPingTimeout

setConnectTimeout

getConnectTimeout

setIdleConnectionTimeout

getIdleConnectionTimeout

setReconnectionTimeout

setFailedAttempts

isSslEnableEndpointIdentification

setSslEnableEndpointIdentification

getSslProvider

setSslProvider

getSslTruststore

setSslTruststore

getSslTruststorePassword

setSslTruststorePassword

getSslKeystore

setSslKeystore

getSslKeystorePassword

setSslKeystorePassword

getPingConnectionInterval

setPingConnectionInterval

isKeepAlive

setKeepAlive

isTcpNoDelay

setTcpNoDelay