Class Redisson
- All Implemented Interfaces:
RedissonClient
- Author:
- Nikita Koksharov
-
Field Summary
Modifier and TypeFieldDescriptionprotected final CommandAsyncExecutor
protected final Config
protected final ConnectionManager
protected final EvictionScheduler
protected final ConcurrentMap<Class<?>,
Class<?>> protected final QueueTransferService
protected final ConcurrentMap<String,
ResponseEntry> protected final WriteBehindService
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RedissonClient
create()
Create sync/async Redisson instance with default configstatic RedissonClient
Create sync/async Redisson instance with provided configCreates batch object which could be executed later with collected group of commands in pipeline mode.createBatch
(BatchOptions options) Creates batch object which could be executed later with collected group of commands in pipeline mode.static RedissonReactiveClient
Deprecated.static RedissonReactiveClient
createReactive
(Config config) Deprecated.static RedissonRxClient
createRx()
Deprecated.static RedissonRxClient
Deprecated.createTransaction
(TransactionOptions options) Creates transaction with READ_COMMITTED isolation level.getAtomicDouble
(String name) Returns atomicDouble instance by name.getAtomicLong
(String name) Returns atomicLong instance by name.getBinaryStream
(String name) Returns binary stream holder instance byname
Returns bitSet instance by name.<V> RBlockingDeque<V>
getBlockingDeque
(String name) Returns unbounded blocking deque instance by name.<V> RBlockingDeque<V>
getBlockingDeque
(String name, Codec codec) Returns unbounded blocking deque instance by name using provided codec for deque objects.<V> RBlockingQueue<V>
getBlockingQueue
(String name) Returns unbounded blocking queue instance by name.<V> RBlockingQueue<V>
getBlockingQueue
(String name, Codec codec) Returns unbounded blocking queue instance by name using provided codec for queue objects.<V> RBloomFilter<V>
getBloomFilter
(String name) Returns bloom filter instance by name.<V> RBloomFilter<V>
getBloomFilter
(String name, Codec codec) Returns bloom filter instance by name using provided codec for objects.<V> RBoundedBlockingQueue<V>
Returns bounded blocking queue instance by name.<V> RBoundedBlockingQueue<V>
getBoundedBlockingQueue
(String name, Codec codec) Returns bounded blocking queue instance by name using provided codec for queue objects.<V> RBucket<V>
Returns object holder instance by name.<V> RBucket<V>
Returns object holder instance by name using provided codec for object.Returns interface for mass operations with Bucket objects.getBuckets
(Codec codec) Returns interface for mass operations with Bucket objects using provided codec for object.Allows to get configuration provided during Redisson instance creation.getCountDownLatch
(String name) Returns countDownLatch instance by name.<V> RDelayedQueue<V>
getDelayedQueue
(RQueue<V> destinationQueue) Returns unbounded delayed queue instance by name.<V> RDeque<V>
Returns unbounded deque instance by name.<V> RDeque<V>
Returns unbounded deque instance by name using provided codec for deque objects.getDoubleAdder
(String name) Returns DoubleAdder instances by name.getExecutorService
(String name) Returns ScheduledExecutorService by namegetExecutorService
(String name, ExecutorOptions options) Returns ScheduledExecutorService by namegetExecutorService
(String name, Codec codec) Returns ScheduledExecutorService by name using provided codec for task, response and request serializationgetExecutorService
(String name, Codec codec, ExecutorOptions options) Returns ScheduledExecutorService by name using provided codec for task, response and request serializationgetFairLock
(String name) Returns Lock instance by name.getFencedLock
(String name) Returns interface for Redis Function featuregetFunction
(Codec codec) Returns interface for Redis Function feature using provided codec<V> RGeo<V>
Returns geospatial items holder instance byname
.<V> RGeo<V>
Returns geospatial items holder instance byname
using provided codec for geospatial members.<V> RHyperLogLog<V>
getHyperLogLog
(String name) Returns HyperLogLog instance by name.<V> RHyperLogLog<V>
getHyperLogLog
(String name, Codec codec) Returns HyperLogLog instance by name using provided codec for hll objects.getId()
Returns id of this Redisson instancegetIdGenerator
(String name) Returns id generator by name.<V> RJsonBucket<V>
getJsonBucket
(String name, JsonCodec<V> codec) Returns JSON data holder instance by name using provided codec.getKeys()
Returns interface with methods for Redis keys.getLexSortedSet
(String name) Returns String based Redis Sorted Set instance by name All elements are inserted with the same score during addition, in order to force lexicographical ordering<V> RList<V>
Returns list instance by name.<V> RList<V>
Returns list instance by name using provided codec for list objects.<K,
V> RListMultimap<K, V> getListMultimap
(String name) Returns List based Multimap instance by name.<K,
V> RListMultimap<K, V> getListMultimap
(String name, Codec codec) Returns List based Multimap instance by name using provided codec for both map keys and values.<K,
V> RListMultimapCache<K, V> getListMultimapCache
(String name) Returns List based Multimap instance by name.<K,
V> RListMultimapCache<K, V> getListMultimapCache
(String name, Codec codec) Returns List based Multimap instance by name using provided codec for both map keys and values.Returns RedissonAttachedLiveObjectService which can be used to retrieve live REntity(s)<K,
V> RLocalCachedMap<K, V> getLocalCachedMap
(String name, LocalCachedMapOptions<K, V> options) Returns local cached map instance by name.<K,
V> RLocalCachedMap<K, V> getLocalCachedMap
(String name, Codec codec, LocalCachedMapOptions<K, V> options) Returns local cached map instance by name using provided codec.Returns Lock instance by name.getLongAdder
(String name) Returns LongAdder instances by name.<K,
V> RMap<K, V> Returns map instance by name.<K,
V> RMap<K, V> getMap
(String name, MapOptions<K, V> options) Returns map instance by name.<K,
V> RMap<K, V> Returns map instance by name using provided codec for both map keys and values.<K,
V> RMap<K, V> getMap
(String name, Codec codec, MapOptions<K, V> options) Returns map instance by name using provided codec for both map keys and values.<K,
V> RMapCache<K, V> getMapCache
(String name) Returns map-based cache instance by name.<K,
V> RMapCache<K, V> getMapCache
(String name, MapOptions<K, V> options) Returns map-based cache instance by name.<K,
V> RMapCache<K, V> getMapCache
(String name, Codec codec) Returns map-based cache instance byname
using providedcodec
for both cache keys and values.<K,
V> RMapCache<K, V> getMapCache
(String name, Codec codec, MapOptions<K, V> options) Returns map-based cache instance byname
using providedcodec
for both cache keys and values.getMultiLock
(RLock... locks) Returns MultiLock instance associated with specifiedlocks
getPatternTopic
(String pattern) Returns topic instance satisfies by pattern name.getPatternTopic
(String pattern, Codec codec) Returns topic instance satisfies by pattern name using provided codec for messages.Returns semaphore instance by name.<V> RPriorityBlockingDeque<V>
Returns unbounded priority blocking deque instance by name.<V> RPriorityBlockingDeque<V>
getPriorityBlockingDeque
(String name, Codec codec) Returns unbounded priority blocking deque instance by name using provided codec for queue objects.<V> RPriorityBlockingQueue<V>
Returns unbounded priority blocking queue instance by name.<V> RPriorityBlockingQueue<V>
getPriorityBlockingQueue
(String name, Codec codec) Returns unbounded priority blocking queue instance by name using provided codec for queue objects.<V> RPriorityDeque<V>
getPriorityDeque
(String name) Returns priority unbounded deque instance by name.<V> RPriorityDeque<V>
getPriorityDeque
(String name, Codec codec) Returns priority unbounded deque instance by name using provided codec for queue objects.<V> RPriorityQueue<V>
getPriorityQueue
(String name) Returns priority unbounded queue instance by name.<V> RPriorityQueue<V>
getPriorityQueue
(String name, Codec codec) Returns priority unbounded queue instance by name using provided codec for queue objects.<V> RQueue<V>
Returns unbounded queue instance by name.<V> RQueue<V>
Returns unbounded queue instance by name using provided codec for queue objects.getRateLimiter
(String name) Returns rate limiter instance byname
getReadWriteLock
(String name) Returns ReadWriteLock instance by name.<T extends BaseRedisNodes>
TgetRedisNodes
(RedisNodes<T> nodes) Returns API to manage Redis nodesgetRedLock
(RLock... locks) getReliableTopic
(String name) Returns reliable topic instance by name.getReliableTopic
(String name, Codec codec) Returns reliable topic instance by name using provided codec for messages.Returns object for remote operations prefixed with the default name (redisson_remote_service)getRemoteService
(String name) Returns object for remote operations prefixed with the specified namegetRemoteService
(String name, Codec codec) Returns object for remote operations prefixed with the specified name and uses provided codec for method arguments and result.getRemoteService
(Codec codec) Returns object for remote operations prefixed with the default name (redisson_remote_service) and uses provided codec for method arguments and result.<V> RRingBuffer<V>
getRingBuffer
(String name) Returns RingBuffer based queue.<V> RRingBuffer<V>
getRingBuffer
(String name, Codec codec) Returns RingBuffer based queue.<V> RScoredSortedSet<V>
getScoredSortedSet
(String name) Returns Redis Sorted Set instance by name.<V> RScoredSortedSet<V>
getScoredSortedSet
(String name, Codec codec) Returns Redis Sorted Set instance by name using provided codec for sorted set objects.Returns script operations objectReturns script operations object using provided codec.Returns API for RediSearch moduleReturns API for RediSearch module using defined codec for attribute values.getSemaphore
(String name) Returns semaphore instance by name<V> RSet<V>
Returns set instance by name.<V> RSet<V>
Returns set instance by name using provided codec for set objects.<V> RSetCache<V>
getSetCache
(String name) Returns set-based cache instance byname
.<V> RSetCache<V>
getSetCache
(String name, Codec codec) Returns set-based cache instance byname
.<K,
V> RSetMultimap<K, V> getSetMultimap
(String name) Returns Set based Multimap instance by name.<K,
V> RSetMultimap<K, V> getSetMultimap
(String name, Codec codec) Returns Set based Multimap instance by name using provided codec for both map keys and values.<K,
V> RSetMultimapCache<K, V> getSetMultimapCache
(String name) Returns Set based Multimap instance by name.<K,
V> RSetMultimapCache<K, V> getSetMultimapCache
(String name, Codec codec) Returns Set based Multimap instance by name using provided codec for both map keys and values.getShardedTopic
(String name) Returns Sharded Topic instance by name.getShardedTopic
(String name, Codec codec) Returns Sharded Topic instance by name using provided codec for messages.<V> RSortedSet<V>
getSortedSet
(String name) Returns sorted set instance by name.<V> RSortedSet<V>
getSortedSet
(String name, Codec codec) Returns sorted set instance by name using provided codec for sorted set objects.getSpinLock
(String name) Returns Spin lock instance by name.getSpinLock
(String name, LockOptions.BackOff backOff) Returns Spin lock instance by name with specified back off options.<K,
V> RStream<K, V> Returns stream instance byname
<K,
V> RStream<K, V> Returns stream instance byname
using providedcodec
for entries.<V,
L> RTimeSeries<V, L> getTimeSeries
(String name) Returns time-series instance byname
<V,
L> RTimeSeries<V, L> getTimeSeries
(String name, Codec codec) Returns time-series instance byname
using providedcodec
for values.Returns topic instance by name.Returns topic instance by name using provided codec for messages.<V> RTransferQueue<V>
getTransferQueue
(String name) Returns transfer queue instance by name.<V> RTransferQueue<V>
getTransferQueue
(String name, Codec codec) Returns transfer queue instance by name using provided codec for queue objects.boolean
Returnstrue
if this Redisson instance has been shut down.boolean
Returnstrue
if this Redisson instance was started to be shutdown or was shutdownRedissonClient.isShutdown()
already.reactive()
Returns Reactive Redisson instancerxJava()
Returns RxJava Redisson instancevoid
shutdown()
Shutdown Redisson instance but NOT Redis server This equates to invoke shutdown(0, 2, TimeUnit.SECONDS);void
Shuts down Redisson instance but NOT Redis server Shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down.
-
Field Details
-
queueTransferService
-
evictionScheduler
-
writeBehindService
-
connectionManager
-
commandExecutor
-
liveObjectClassCache
-
config
-
responses
-
-
Constructor Details
-
Redisson
-
-
Method Details
-
getEvictionScheduler
-
getCommandExecutor
-
getConnectionManager
-
getServiceManager
-
create
Create sync/async Redisson instance with default config- Returns:
- Redisson instance
-
create
Create sync/async Redisson instance with provided config- Parameters:
config
- for Redisson- Returns:
- Redisson instance
-
createRx
Deprecated. -
createRx
Deprecated. -
rxJava
Description copied from interface:RedissonClient
Returns RxJava Redisson instance- Specified by:
rxJava
in interfaceRedissonClient
- Returns:
- redisson instance
-
createReactive
Deprecated. -
createReactive
Deprecated. -
reactive
Description copied from interface:RedissonClient
Returns Reactive Redisson instance- Specified by:
reactive
in interfaceRedissonClient
- Returns:
- redisson instance
-
getTimeSeries
Description copied from interface:RedissonClient
Returns time-series instance byname
- Specified by:
getTimeSeries
in interfaceRedissonClient
- Type Parameters:
V
- value typeL
- label type- Parameters:
name
- - name of instance- Returns:
- RTimeSeries object
-
getTimeSeries
Description copied from interface:RedissonClient
Returns time-series instance byname
using providedcodec
for values.- Specified by:
getTimeSeries
in interfaceRedissonClient
- Type Parameters:
V
- value typeL
- label type- Parameters:
name
- - name of instancecodec
- - codec for values- Returns:
- RTimeSeries object
-
getStream
Description copied from interface:RedissonClient
Returns stream instance byname
Requires Redis 5.0.0 and higher.
- Specified by:
getStream
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- of stream- Returns:
- RStream object
-
getStream
Description copied from interface:RedissonClient
Returns stream instance byname
using providedcodec
for entries.Requires Redis 5.0.0 and higher.
- Specified by:
getStream
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of streamcodec
- - codec for entry- Returns:
- RStream object
-
getSearch
Description copied from interface:RedissonClient
Returns API for RediSearch module- Specified by:
getSearch
in interfaceRedissonClient
- Returns:
- RSearch object
-
getSearch
Description copied from interface:RedissonClient
Returns API for RediSearch module using defined codec for attribute values.- Specified by:
getSearch
in interfaceRedissonClient
- Returns:
- RSearch object
-
getBinaryStream
Description copied from interface:RedissonClient
Returns binary stream holder instance byname
- Specified by:
getBinaryStream
in interfaceRedissonClient
- Parameters:
name
- of binary stream- Returns:
- BinaryStream object
-
getGeo
Description copied from interface:RedissonClient
Returns geospatial items holder instance byname
.- Specified by:
getGeo
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- Geo object
-
getGeo
Description copied from interface:RedissonClient
Returns geospatial items holder instance byname
using provided codec for geospatial members.- Specified by:
getGeo
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for value- Returns:
- Geo object
-
getBucket
Description copied from interface:RedissonClient
Returns object holder instance by name.- Specified by:
getBucket
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- Bucket object
-
getRateLimiter
Description copied from interface:RedissonClient
Returns rate limiter instance byname
- Specified by:
getRateLimiter
in interfaceRedissonClient
- Parameters:
name
- of rate limiter- Returns:
- RateLimiter object
-
getBucket
Description copied from interface:RedissonClient
Returns object holder instance by name using provided codec for object.- Specified by:
getBucket
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for values- Returns:
- Bucket object
-
getBuckets
Description copied from interface:RedissonClient
Returns interface for mass operations with Bucket objects.- Specified by:
getBuckets
in interfaceRedissonClient
- Returns:
- Buckets
-
getBuckets
Description copied from interface:RedissonClient
Returns interface for mass operations with Bucket objects using provided codec for object.- Specified by:
getBuckets
in interfaceRedissonClient
- Parameters:
codec
- - codec for bucket objects- Returns:
- Buckets
-
getJsonBucket
Description copied from interface:RedissonClient
Returns JSON data holder instance by name using provided codec.- Specified by:
getJsonBucket
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- name of objectcodec
- codec for values- Returns:
- JsonBucket object
-
getHyperLogLog
Description copied from interface:RedissonClient
Returns HyperLogLog instance by name.- Specified by:
getHyperLogLog
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- HyperLogLog object
-
getHyperLogLog
Description copied from interface:RedissonClient
Returns HyperLogLog instance by name using provided codec for hll objects.- Specified by:
getHyperLogLog
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for values- Returns:
- HyperLogLog object
-
getList
Description copied from interface:RedissonClient
Returns list instance by name.- Specified by:
getList
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- List object
-
getList
Description copied from interface:RedissonClient
Returns list instance by name using provided codec for list objects.- Specified by:
getList
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for values- Returns:
- List object
-
getListMultimap
Description copied from interface:RedissonClient
Returns List based Multimap instance by name.- Specified by:
getListMultimap
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of object- Returns:
- ListMultimap object
-
getListMultimap
Description copied from interface:RedissonClient
Returns List based Multimap instance by name using provided codec for both map keys and values.- Specified by:
getListMultimap
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of objectcodec
- - codec for keys and values- Returns:
- ListMultimap object
-
getLocalCachedMap
public <K,V> RLocalCachedMap<K,V> getLocalCachedMap(String name, LocalCachedMapOptions<K, V> options) Description copied from interface:RedissonClient
Returns local cached map instance by name. Configured by parameters of options-object.- Specified by:
getLocalCachedMap
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of objectoptions
- - local map options- Returns:
- LocalCachedMap object
-
getLocalCachedMap
public <K,V> RLocalCachedMap<K,V> getLocalCachedMap(String name, Codec codec, LocalCachedMapOptions<K, V> options) Description copied from interface:RedissonClient
Returns local cached map instance by name using provided codec. Configured by parameters of options-object.- Specified by:
getLocalCachedMap
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of objectcodec
- - codec for keys and valuesoptions
- - local map options- Returns:
- LocalCachedMap object
-
getMap
Description copied from interface:RedissonClient
Returns map instance by name.- Specified by:
getMap
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of object- Returns:
- Map object
-
getMap
Description copied from interface:RedissonClient
Returns map instance by name.- Specified by:
getMap
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of objectoptions
- - map options- Returns:
- Map object
-
getSetMultimap
Description copied from interface:RedissonClient
Returns Set based Multimap instance by name.- Specified by:
getSetMultimap
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of object- Returns:
- SetMultimap object
-
getSetMultimapCache
Description copied from interface:RedissonClient
Returns Set based Multimap instance by name. Supports key-entry eviction with a given TTL value.If eviction is not required then it's better to use regular map
RedissonClient.getSetMultimap(String)
.- Specified by:
getSetMultimapCache
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of object- Returns:
- SetMultimapCache object
-
getSetMultimapCache
Description copied from interface:RedissonClient
Returns Set based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.If eviction is not required then it's better to use regular map
RedissonClient.getSetMultimap(String, Codec)
.- Specified by:
getSetMultimapCache
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of objectcodec
- - codec for keys and values- Returns:
- SetMultimapCache object
-
getListMultimapCache
Description copied from interface:RedissonClient
Returns List based Multimap instance by name. Supports key-entry eviction with a given TTL value.If eviction is not required then it's better to use regular map
RedissonClient.getSetMultimap(String)
.- Specified by:
getListMultimapCache
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of object- Returns:
- ListMultimapCache object
-
getListMultimapCache
Description copied from interface:RedissonClient
Returns List based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.If eviction is not required then it's better to use regular map
RedissonClient.getSetMultimap(String, Codec)
.- Specified by:
getListMultimapCache
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of objectcodec
- - codec for keys and values- Returns:
- ListMultimapCache object
-
getSetMultimap
Description copied from interface:RedissonClient
Returns Set based Multimap instance by name using provided codec for both map keys and values.- Specified by:
getSetMultimap
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of objectcodec
- - codec for keys and values- Returns:
- SetMultimap object
-
getSetCache
Description copied from interface:RedissonClient
Returns set-based cache instance byname
. Supports value eviction with a given TTL value.If eviction is not required then it's better to use regular map
RedissonClient.getSet(String, Codec)
.- Specified by:
getSetCache
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- SetCache object
-
getSetCache
Description copied from interface:RedissonClient
Returns set-based cache instance byname
. Supports value eviction with a given TTL value.If eviction is not required then it's better to use regular map
RedissonClient.getSet(String, Codec)
.- Specified by:
getSetCache
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for values- Returns:
- SetCache object
-
getMapCache
Description copied from interface:RedissonClient
Returns map-based cache instance by name. Supports entry eviction with a given MaxIdleTime and TTL settings.If eviction is not required then it's better to use regular map
RedissonClient.getMap(String)
.- Specified by:
getMapCache
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of object- Returns:
- MapCache object
-
getMapCache
Description copied from interface:RedissonClient
Returns map-based cache instance by name. Supports entry eviction with a given MaxIdleTime and TTL settings.If eviction is not required then it's better to use regular map
RedissonClient.getMap(String)
.- Specified by:
getMapCache
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of objectoptions
- - map options- Returns:
- MapCache object
-
getMapCache
Description copied from interface:RedissonClient
Returns map-based cache instance byname
using providedcodec
for both cache keys and values. Supports entry eviction with a given MaxIdleTime and TTL settings.If eviction is not required then it's better to use regular map
RedissonClient.getMap(String, Codec)
.- Specified by:
getMapCache
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - object namecodec
- - codec for keys and values- Returns:
- MapCache object
-
getMapCache
Description copied from interface:RedissonClient
Returns map-based cache instance byname
using providedcodec
for both cache keys and values. Supports entry eviction with a given MaxIdleTime and TTL settings.If eviction is not required then it's better to use regular map
RedissonClient.getMap(String, Codec)
.- Specified by:
getMapCache
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - object namecodec
- - codec for keys and valuesoptions
- - map options- Returns:
- MapCache object
-
getMap
Description copied from interface:RedissonClient
Returns map instance by name using provided codec for both map keys and values.- Specified by:
getMap
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of objectcodec
- - codec for keys and values- Returns:
- Map object
-
getMap
Description copied from interface:RedissonClient
Returns map instance by name using provided codec for both map keys and values.- Specified by:
getMap
in interfaceRedissonClient
- Type Parameters:
K
- type of keyV
- type of value- Parameters:
name
- - name of objectcodec
- - codec for keys and valuesoptions
- - map options- Returns:
- Map object
-
getLock
Description copied from interface:RedissonClient
Returns Lock instance by name.Implements a non-fair locking so doesn't guarantees an acquire order by threads.
To increase reliability during failover, all operations wait for propagation to all Redis slaves.
- Specified by:
getLock
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- Lock object
-
getSpinLock
Description copied from interface:RedissonClient
Returns Spin lock instance by name.Implements a non-fair locking so doesn't guarantees an acquire order by threads.
Lock doesn't use a pub/sub mechanism
- Specified by:
getSpinLock
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- Lock object
-
getSpinLock
Description copied from interface:RedissonClient
Returns Spin lock instance by name with specified back off options.Implements a non-fair locking so doesn't guarantees an acquire order by threads.
Lock doesn't use a pub/sub mechanism
- Specified by:
getSpinLock
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- Lock object
-
getFencedLock
- Specified by:
getFencedLock
in interfaceRedissonClient
-
getMultiLock
Description copied from interface:RedissonClient
Returns MultiLock instance associated with specifiedlocks
- Specified by:
getMultiLock
in interfaceRedissonClient
- Parameters:
locks
- - collection of locks- Returns:
- MultiLock object
-
getRedLock
- Specified by:
getRedLock
in interfaceRedissonClient
-
getFairLock
Description copied from interface:RedissonClient
Returns Lock instance by name.Implements a fair locking so it guarantees an acquire order by threads.
To increase reliability during failover, all operations wait for propagation to all Redis slaves.
- Specified by:
getFairLock
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- Lock object
-
getReadWriteLock
Description copied from interface:RedissonClient
Returns ReadWriteLock instance by name.To increase reliability during failover, all operations wait for propagation to all Redis slaves.
- Specified by:
getReadWriteLock
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- Lock object
-
getSet
Description copied from interface:RedissonClient
Returns set instance by name.- Specified by:
getSet
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- Set object
-
getSet
Description copied from interface:RedissonClient
Returns set instance by name using provided codec for set objects.- Specified by:
getSet
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for values- Returns:
- Set object
-
getFunction
Description copied from interface:RedissonClient
Returns interface for Redis Function feature- Specified by:
getFunction
in interfaceRedissonClient
- Returns:
- function object
-
getFunction
Description copied from interface:RedissonClient
Returns interface for Redis Function feature using provided codec- Specified by:
getFunction
in interfaceRedissonClient
- Parameters:
codec
- - codec for params and result- Returns:
- function interface
-
getScript
Description copied from interface:RedissonClient
Returns script operations object- Specified by:
getScript
in interfaceRedissonClient
- Returns:
- Script object
-
getScript
Description copied from interface:RedissonClient
Returns script operations object using provided codec.- Specified by:
getScript
in interfaceRedissonClient
- Parameters:
codec
- - codec for params and result- Returns:
- Script object
-
getExecutorService
Description copied from interface:RedissonClient
Returns ScheduledExecutorService by name- Specified by:
getExecutorService
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- ScheduledExecutorService object
-
getExecutorService
Description copied from interface:RedissonClient
Returns ScheduledExecutorService by name- Specified by:
getExecutorService
in interfaceRedissonClient
- Parameters:
name
- - name of objectoptions
- - options for executor- Returns:
- ScheduledExecutorService object
-
getExecutorService
Description copied from interface:RedissonClient
Returns ScheduledExecutorService by name using provided codec for task, response and request serialization- Specified by:
getExecutorService
in interfaceRedissonClient
- Parameters:
name
- - name of objectcodec
- - codec for task, response and request- Returns:
- ScheduledExecutorService object
-
getExecutorService
public RScheduledExecutorService getExecutorService(String name, Codec codec, ExecutorOptions options) Description copied from interface:RedissonClient
Returns ScheduledExecutorService by name using provided codec for task, response and request serialization- Specified by:
getExecutorService
in interfaceRedissonClient
- Parameters:
name
- - name of objectcodec
- - codec for task, response and requestoptions
- - options for executor- Returns:
- ScheduledExecutorService object
-
getRemoteService
Description copied from interface:RedissonClient
Returns object for remote operations prefixed with the default name (redisson_remote_service)- Specified by:
getRemoteService
in interfaceRedissonClient
- Returns:
- RemoteService object
-
getRemoteService
Description copied from interface:RedissonClient
Returns object for remote operations prefixed with the specified name- Specified by:
getRemoteService
in interfaceRedissonClient
- Parameters:
name
- - the name used as the Redis key prefix for the services- Returns:
- RemoteService object
-
getRemoteService
Description copied from interface:RedissonClient
Returns object for remote operations prefixed with the default name (redisson_remote_service) and uses provided codec for method arguments and result.- Specified by:
getRemoteService
in interfaceRedissonClient
- Parameters:
codec
- - codec for response and request- Returns:
- RemoteService object
-
getRemoteService
Description copied from interface:RedissonClient
Returns object for remote operations prefixed with the specified name and uses provided codec for method arguments and result.- Specified by:
getRemoteService
in interfaceRedissonClient
- Parameters:
name
- - the name used as the Redis key prefix for the servicescodec
- - codec for response and request- Returns:
- RemoteService object
-
getSortedSet
Description copied from interface:RedissonClient
Returns sorted set instance by name. This sorted set uses comparator to sort objects.- Specified by:
getSortedSet
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- SortedSet object
-
getSortedSet
Description copied from interface:RedissonClient
Returns sorted set instance by name using provided codec for sorted set objects. This sorted set sorts objects using comparator.- Specified by:
getSortedSet
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for values- Returns:
- SortedSet object
-
getScoredSortedSet
Description copied from interface:RedissonClient
Returns Redis Sorted Set instance by name. This sorted set sorts objects by object score.- Specified by:
getScoredSortedSet
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- ScoredSortedSet object
-
getScoredSortedSet
Description copied from interface:RedissonClient
Returns Redis Sorted Set instance by name using provided codec for sorted set objects. This sorted set sorts objects by object score.- Specified by:
getScoredSortedSet
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for values- Returns:
- ScoredSortedSet object
-
getLexSortedSet
Description copied from interface:RedissonClient
Returns String based Redis Sorted Set instance by name All elements are inserted with the same score during addition, in order to force lexicographical ordering- Specified by:
getLexSortedSet
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- LexSortedSet object
-
getShardedTopic
Description copied from interface:RedissonClient
Returns Sharded Topic instance by name.Messages are delivered to message listeners connected to the same Topic.
- Specified by:
getShardedTopic
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- Topic object
-
getShardedTopic
Description copied from interface:RedissonClient
Returns Sharded Topic instance by name using provided codec for messages.Messages are delivered to message listeners connected to the same Topic.
- Specified by:
getShardedTopic
in interfaceRedissonClient
- Parameters:
name
- - name of objectcodec
- - codec for message- Returns:
- Topic object
-
getTopic
Description copied from interface:RedissonClient
Returns topic instance by name.Messages are delivered to message listeners connected to the same Topic.
- Specified by:
getTopic
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- Topic object
-
getTopic
Description copied from interface:RedissonClient
Returns topic instance by name using provided codec for messages.Messages are delivered to message listeners connected to the same Topic.
- Specified by:
getTopic
in interfaceRedissonClient
- Parameters:
name
- - name of objectcodec
- - codec for message- Returns:
- Topic object
-
getReliableTopic
Description copied from interface:RedissonClient
Returns reliable topic instance by name.Dedicated Redis connection is allocated per instance (subscriber) of this object. Messages are delivered to all listeners attached to the same Redis setup.
Requires Redis 5.0.0 and higher.
- Specified by:
getReliableTopic
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- ReliableTopic object
-
getReliableTopic
Description copied from interface:RedissonClient
Returns reliable topic instance by name using provided codec for messages.Dedicated Redis connection is allocated per instance (subscriber) of this object. Messages are delivered to all listeners attached to the same Redis setup.
Requires Redis 5.0.0 and higher.
- Specified by:
getReliableTopic
in interfaceRedissonClient
- Parameters:
name
- - name of objectcodec
- - codec for message- Returns:
- ReliableTopic object
-
getPatternTopic
Description copied from interface:RedissonClient
Returns topic instance satisfies by pattern name. Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo- Specified by:
getPatternTopic
in interfaceRedissonClient
- Parameters:
pattern
- of the topic- Returns:
- PatterTopic object
-
getPatternTopic
Description copied from interface:RedissonClient
Returns topic instance satisfies by pattern name using provided codec for messages. Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo- Specified by:
getPatternTopic
in interfaceRedissonClient
- Parameters:
pattern
- of the topiccodec
- - codec for message- Returns:
- PatterTopic object
-
getDelayedQueue
Description copied from interface:RedissonClient
Returns unbounded delayed queue instance by name.Could be attached to destination queue only. All elements are inserted with transfer delay to destination queue.
- Specified by:
getDelayedQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
destinationQueue
- - destination queue- Returns:
- Delayed queue object
-
getQueue
Description copied from interface:RedissonClient
Returns unbounded queue instance by name.- Specified by:
getQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- of object- Returns:
- queue object
-
getQueue
Description copied from interface:RedissonClient
Returns unbounded queue instance by name using provided codec for queue objects.- Specified by:
getQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for message- Returns:
- Queue object
-
getTransferQueue
Description copied from interface:RedissonClient
Returns transfer queue instance by name.- Specified by:
getTransferQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of values- Parameters:
name
- - name of object- Returns:
- TransferQueue object
-
getTransferQueue
Description copied from interface:RedissonClient
Returns transfer queue instance by name using provided codec for queue objects.- Specified by:
getTransferQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of values- Parameters:
name
- - name of objectcodec
- - code for values- Returns:
- TransferQueue object
-
getRingBuffer
Description copied from interface:RedissonClient
Returns RingBuffer based queue.- Specified by:
getRingBuffer
in interfaceRedissonClient
- Type Parameters:
V
- value type- Parameters:
name
- - name of object- Returns:
- RingBuffer object
-
getRingBuffer
Description copied from interface:RedissonClient
Returns RingBuffer based queue.- Specified by:
getRingBuffer
in interfaceRedissonClient
- Type Parameters:
V
- value type- Parameters:
name
- - name of objectcodec
- - codec for values- Returns:
- RingBuffer object
-
getBlockingQueue
Description copied from interface:RedissonClient
Returns unbounded blocking queue instance by name.- Specified by:
getBlockingQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- BlockingQueue object
-
getBlockingQueue
Description copied from interface:RedissonClient
Returns unbounded blocking queue instance by name using provided codec for queue objects.- Specified by:
getBlockingQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of queuecodec
- - queue objects codec- Returns:
- BlockingQueue object
-
getBoundedBlockingQueue
Description copied from interface:RedissonClient
Returns bounded blocking queue instance by name.- Specified by:
getBoundedBlockingQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- of queue- Returns:
- BoundedBlockingQueue object
-
getBoundedBlockingQueue
Description copied from interface:RedissonClient
Returns bounded blocking queue instance by name using provided codec for queue objects.- Specified by:
getBoundedBlockingQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of queuecodec
- - codec for values- Returns:
- BoundedBlockingQueue object
-
getDeque
Description copied from interface:RedissonClient
Returns unbounded deque instance by name.- Specified by:
getDeque
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- Deque object
-
getDeque
Description copied from interface:RedissonClient
Returns unbounded deque instance by name using provided codec for deque objects.- Specified by:
getDeque
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for values- Returns:
- Deque object
-
getBlockingDeque
Description copied from interface:RedissonClient
Returns unbounded blocking deque instance by name.- Specified by:
getBlockingDeque
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- BlockingDeque object
-
getBlockingDeque
Description copied from interface:RedissonClient
Returns unbounded blocking deque instance by name using provided codec for deque objects.- Specified by:
getBlockingDeque
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - deque objects codec- Returns:
- BlockingDeque object
-
getAtomicLong
Description copied from interface:RedissonClient
Returns atomicLong instance by name.- Specified by:
getAtomicLong
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- AtomicLong object
-
getLongAdder
Description copied from interface:RedissonClient
Returns LongAdder instances by name.- Specified by:
getLongAdder
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- LongAdder object
-
getDoubleAdder
Description copied from interface:RedissonClient
Returns DoubleAdder instances by name.- Specified by:
getDoubleAdder
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- LongAdder object
-
getAtomicDouble
Description copied from interface:RedissonClient
Returns atomicDouble instance by name.- Specified by:
getAtomicDouble
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- AtomicDouble object
-
getCountDownLatch
Description copied from interface:RedissonClient
Returns countDownLatch instance by name.- Specified by:
getCountDownLatch
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- CountDownLatch object
-
getBitSet
Description copied from interface:RedissonClient
Returns bitSet instance by name.- Specified by:
getBitSet
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- BitSet object
-
getSemaphore
Description copied from interface:RedissonClient
Returns semaphore instance by name- Specified by:
getSemaphore
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- Semaphore object
-
getPermitExpirableSemaphore
Description copied from interface:RedissonClient
Returns semaphore instance by name. Supports lease time parameter for each acquired permit.- Specified by:
getPermitExpirableSemaphore
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- PermitExpirableSemaphore object
-
getBloomFilter
Description copied from interface:RedissonClient
Returns bloom filter instance by name.- Specified by:
getBloomFilter
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of object- Returns:
- BloomFilter object
-
getBloomFilter
Description copied from interface:RedissonClient
Returns bloom filter instance by name using provided codec for objects.- Specified by:
getBloomFilter
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for values- Returns:
- BloomFilter object
-
getIdGenerator
Description copied from interface:RedissonClient
Returns id generator by name.- Specified by:
getIdGenerator
in interfaceRedissonClient
- Parameters:
name
- - name of object- Returns:
- IdGenerator object
-
getKeys
Description copied from interface:RedissonClient
Returns interface with methods for Redis keys. Each of Redis/Redisson object associated with own key- Specified by:
getKeys
in interfaceRedissonClient
- Returns:
- Keys object
-
createTransaction
Description copied from interface:RedissonClient
Creates transaction with READ_COMMITTED isolation level.- Specified by:
createTransaction
in interfaceRedissonClient
- Parameters:
options
- - transaction configuration- Returns:
- Transaction object
-
createBatch
Description copied from interface:RedissonClient
Creates batch object which could be executed later with collected group of commands in pipeline mode.- Specified by:
createBatch
in interfaceRedissonClient
- Parameters:
options
- - batch configuration- Returns:
- Batch object
-
createBatch
Description copied from interface:RedissonClient
Creates batch object which could be executed later with collected group of commands in pipeline mode.- Specified by:
createBatch
in interfaceRedissonClient
- Returns:
- Batch object
-
getLiveObjectService
Description copied from interface:RedissonClient
Returns RedissonAttachedLiveObjectService which can be used to retrieve live REntity(s)- Specified by:
getLiveObjectService
in interfaceRedissonClient
- Returns:
- LiveObjectService object
-
shutdown
public void shutdown()Description copied from interface:RedissonClient
Shutdown Redisson instance but NOT Redis server This equates to invoke shutdown(0, 2, TimeUnit.SECONDS);- Specified by:
shutdown
in interfaceRedissonClient
-
shutdown
Description copied from interface:RedissonClient
Shuts down Redisson instance but NOT Redis server Shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down. If a task is submitted during the quiet period, it is guaranteed to be accepted and the quiet period will start over.- Specified by:
shutdown
in interfaceRedissonClient
- Parameters:
quietPeriod
- the quiet period as described in the documentationtimeout
- the maximum amount of time to wait until the executor is RedissonClient.shutdown() regardless if a task was submitted during the quiet periodunit
- the unit ofquietPeriod
andtimeout
-
getConfig
Description copied from interface:RedissonClient
Allows to get configuration provided during Redisson instance creation. Further changes on this object not affect Redisson instance.- Specified by:
getConfig
in interfaceRedissonClient
- Returns:
- Config object
-
getRedisNodes
Description copied from interface:RedissonClient
Returns API to manage Redis nodes- Specified by:
getRedisNodes
in interfaceRedissonClient
- Type Parameters:
T
- type of Redis nodes API- Parameters:
nodes
- Redis nodes API class- Returns:
- Redis nodes API object
- See Also:
-
getNodesGroup
- Specified by:
getNodesGroup
in interfaceRedissonClient
-
getClusterNodesGroup
- Specified by:
getClusterNodesGroup
in interfaceRedissonClient
-
isShutdown
public boolean isShutdown()Description copied from interface:RedissonClient
Returnstrue
if this Redisson instance has been shut down.- Specified by:
isShutdown
in interfaceRedissonClient
- Returns:
true
if this Redisson instance has been shut down overwisefalse
-
isShuttingDown
public boolean isShuttingDown()Description copied from interface:RedissonClient
Returnstrue
if this Redisson instance was started to be shutdown or was shutdownRedissonClient.isShutdown()
already.- Specified by:
isShuttingDown
in interfaceRedissonClient
- Returns:
true
if this Redisson instance was started to be shutdown or was shutdownRedissonClient.isShutdown()
already.
-
getPriorityQueue
Description copied from interface:RedissonClient
Returns priority unbounded queue instance by name. It uses comparator to sort objects.- Specified by:
getPriorityQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- of object- Returns:
- Queue object
-
getPriorityQueue
Description copied from interface:RedissonClient
Returns priority unbounded queue instance by name using provided codec for queue objects. It uses comparator to sort objects.- Specified by:
getPriorityQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for message- Returns:
- Queue object
-
getPriorityBlockingQueue
Description copied from interface:RedissonClient
Returns unbounded priority blocking queue instance by name. It uses comparator to sort objects.- Specified by:
getPriorityBlockingQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- of object- Returns:
- Queue object
-
getPriorityBlockingQueue
Description copied from interface:RedissonClient
Returns unbounded priority blocking queue instance by name using provided codec for queue objects. It uses comparator to sort objects.- Specified by:
getPriorityBlockingQueue
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for message- Returns:
- Queue object
-
getPriorityBlockingDeque
Description copied from interface:RedissonClient
Returns unbounded priority blocking deque instance by name. It uses comparator to sort objects.- Specified by:
getPriorityBlockingDeque
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- of object- Returns:
- Queue object
-
getPriorityBlockingDeque
Description copied from interface:RedissonClient
Returns unbounded priority blocking deque instance by name using provided codec for queue objects. It uses comparator to sort objects.- Specified by:
getPriorityBlockingDeque
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for message- Returns:
- Queue object
-
getPriorityDeque
Description copied from interface:RedissonClient
Returns priority unbounded deque instance by name. It uses comparator to sort objects.- Specified by:
getPriorityDeque
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- of object- Returns:
- Queue object
-
getPriorityDeque
Description copied from interface:RedissonClient
Returns priority unbounded deque instance by name using provided codec for queue objects. It uses comparator to sort objects.- Specified by:
getPriorityDeque
in interfaceRedissonClient
- Type Parameters:
V
- type of value- Parameters:
name
- - name of objectcodec
- - codec for message- Returns:
- Queue object
-
getId
Description copied from interface:RedissonClient
Returns id of this Redisson instance- Specified by:
getId
in interfaceRedissonClient
- Returns:
- id
-