Config (Redisson 3.12.4 API)

java.lang.Object
- org.redisson.config.Config

Direct Known Subclasses:

RedissonNodeConfig
```
public class Config
extends Object
```
Redisson configuration

Author:

Nikita Koksharov

Constructor Summary

Constructors
Constructor and Description

Config()

Config(Config oldConf)

Constructors
Constructor and Description
`Config()`
`Config(Config oldConf)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Config`	`fromJSON(File file)` Deprecated.
`static Config`	`fromJSON(File file, ClassLoader classLoader)` Deprecated.
`static Config`	`fromJSON(InputStream inputStream)` Deprecated.
`static Config`	`fromJSON(Reader reader)` Deprecated.
`static Config`	`fromJSON(String content)` Deprecated.
`static Config`	`fromJSON(URL url)` Deprecated.
`static Config`	`fromYAML(File file)` Read config object stored in YAML format from `File`
`static Config`	`fromYAML(File file, ClassLoader classLoader)`
`static Config`	`fromYAML(InputStream inputStream)` Read config object stored in YAML format from `InputStream`
`static Config`	`fromYAML(Reader reader)` Read config object stored in YAML format from `Reader`
`static Config`	`fromYAML(String content)` Read config object stored in YAML format from `String`
`static Config`	`fromYAML(URL url)` Read config object stored in YAML format from `URL`
`AddressResolverGroupFactory`	`getAddressResolverGroupFactory()`
`int`	`getCleanUpKeysAmount()`
`Codec`	`getCodec()`
`io.netty.channel.EventLoopGroup`	`getEventLoopGroup()`
`ExecutorService`	`getExecutor()`
`long`	`getLockWatchdogTimeout()`
`int`	`getMaxCleanUpDelay()`
`int`	`getMinCleanUpDelay()`
`NettyHook`	`getNettyHook()`
`int`	`getNettyThreads()`
`int`	`getThreads()`
`TransportMode`	`getTransportMode()`
`boolean`	`isClusterConfig()`
`boolean`	`isDecodeInExecutor()`
`boolean`	`isKeepPubSubOrder()`
`boolean`	`isReferenceEnabled()` Config option indicate whether Redisson Reference feature is enabled.
`boolean`	`isSentinelConfig()`
`boolean`	`isUseScriptCache()`
`boolean`	`isUseThreadClassLoader()`
`Config`	`setAddressResolverGroupFactory(AddressResolverGroupFactory addressResolverGroupFactory)` Used to switch between `DnsAddressResolverGroup` implementations.
`Config`	`setCleanUpKeysAmount(int cleanUpKeysAmount)` Defines expired keys amount deleted per single operation during clean up process of expired entries.
`Config`	`setCodec(Codec codec)` Redis key/value codec.
`Config`	`setDecodeInExecutor(boolean decodeInExecutor)` Deprecated.
`Config`	`setEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)` Use external EventLoopGroup.
`Config`	`setExecutor(ExecutorService executor)` Use external ExecutorService.
`Config`	`setKeepPubSubOrder(boolean keepPubSubOrder)` Defines whether to keep PubSub messages handling in arrival order or handle messages concurrently.
`Config`	`setLockWatchdogTimeout(long lockWatchdogTimeout)` This parameter is only used if lock has been acquired without leaseTimeout parameter definition.
`Config`	`setMaxCleanUpDelay(int maxCleanUpDelay)` Defines maximum delay in seconds for clean up process of expired entries.
`Config`	`setMinCleanUpDelay(int minCleanUpDelay)` Defines minimum delay in seconds for clean up process of expired entries.
`Config`	`setNettyHook(NettyHook nettyHook)` Netty hook applied to Netty Bootstrap and Channel objects.
`Config`	`setNettyThreads(int nettyThreads)` Threads amount shared between all redis clients used by Redisson.
`void`	`setReferenceEnabled(boolean redissonReferenceEnabled)` Config option for enabling Redisson Reference feature Default value is `true`
`Config`	`setThreads(int threads)` Threads amount shared across all listeners of `RTopic` object, invocation handlers of `RRemoteService` object and `RExecutorService` tasks.
`Config`	`setTransportMode(TransportMode transportMode)` Transport mode Default is `TransportMode.NIO`
`Config`	`setUseScriptCache(boolean useScriptCache)` Defines whether to use Lua-script cache on Redis side.
`Config`	`setUseThreadClassLoader(boolean useThreadClassLoader)` Defines whether to supply Thread ContextClassLoader to Codec.
`String`	`toJSON()` Deprecated.
`String`	`toYAML()` Convert current configuration to YAML format
`ClusterServersConfig`	`useClusterServers()` Init cluster servers configuration
`void`	`useCustomServers(ConnectionManager connectionManager)` This is an extension point to supply custom connection manager.
`MasterSlaveServersConfig`	`useMasterSlaveServers()` Init master/slave servers configuration.
`ReplicatedServersConfig`	`useReplicatedServers()` Init Replicated servers configuration.
`SentinelServersConfig`	`useSentinelServers()` Init sentinel servers configuration.
`SingleServerConfig`	`useSingleServer()` Init single server configuration.

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

