org.redisson.config

Class SentinelServersConfig

java.lang.Object

org.redisson.config.BaseMasterSlaveServersConfig<SentinelServersConfig>

org.redisson.config.SentinelServersConfig

public class SentinelServersConfig
extends BaseMasterSlaveServersConfig<SentinelServersConfig>

Author:

Nikita Koksharov

Constructor Summary

Constructors

Constructor and Description
SentinelServersConfig()

Method Summary

Modifier and Type	Method and Description
SentinelServersConfig	addSentinelAddress(String... addresses) Add Redis Sentinel node address in host:port format.
String	getClientName()
int	getConnectTimeout()
int	getDatabase()
int	getFailedAttempts()
int	getIdleConnectionTimeout()
String	getMasterName()
String	getPassword()
int	getPingConnectionInterval()
int	getPingTimeout()
int	getReconnectionTimeout()
int	getRetryAttempts()
int	getRetryInterval()
List<URI>	getSentinelAddresses()
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.
SentinelServersConfig	setDatabase(int database) Database index used for Redis connection Default is 0
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	setKeepAlive(boolean keepAlive) Enables TCP keepAlive for connection Default is false
SentinelServersConfig	setMasterName(String masterName) Master server name used by Redis Sentinel servers and master change monitoring task.
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) 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	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, getLoadBalancer, getMasterConnectionMinimumIdleSize, getMasterConnectionPoolSize, getReadMode, getSlaveConnectionMinimumIdleSize, getSlaveConnectionPoolSize, getSlaveSubscriptionConnectionMinimumIdleSize, getSlaveSubscriptionConnectionPoolSize, getSubscriptionConnectionMinimumIdleSize, getSubscriptionConnectionPoolSize, getSubscriptionMode, setDnsMonitoringInterval, 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

SentinelServersConfig

public SentinelServersConfig()

Method Detail

setMasterName

public SentinelServersConfig setMasterName(String masterName)

Master server name used by Redis Sentinel servers and master change monitoring task.

Parameters:

masterName - of Redis

Returns:

config

getMasterName

public String getMasterName()

addSentinelAddress

public SentinelServersConfig addSentinelAddress(String... addresses)

Add Redis Sentinel node address in host:port format. Multiple nodes at once could be added.

Parameters:

addresses - of Redis

Returns:

config

getSentinelAddresses

public List<URI> getSentinelAddresses()

setDatabase

public SentinelServersConfig 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

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

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