Package org.redisson.config
Class SingleServerConfig
- java.lang.Object
-
- org.redisson.config.SingleServerConfig
-
public class SingleServerConfig extends Object
- Author:
- Nikita Koksharov
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description URI
getAddress()
String
getClientName()
int
getConnectionMinimumIdleSize()
int
getConnectionPoolSize()
int
getConnectTimeout()
int
getDatabase()
long
getDnsMonitoringInterval()
int
getIdleConnectionTimeout()
String
getPassword()
int
getPingConnectionInterval()
int
getPingTimeout()
int
getRetryAttempts()
int
getRetryInterval()
URI
getSslKeystore()
String
getSslKeystorePassword()
SslProvider
getSslProvider()
URI
getSslTruststore()
String
getSslTruststorePassword()
int
getSubscriptionConnectionMinimumIdleSize()
int
getSubscriptionConnectionPoolSize()
int
getSubscriptionsPerConnection()
int
getTimeout()
boolean
isKeepAlive()
boolean
isSslEnableEndpointIdentification()
boolean
isTcpNoDelay()
SingleServerConfig
setAddress(String address)
Set server address.T
setClientName(String clientName)
Setup connection name during connection init via CLIENT SETNAME commandSingleServerConfig
setConnectionMinimumIdleSize(int connectionMinimumIdleSize)
Minimum idle Redis connection amount.SingleServerConfig
setConnectionPoolSize(int connectionPoolSize)
Redis connection pool sizeT
setConnectTimeout(int connectTimeout)
Timeout during connecting to any Redis server.SingleServerConfig
setDatabase(int database)
Database index used for Redis connection Default is0
SingleServerConfig
setDnsMonitoringInterval(long dnsMonitoringInterval)
Interval in milliseconds to check the endpoint's DNST
setFailedAttempts(int slaveFailedAttempts)
Deprecated.T
setIdleConnectionTimeout(int idleConnectionTimeout)
If pooled connection not used for atimeout
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 connectionT
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 inNode.ping
andNode.pingAll
operationT
setReconnectionTimeout(int slaveRetryTimeout)
Deprecated.T
setRetryAttempts(int retryAttempts)
Error will be thrown if Redis command can't be sent to Redis server afterretryAttempts
.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 keystoreT
setSslKeystorePassword(String sslKeystorePassword)
Defines password for SSL keystoreT
setSslProvider(SslProvider sslProvider)
Defines SSL provider used to handle SSL connections.T
setSslTruststore(URI sslTruststore)
Defines path to SSL truststoreT
setSslTruststorePassword(String sslTruststorePassword)
Defines password for SSL truststoreSingleServerConfig
setSubscriptionConnectionMinimumIdleSize(int subscriptionConnectionMinimumIdleSize)
Minimum idle subscription connection amount.SingleServerConfig
setSubscriptionConnectionPoolSize(int subscriptionConnectionPoolSize)
Redis subscription-connection pool size limitT
setSubscriptionsPerConnection(int subscriptionsPerConnection)
Subscriptions per Redis connection limit Default is 5T
setTcpNoDelay(boolean tcpNoDelay)
Enables TCP noDelay for connectionT
setTimeout(int timeout)
Redis server response timeout.
-
-
-
Method Detail
-
setConnectionPoolSize
public SingleServerConfig setConnectionPoolSize(int connectionPoolSize)
Redis connection pool sizeDefault is
64
- Parameters:
connectionPoolSize
- - pool size- Returns:
- config
-
getConnectionPoolSize
public int getConnectionPoolSize()
-
setSubscriptionConnectionPoolSize
public SingleServerConfig setSubscriptionConnectionPoolSize(int subscriptionConnectionPoolSize)
Redis subscription-connection pool size limitDefault is 50
- Parameters:
subscriptionConnectionPoolSize
- - pool size- Returns:
- config
-
getSubscriptionConnectionPoolSize
public int getSubscriptionConnectionPoolSize()
-
setAddress
public SingleServerConfig setAddress(String address)
Set server address. Use follow format -- host:port- Parameters:
address
- of Redis- Returns:
- config
-
getAddress
public URI getAddress()
-
setDnsMonitoringInterval
public SingleServerConfig setDnsMonitoringInterval(long dnsMonitoringInterval)
Interval in milliseconds to check the endpoint's DNSApplications 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()
-
setSubscriptionConnectionMinimumIdleSize
public SingleServerConfig setSubscriptionConnectionMinimumIdleSize(int subscriptionConnectionMinimumIdleSize)
Minimum idle subscription connection amount.Default is 1
- Parameters:
subscriptionConnectionMinimumIdleSize
- - connections amount- Returns:
- config
-
getSubscriptionConnectionMinimumIdleSize
public int getSubscriptionConnectionMinimumIdleSize()
-
setConnectionMinimumIdleSize
public SingleServerConfig setConnectionMinimumIdleSize(int connectionMinimumIdleSize)
Minimum idle Redis connection amount.Default is
10
- Parameters:
connectionMinimumIdleSize
- - connections amount- Returns:
- config
-
getConnectionMinimumIdleSize
public int getConnectionMinimumIdleSize()
-
setDatabase
public SingleServerConfig setDatabase(int database)
Database index used for Redis connection Default is0
- Parameters:
database
- index- 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 isnull
- 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 afterretryAttempts
. But if it sent successfully thentimeout
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:
BaseConfig.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 inNode.ping
andNode.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 atimeout
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 connectionDefault is
false
- Parameters:
keepAlive
- - boolean value- Returns:
- config
-
isTcpNoDelay
public boolean isTcpNoDelay()
-
setTcpNoDelay
public T setTcpNoDelay(boolean tcpNoDelay)
Enables TCP noDelay for connectionDefault is
false
- Parameters:
tcpNoDelay
- - boolean value- Returns:
- config
-
-