- Constructor Detail
  - Config
```
public Config()
```
  - Config
```
public Config(Config oldConf)
```
- Method Detail
  - getNettyHook
```
public NettyHook getNettyHook()
```
  - setNettyHook
```
public Config setNettyHook(NettyHook nettyHook)
```
    Netty hook applied to Netty Bootstrap and Channel objects.
    
    Parameters:
    
    nettyHook - - netty hook object
    
    Returns:
    
    config
  - setCodec
```
public Config setCodec(Codec codec)
```
    Redis key/value codec. Default is FST codec
    
    Parameters:
    
    codec - object
    
    Returns:
    
    config
    
    See Also:
    
    Codec
  - getCodec
```
public Codec getCodec()
```
  - isReferenceEnabled
```
public boolean isReferenceEnabled()
```
    Config option indicate whether Redisson Reference feature is enabled.
    Default value is true
    
    Returns:
    
    true if Redisson Reference feature enabled
  - setReferenceEnabled
```
public void setReferenceEnabled(boolean redissonReferenceEnabled)
```
    Config option for enabling Redisson Reference feature
    Default value is true
    
    Parameters:
    
    redissonReferenceEnabled - flag
  - useClusterServers
```
public ClusterServersConfig useClusterServers()
```
    Init cluster servers configuration
    
    Returns:
    
    config
  - useReplicatedServers
```
public ReplicatedServersConfig useReplicatedServers()
```
    Init Replicated servers configuration. Most used with Azure Redis Cache or AWS Elasticache
    
    Returns:
    
    ReplicatedServersConfig
  - useCustomServers
```
public void useCustomServers(ConnectionManager connectionManager)
```
    This is an extension point to supply custom connection manager.
    
    Parameters:
    
    connectionManager - for supply
    
    See Also:
    
    on how to implement a connection manager.
  - useSingleServer
```
public SingleServerConfig useSingleServer()
```
    Init single server configuration.
    
    Returns:
    
    SingleServerConfig
  - useSentinelServers
```
public SentinelServersConfig useSentinelServers()
```
    Init sentinel servers configuration.
    
    Returns:
    
    SentinelServersConfig
  - useMasterSlaveServers
```
public MasterSlaveServersConfig useMasterSlaveServers()
```
    Init master/slave servers configuration.
    
    Returns:
    
    MasterSlaveServersConfig
  - isClusterConfig
```
public boolean isClusterConfig()
```
  - isSentinelConfig
```
public boolean isSentinelConfig()
```
  - getThreads
```
public int getThreads()
```
  - setThreads
```
public Config setThreads(int threads)
```
    Threads amount shared across all listeners of RTopic object, invocation handlers of RRemoteService object and RExecutorService tasks.
    Default is 16.
    0 means current_processors_amount * 2
    
    Parameters:
    
    threads - amount
    
    Returns:
    
    config
  - setTransportMode
```
public Config setTransportMode(TransportMode transportMode)
```
    Transport mode
    Default is TransportMode.NIO
    
    Parameters:
    
    transportMode - param
    
    Returns:
    
    config
  - getTransportMode
```
public TransportMode getTransportMode()
```
  - setNettyThreads
```
public Config setNettyThreads(int nettyThreads)
```
    Threads amount shared between all redis clients used by Redisson.
    Default is 32.
    0 means current_processors_amount * 2
    
    Parameters:
    
    nettyThreads - amount
    
    Returns:
    
    config
  - getNettyThreads
```
public int getNettyThreads()
```
  - setExecutor
```
public Config setExecutor(ExecutorService executor)
```
    Use external ExecutorService. ExecutorService processes all listeners of RTopic, RRemoteService invocation handlers and RExecutorService tasks.
    The caller is responsible for closing the ExecutorService.
    
    Parameters:
    
    executor - object
    
    Returns:
    
    config
  - getExecutor
```
public ExecutorService getExecutor()
```
  - setEventLoopGroup
