org.redisson

Interface RedissonClient

All Known Implementing Classes:

Redisson

public interface RedissonClient

Main Redisson interface for access to all redisson objects with sync/async interface.

Author:

Nikita Koksharov

Method Summary

Methods

Modifier and Type	Method and Description
RBatch	createBatch() Return batch object which executes group of command in pipeline.
<V> List<RBucket<V>>	findBuckets(String pattern) Deprecated.
RAtomicDouble	getAtomicDouble(String name) Returns atomicDouble instance by name.
RAtomicLong	getAtomicLong(String name) Returns atomicLong instance by name.
RBitSet	getBitSet(String name) Returns bitSet instance by name.
<V> RBlockingDeque<V>	getBlockingDeque(String name) Returns blocking deque instance by name.
<V> RBlockingDeque<V>	getBlockingDeque(String name, Codec codec) Returns blocking deque instance by name using provided codec for deque objects.
<V> RBlockingQueue<V>	getBlockingQueue(String name) Returns blocking queue instance by name.
<V> RBlockingQueue<V>	getBlockingQueue(String name, Codec codec) Returns 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> RBucket<V>	getBucket(String name) Returns object holder instance by name.
<V> RBucket<V>	getBucket(String name, Codec codec) Returns object holder instance by name using provided codec for object.
RBuckets	getBuckets() Returns interface for mass operations with Bucket objects.
RBuckets	getBuckets(Codec codec) Returns interface for mass operations with Bucket objects using provided codec for object.
ClusterNodesGroup	getClusterNodesGroup() Get Redis cluster nodes group for server operations
Config	getConfig() Allows to get configuration provided during Redisson instance creation.
RCountDownLatch	getCountDownLatch(String name) Returns countDownLatch instance by name.
<V> RDeque<V>	getDeque(String name) Returns deque instance by name.
<V> RDeque<V>	getDeque(String name, Codec codec) Returns deque instance by name using provided codec for deque objects.
RLock	getFairLock(String name) Returns lock instance by name.
<V> RGeo<V>	getGeo(String name) Returns geospatial items holder instance by name.
<V> RGeo<V>	getGeo(String name, Codec codec) Returns geospatial items holder instance by name 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.
RKeys	getKeys() Returns interface with methods for Redis keys.
RLexSortedSet	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>	getList(String name) Returns list instance by name.
<V> RList<V>	getList(String name, Codec codec) 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.
RLock	getLock(String name) Returns lock instance by name.
<K,V> RMap<K,V>	getMap(String name) Returns map instance by name.
<K,V> RMap<K,V>	getMap(String name, Codec codec) 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, Codec codec) Returns map-based cache instance by name using provided codec for both cache keys and values.
NodesGroup<Node>	getNodesGroup() Get Redis nodes group for server operations
<M> RPatternTopic<M>	getPatternTopic(String pattern) Returns topic instance satisfies by pattern name.
<M> RPatternTopic<M>	getPatternTopic(String pattern, Codec codec) Returns topic instance satisfies by pattern name using provided codec for messages.
<V> RQueue<V>	getQueue(String name) Returns queue instance by name.
<V> RQueue<V>	getQueue(String name, Codec codec) Returns queue instance by name using provided codec for queue objects.
RReadWriteLock	getReadWriteLock(String name) Returns readWriteLock instance by name.
RRemoteService	getRemoteSerivce() Returns object for remote operations prefixed with the default name (redisson_remote_service)
RRemoteService	getRemoteSerivce(Codec codec) Returns object for remote operations prefixed with the default name (redisson_remote_service) and uses provided codec for method arguments and result.
RRemoteService	getRemoteSerivce(String name) Returns object for remote operations prefixed with the specified name
RRemoteService	getRemoteSerivce(String name, Codec codec) Returns object for remote operations prefixed with the specified name and uses provided codec for method arguments and result.
<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.
RScript	getScript() Returns script operations object
RSemaphore	getSemaphore(String name) Returns semaphore instance by name
<V> RSet<V>	getSet(String name) Returns set instance by name.
<V> RSet<V>	getSet(String name, Codec codec) Returns set instance by name using provided codec for set objects.
<V> RSetCache<V>	getSetCache(String name) Returns set-based cache instance by name.
<V> RSetCache<V>	getSetCache(String name, Codec codec) Returns set-based cache instance by name.
<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.
<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.
<M> RTopic<M>	getTopic(String name) Returns topic instance by name.
<M> RTopic<M>	getTopic(String name, Codec codec) Returns topic instance by name using provided codec for messages.
boolean	isShutdown() Returns true if this Redisson instance has been shut down.
boolean	isShuttingDown() Returns true if this Redisson instance was started to be shutdown or was shutdown isShutdown() already.
<V> Map<String,V>	loadBucketValues(Collection<String> keys) Deprecated.
<V> Map<String,V>	loadBucketValues(String... keys) Deprecated.
void	saveBuckets(Map<String,?> buckets) Deprecated.
void	shutdown() Shuts down Redisson instance NOT Redis server This equates to invoke shutdown(2, 15, TimeUnit.SECONDS);
void	shutdown(long quietPeriod, long timeout, TimeUnit unit) Shuts down Redisson instance NOT Redis server Shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down.