```
public Config setEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)
```
    Use external EventLoopGroup. EventLoopGroup processes all Netty connection tied to Redis servers. Each EventLoopGroup creates own threads and each Redisson client creates own EventLoopGroup by default. So if there are multiple Redisson instances in same JVM it would be useful to share one EventLoopGroup among them.
    Only EpollEventLoopGroup, KQueueEventLoopGroup NioEventLoopGroup can be used.
    The caller is responsible for closing the EventLoopGroup.
    
    Parameters:
    
    eventLoopGroup - object
    
    Returns:
    
    config
  - getEventLoopGroup
```
public io.netty.channel.EventLoopGroup getEventLoopGroup()
```
  - setLockWatchdogTimeout
```
public Config setLockWatchdogTimeout(long lockWatchdogTimeout)
```
    This parameter is only used if lock has been acquired without leaseTimeout parameter definition. Lock expires after lockWatchdogTimeout if watchdog didn't extend it to next lockWatchdogTimeout time interval.
    This prevents against infinity locked locks due to Redisson client crush or any other reason when lock can't be released in proper way.
    Default is 30000 milliseconds
    
    Parameters:
    
    lockWatchdogTimeout - timeout in milliseconds
    
    Returns:
    
    config
  - getLockWatchdogTimeout
```
public long getLockWatchdogTimeout()
```
  - setKeepPubSubOrder
```
public Config setKeepPubSubOrder(boolean keepPubSubOrder)
```
    Defines whether to keep PubSub messages handling in arrival order or handle messages concurrently.
    This setting applied only for PubSub messages per channel.
    Default is true.
    
    Parameters:
    
    keepPubSubOrder - - true if order required, false otherwise.
    
    Returns:
    
    config
  - isKeepPubSubOrder
```
public boolean isKeepPubSubOrder()
```
  - setAddressResolverGroupFactory
```
public Config setAddressResolverGroupFactory(AddressResolverGroupFactory addressResolverGroupFactory)
```
    Used to switch between DnsAddressResolverGroup implementations. Switch to round robin RoundRobinDnsAddressResolverGroup when you need to optimize the url resolving.
    
    Parameters:
    
    addressResolverGroupFactory -
    
    Returns:
    
    config
  - getAddressResolverGroupFactory
```
public AddressResolverGroupFactory getAddressResolverGroupFactory()
```
  - fromJSON
```
@Deprecated
public static Config fromJSON(String content)
                                    throws IOException
```
    Deprecated.
    
    Throws:
    
    IOException
  - fromJSON
```
@Deprecated
public static Config fromJSON(InputStream inputStream)
                                    throws IOException
```
    Deprecated.
    
    Throws:
    
    IOException
  - fromJSON
```
@Deprecated
public static Config fromJSON(File file,
                                           ClassLoader classLoader)
                                    throws IOException
```
    Deprecated.
    
    Throws:
    
    IOException
  - fromJSON
```
@Deprecated
public static Config fromJSON(File file)
                                    throws IOException
```
    Deprecated.
    
    Throws:
    
    IOException
  - fromJSON
```
@Deprecated
public static Config fromJSON(URL url)
                                    throws IOException
```
    Deprecated.
    
    Throws:
    
    IOException
  - fromJSON
```
@Deprecated
public static Config fromJSON(Reader reader)
                                    throws IOException
```
    Deprecated.
    
    Throws:
    
    IOException
  - toJSON
```
@Deprecated
public String toJSON()
                           throws IOException
```
    Deprecated.
    
    Throws:
    
    IOException
  - fromYAML
```
public static Config fromYAML(String content)
                       throws IOException
```
    Read config object stored in YAML format from String
    
    Parameters:
    
    content - of config
    
    Returns:
    
    config
    
    Throws:
    
    IOException - error
  - fromYAML
```
public static Config fromYAML(InputStream inputStream)
                       throws IOException
```
    Read config object stored in YAML format from InputStream
    
    Parameters:
    
    inputStream - object
    
    Returns:
    
    config
    
    Throws:
    
    IOException - error
  - fromYAML
```
public static Config fromYAML(File file)
                       throws IOException
```
    Read config object stored in YAML format from File
    
    Parameters:
    
    file - object
    
    Returns:
    
    config
    
    Throws:
    
    IOException - error
  - fromYAML
```
public static Config fromYAML(File file,
                              ClassLoader classLoader)
                       throws IOException
```
    Throws:
    
    IOException
  - fromYAML
```
public static Config fromYAML(URL url)
                       throws IOException
```
    Read config object stored in YAML format from URL
    
    Parameters:
    
    url - object
    
    Returns:
    
    config
    
    Throws:
    
    IOException - error
  - fromYAML
```
public static Config fromYAML(Reader reader)
                       throws IOException
```
    Read config object stored in YAML format from Reader
    
    Parameters:
    
    reader - object
    
    Returns:
    
    config
    
    Throws:
    
    IOException - error
  - toYAML