Method Detail

getGeo

<V> RGeo<V> getGeo(String name)

Returns geospatial items holder instance by name.

Parameters:

name -

Returns:

getGeo

<V> RGeo<V> getGeo(String name,
                 Codec codec)

Returns geospatial items holder instance by name using provided codec for geospatial members.

Parameters:

name -

geospatial - member codec

Returns:

getSetCache

<V> RSetCache<V> getSetCache(String name)

Returns set-based cache instance by name. Supports value eviction with a given TTL value.

If eviction is not required then it's better to use regular map getSet(String, Codec).

Parameters:

name -

codec -

Returns:

getSetCache

<V> RSetCache<V> getSetCache(String name,
                           Codec codec)

Returns set-based cache instance by name. Supports value eviction with a given TTL value.

If eviction is not required then it's better to use regular map getSet(String, Codec).

Parameters:

name -

codec -

Returns:

getMapCache

<K,V> RMapCache<K,V> getMapCache(String name,
                               Codec codec)

Returns map-based cache instance by name using provided codec for both cache keys and values. Supports entry eviction with a given TTL value.

If eviction is not required then it's better to use regular map getMap(String, Codec).

Parameters:

name -

codec -

Returns:

getMapCache

<K,V> RMapCache<K,V> getMapCache(String name)

Returns map-based cache instance by name. Supports entry eviction with a given TTL value.

If eviction is not required then it's better to use regular map getMap(String).

Parameters:

name -

Returns:

getBucket

<V> RBucket<V> getBucket(String name)

Returns object holder instance by name.

Parameters:

name - of object

Returns:

getBucket

<V> RBucket<V> getBucket(String name,
                       Codec codec)

Returns object holder instance by name using provided codec for object.

Parameters:

name - of object

object - codec

Returns:

getBuckets

RBuckets getBuckets()

Returns interface for mass operations with Bucket objects.

Returns:

getBuckets

RBuckets getBuckets(Codec codec)

Returns interface for mass operations with Bucket objects using provided codec for object.

Returns:

findBuckets

@Deprecated
<V> List<RBucket<V>> findBuckets(String pattern)

Deprecated.

Use RBuckets.find(String)

loadBucketValues

@Deprecated
<V> Map<String,V> loadBucketValues(Collection<String> keys)

Deprecated.

Use RBuckets.get(String...)

loadBucketValues

@Deprecated
<V> Map<String,V> loadBucketValues(String... keys)

Deprecated.

Use RBuckets.get(String...)

saveBuckets

@Deprecated
void saveBuckets(Map<String,?> buckets)

Deprecated.

Use RBuckets.set(Map)

getHyperLogLog

<V> RHyperLogLog<V> getHyperLogLog(String name)

Returns HyperLogLog instance by name.

Parameters:

name - of object

Returns:

getHyperLogLog

<V> RHyperLogLog<V> getHyperLogLog(String name,
                                 Codec codec)

Returns HyperLogLog instance by name using provided codec for hll objects.

Parameters:

name - of object

object - codec

Returns:

getList

<V> RList<V> getList(String name)

Returns list instance by name.

Parameters:

name - of object

Returns:

getList

<V> RList<V> getList(String name,
                   Codec codec)

Returns list instance by name using provided codec for list objects.

Parameters:

name - of object

list - object codec

Returns:

getListMultimap

<K,V> RListMultimap<K,V> getListMultimap(String name)

Returns List based Multimap instance by name.

Parameters:

name -

Returns:

getListMultimap