```
public String toYAML()
              throws IOException
```
    Convert current configuration to YAML format
    
    Returns:
    
    config in yaml format
    
    Throws:
    
    IOException - error
  - setUseScriptCache
```
public Config setUseScriptCache(boolean useScriptCache)
```
    Defines whether to use Lua-script cache on Redis side. Most Redisson methods are Lua-script based and this setting turned on could increase speed of such methods execution and save network traffic.
    NOTE: readMode option is not taken into account for such calls as Redis slave redirects execution of cached Lua-script on Redis master node.
    Default is false.
    
    Parameters:
    
    useScriptCache - - true if Lua-script caching is required, false otherwise.
    
    Returns:
    
    config
  - isUseScriptCache
```
public boolean isUseScriptCache()
```
  - isDecodeInExecutor
```
public boolean isDecodeInExecutor()
```
  - setDecodeInExecutor
```
@Deprecated
public Config setDecodeInExecutor(boolean decodeInExecutor)
```
    Deprecated.
    
    Defines whether to decode data by codec in executor's threads or netty's threads. If decoding data process takes long time and netty thread is used then `RedisTimeoutException` could arise time to time.
    Default is false.
    
    Parameters:
    
    decodeInExecutor - - true to use executor's threads, false to use netty's threads.
    
    Returns:
    
    config
  - getMinCleanUpDelay
```
public int getMinCleanUpDelay()
```
  - setMinCleanUpDelay
```
public Config setMinCleanUpDelay(int minCleanUpDelay)
```
    Defines minimum delay in seconds for clean up process of expired entries.
    Applied to JCache, RSetCache, RMapCache, RListMultimapCache, RSetMultimapCache objects.
    Default is 5.
    
    Parameters:
    
    minCleanUpDelay - - delay in seconds
    
    Returns:
    
    config
  - getMaxCleanUpDelay
```
public int getMaxCleanUpDelay()
```
  - setMaxCleanUpDelay
```
public Config setMaxCleanUpDelay(int maxCleanUpDelay)
```
    Defines maximum delay in seconds for clean up process of expired entries.
    Applied to JCache, RSetCache, RMapCache, RListMultimapCache, RSetMultimapCache objects.
    Default is 1800.
    
    Parameters:
    
    maxCleanUpDelay - - delay in seconds
    
    Returns:
    
    config
  - getCleanUpKeysAmount
```
public int getCleanUpKeysAmount()
```
  - setCleanUpKeysAmount
```
public Config setCleanUpKeysAmount(int cleanUpKeysAmount)
```
    Defines expired keys amount deleted per single operation during clean up process of expired entries.
    Applied to JCache, RSetCache, RMapCache, RListMultimapCache, RSetMultimapCache objects.
    Default is 100.
    
    Parameters:
    
    cleanUpKeysAmount - - delay in seconds
    
    Returns:
    
    config
  - isUseThreadClassLoader
```
public boolean isUseThreadClassLoader()
```
  - setUseThreadClassLoader
```
public Config setUseThreadClassLoader(boolean useThreadClassLoader)
```
    Defines whether to supply Thread ContextClassLoader to Codec. Usage of Thread.getContextClassLoader() may resolve ClassNotFoundException error. For example, this error arise if Redisson is used in both Tomcat and deployed application.
    Default is true.
    
    Parameters:
    
    useThreadClassLoader - true if Thread ContextClassLoader is used, false otherwise.
    
    Returns:
    
    config

Class Config

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Config

Config

Method Detail

getNettyHook

setNettyHook

setCodec

getCodec

isReferenceEnabled

setReferenceEnabled

useClusterServers

useReplicatedServers

useCustomServers

useSingleServer

useSentinelServers

useMasterSlaveServers

isClusterConfig

isSentinelConfig

getThreads

setThreads

setTransportMode

getTransportMode

setNettyThreads

getNettyThreads

setExecutor

getExecutor

setEventLoopGroup

getEventLoopGroup

setLockWatchdogTimeout

getLockWatchdogTimeout

setKeepPubSubOrder

isKeepPubSubOrder

setAddressResolverGroupFactory

getAddressResolverGroupFactory

fromJSON

fromJSON

fromJSON

fromJSON

fromJSON

fromJSON

toJSON

fromYAML

fromYAML

fromYAML

fromYAML

fromYAML

fromYAML

toYAML

setUseScriptCache

isUseScriptCache

isDecodeInExecutor

setDecodeInExecutor

getMinCleanUpDelay

setMinCleanUpDelay

getMaxCleanUpDelay

setMaxCleanUpDelay

getCleanUpKeysAmount

setCleanUpKeysAmount

isUseThreadClassLoader

setUseThreadClassLoader