<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.

Parameters:

name -

codec -

Returns:

getListMultimapCache

<K,V> RListMultimapCache<K,V> getListMultimapCache(String name)

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 getSetMultimap(String).

Parameters:

name -

Returns:

getListMultimapCache

<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. Supports key-entry eviction with a given TTL value.

If eviction is not required then it's better to use regular map getSetMultimap(String, Codec).

Parameters:

name -

Returns:

getMap

<K,V> RMap<K,V> getMap(String name)

Returns map instance by name.

Parameters:

name - of map

Returns:

getMap

<K,V> RMap<K,V> getMap(String name,
                     Codec codec)

Returns map instance by name using provided codec for both map keys and values.

Parameters:

name - of map

map - key and value codec

Returns:

getSetMultimap

<K,V> RSetMultimap<K,V> getSetMultimap(String name)

Returns Set based Multimap instance by name.

Parameters:

name -

Returns:

getSetMultimap

<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.

Parameters:

name -

codec -

Returns:

getSetMultimapCache

<K,V> RSetMultimapCache<K,V> getSetMultimapCache(String name)

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 getSetMultimap(String).

Parameters:

name -

Returns:

getSetMultimapCache

<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. Supports key-entry eviction with a given TTL value.

If eviction is not required then it's better to use regular map getSetMultimap(String, Codec).

Parameters:

name -

Returns:

getSemaphore

RSemaphore getSemaphore(String name)

Returns semaphore instance by name

Parameters:

name - of semaphore

Returns:

getLock

RLock getLock(String name)

Returns lock instance by name.

Implements a non-fair locking so doesn't guarantees an acquire order by threads.

Parameters:

name - of lock

Returns:

getFairLock

RLock getFairLock(String name)

Returns lock instance by name.

Implements a fair locking so it guarantees an acquire order by threads.

Parameters:

name -

Returns:

getReadWriteLock

RReadWriteLock getReadWriteLock(String name)

Returns readWriteLock instance by name.

Parameters:

name -

Returns:

getSet

<V> RSet<V> getSet(String name)

Returns set instance by name.

Parameters:

name - of set

Returns:

getSet

<V> RSet<V> getSet(String name,
                 Codec codec)

Returns set instance by name using provided codec for set objects.

Parameters:

name - of set

set - object codec

Returns:

getSortedSet

<V> RSortedSet<V> getSortedSet(String name)

Returns sorted set instance by name. This sorted set uses comparator to sort objects.

Parameters:

name - of sorted set

Returns:

getSortedSet

<V> RSortedSet<V> getSortedSet(String name,
                             Codec codec)

Returns sorted set instance by name using provided codec for sorted set objects. This sorted set sorts objects using comparator.

Parameters:

name - of sorted set

sorted - set object codec

Returns:

getScoredSortedSet

<V> RScoredSortedSet<V> getScoredSortedSet(String name)

Returns Redis Sorted Set instance by name. This sorted set sorts objects by object score.

Parameters:

name - of scored sorted set

Returns:

getScoredSortedSet

<V> RScoredSortedSet<V> getScoredSortedSet(String name,
                                         Codec codec)

Returns Redis Sorted Set instance by name using provided codec for sorted set objects. This sorted set sorts objects by object score.

Parameters:

name - of scored sorted set

scored - sorted set object codec

Returns:

getLexSortedSet

RLexSortedSet 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

Parameters:

name -

Returns:

getTopic

<M> RTopic<M> getTopic(String name)

Returns topic instance by name.

Parameters:

name - of topic

Returns:

getTopic

<M> RTopic<M> getTopic(String name,
                     Codec codec)

Returns topic instance by name using provided codec for messages.

Parameters:

name - of topic

message - codec

Returns:

getPatternTopic

<M> RPatternTopic<M> getPatternTopic(String pattern)

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

Parameters:

pattern - of the topic

Returns:

getPatternTopic

<M> RPatternTopic<M> getPatternTopic(String pattern,
                                   Codec codec)

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

Parameters:

pattern - of the topic

message - codec

Returns:

getQueue

<V> RQueue<V> getQueue(String name)

Returns queue instance by name.

Parameters:

name - of queue

Returns:

getQueue

<V> RQueue<V> getQueue(String name,
                     Codec codec)

Returns queue instance by name using provided codec for queue objects.

Parameters:

name - of queue

queue - objects codec

Returns:

getBlockingQueue

<V> RBlockingQueue<V> getBlockingQueue(String name)

Returns blocking queue instance by name.

Parameters:

name - of queue

Returns:

getBlockingQueue

<V> RBlockingQueue<V> getBlockingQueue(String name,
                                     Codec codec)

Returns blocking queue instance by name using provided codec for queue objects.

Parameters:

name - of queue

queue - objects codec

Returns:

getDeque

<V> RDeque<V> getDeque(String name)

Returns deque instance by name.

Parameters:

name - of deque

Returns:

getDeque

<V> RDeque<V> getDeque(String name,
                     Codec codec)

Returns deque instance by name using provided codec for deque objects.

Parameters:

name - of deque

deque - objects codec

Returns:

getBlockingDeque

<V> RBlockingDeque<V> getBlockingDeque(String name)

Returns blocking deque instance by name.

Parameters:

name - of deque

Returns:

getBlockingDeque

<V> RBlockingDeque<V> getBlockingDeque(String name,
                                     Codec codec)

Returns blocking deque instance by name using provided codec for deque objects.

Parameters:

name - of deque

deque - objects codec

Returns:

getAtomicLong

RAtomicLong getAtomicLong(String name)

Returns atomicLong instance by name.

Parameters:

name - of atomicLong

Returns:

getAtomicDouble

RAtomicDouble getAtomicDouble(String name)

Returns atomicDouble instance by name.

Parameters:

name - of atomicLong

Returns:

getCountDownLatch

RCountDownLatch getCountDownLatch(String name)

Returns countDownLatch instance by name.

Parameters:

name - of countDownLatch

Returns:

getBitSet

RBitSet getBitSet(String name)

Returns bitSet instance by name.

Parameters:

name - of bitSet

Returns:

getBloomFilter

<V> RBloomFilter<V> getBloomFilter(String name)

Returns bloom filter instance by name.

Parameters:

name - of bloom filter

Returns:

getBloomFilter

<V> RBloomFilter<V> getBloomFilter(String name,
                                 Codec codec)

Returns bloom filter instance by name using provided codec for objects.

Parameters:

name - of bloom filter

Returns:

getScript

RScript getScript()

Returns script operations object

Returns:

getRemoteSerivce

RRemoteService getRemoteSerivce()

Returns object for remote operations prefixed with the default name (redisson_remote_service)

Returns:

getRemoteSerivce

RRemoteService getRemoteSerivce(Codec codec)

Returns object for remote operations prefixed with the default name (redisson_remote_service) and uses provided codec for method arguments and result.

Returns:

getRemoteSerivce

RRemoteService getRemoteSerivce(String name)

Returns object for remote operations prefixed with the specified name

Parameters:

name - The name used as the Redis key prefix for the services

Returns:

getRemoteSerivce

RRemoteService getRemoteSerivce(String name,
                              Codec codec)

Returns object for remote operations prefixed with the specified name and uses provided codec for method arguments and result.

Parameters:

name - The name used as the Redis key prefix for the services

Returns:

createBatch

RBatch createBatch()

Return batch object which executes group of command in pipeline. See http://redis.io/topics/pipelining

Returns:

getKeys

RKeys getKeys()

Returns interface with methods for Redis keys. Each of Redis/Redisson object associated with own key

Returns:

shutdown

void shutdown()

Shuts down Redisson instance NOT Redis server This equates to invoke shutdown(2, 15, TimeUnit.SECONDS);

shutdown

void shutdown(long quietPeriod,
            long timeout,
            TimeUnit unit)

Shuts down Redisson instance 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.

Parameters:

quietPeriod - the quiet period as described in the documentation

timeout - the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period

unit - the unit of quietPeriod and timeout

getConfig

Config getConfig()

Allows to get configuration provided during Redisson instance creation. Further changes on this object not affect Redisson instance.

Returns:

Config object

getNodesGroup

NodesGroup<Node> getNodesGroup()

Get Redis nodes group for server operations

Returns:

getClusterNodesGroup

ClusterNodesGroup getClusterNodesGroup()

Get Redis cluster nodes group for server operations

Returns:

isShutdown

boolean isShutdown()

Returns true if this Redisson instance has been shut down.

Returns:

isShuttingDown

boolean isShuttingDown()

Returns true if this Redisson instance was started to be shutdown or was shutdown isShutdown() already.

Returns: