org.redisson

Class Redisson

java.lang.Object

org.redisson.Redisson

All Implemented Interfaces:

RedissonClient

public class Redisson
extends Object
implements RedissonClient

Main infrastructure class allows to get access to all Redisson objects on top of Redis server.

Author:

Nikita Koksharov

Method Summary

Methods

Modifier and Type	Method and Description
static Redisson	create() Creates an Redisson instance
static Redisson	create(Config config) Creates an Redisson instance with configuration
RBatch	createBatch() Return batch object which executes group of command in pipeline.
long	delete(String... keys) Deprecated.
io.netty.util.concurrent.Future<Long>	deleteAsync(String... keys) Deprecated.
long	deleteByPattern(String pattern) Delete multiple objects by a key pattern Supported glob-style patterns: h?
io.netty.util.concurrent.Future<Long>	deleteByPatternAsync(String pattern) Delete multiple objects by a key pattern in async mode Supported glob-style patterns: h?
Collection<String>	findKeysByPattern(String pattern) Find keys by key search pattern Supported glob-style patterns: h?
io.netty.util.concurrent.Future<Collection<String>>	findKeysByPatternAsync(String pattern) Find keys by key search pattern in async mode Supported glob-style patterns: h?
void	flushall() Delete all the keys of all the existing databases
void	flushdb() Delete all the keys of the currently selected database
RAtomicLong	getAtomicLong(String name) Returns distributed "atomic long" instance by name.
RBitSet	getBitSet(String name)
<V> RBlockingQueue<V>	getBlockingQueue(String name) Returns distributed blocking queue instance by name.
<V> RBlockingQueue<V>	getBlockingQueue(String name, Codec codec)
<V> RBucket<V>	getBucket(String name) Returns object holder by name
<V> RBucket<V>	getBucket(String name, Codec codec)
<V> List<RBucket<V>>	getBuckets(String pattern) Returns a list of object holder by a key pattern Supported glob-style patterns: h?
NodesGroup<ClusterNode>	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 distributed "count down latch" instance by name.
<V> RDeque<V>	getDeque(String name) Returns distributed deque instance by name.
<V> RDeque<V>	getDeque(String name, Codec codec)
<V> RHyperLogLog<V>	getHyperLogLog(String name) Returns HyperLogLog object
<V> RHyperLogLog<V>	getHyperLogLog(String name, Codec codec)
RKeys	getKeys() Returns keys operations.
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 distributed list instance by name.
<V> RList<V>	getList(String name, Codec codec)
RLock	getLock(String name) Returns distributed lock instance by name.
<K,V> RMap<K,V>	getMap(String name) Returns distributed map instance by name.
<K,V> RMap<K,V>	getMap(String name, Codec codec)
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)
<V> RQueue<V>	getQueue(String name) Returns distributed queue instance by name.
<V> RQueue<V>	getQueue(String name, Codec codec)
<V> RScoredSortedSet<V>	getScoredSortedSet(String name) Returns Redis Sorted Set instance by name
<V> RScoredSortedSet<V>	getScoredSortedSet(String name, Codec codec)
RScript	getScript() Returns script with eval-operations support
<V> RSet<V>	getSet(String name) Returns distributed set instance by name.
<V> RSet<V>	getSet(String name, Codec codec)
<V> RSortedSet<V>	getSortedSet(String name) Returns distributed sorted set instance by name.
<V> RSortedSet<V>	getSortedSet(String name, Codec codec)
<M> RTopic<M>	getTopic(String name) Returns topic instance by name.
<M> RTopic<M>	getTopic(String name, Codec codec)
void	shutdown() Shuts down Redisson instance NOT Redis server

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Redisson create()

Creates an Redisson instance

Returns:

Redisson instance

create

public static Redisson create(Config config)

Creates an Redisson instance with configuration

Parameters:

config -

Returns:

Redisson instance

getBucket

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

Returns object holder by name

Specified by:

getBucket in interface RedissonClient

Parameters:

name - of object

Returns:

getBucket

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

Specified by:

getBucket in interface RedissonClient

getBuckets

public <V> List<RBucket<V>> getBuckets(String pattern)

Returns a list of object holder by a key pattern 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:

getBuckets in interface RedissonClient

getHyperLogLog

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

Returns HyperLogLog object

Specified by:

getHyperLogLog in interface RedissonClient

Parameters:

name - of object

Returns:

getHyperLogLog

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

Specified by:

getHyperLogLog in interface RedissonClient

getList

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

Returns distributed list instance by name.

Specified by:

getList in interface RedissonClient

Parameters:

name - of the distributed list

Returns:

distributed list

getList

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

Specified by:

getList in interface RedissonClient

getMap

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

Returns distributed map instance by name.

Specified by:

getMap in interface RedissonClient

Parameters:

name - of the distributed map

Returns:

distributed map

getMap

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

Specified by:

getMap in interface RedissonClient

getLock

public RLock getLock(String name)

Returns distributed lock instance by name.

Specified by:

getLock in interface RedissonClient

Parameters:

name - of the distributed lock

Returns:

distributed lock

getSet

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

Returns distributed set instance by name.

Specified by:

getSet in interface RedissonClient

Parameters:

name - of the distributed set

Returns:

distributed set

getSet

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

Specified by:

getSet in interface RedissonClient

getScript

public RScript getScript()

Returns script with eval-operations support

Specified by:

getScript in interface RedissonClient

Returns:

getSortedSet

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

Returns distributed sorted set instance by name.

Specified by:

getSortedSet in interface RedissonClient

Parameters:

name - of the distributed set

Returns:

distributed set

getSortedSet

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

Specified by:

getSortedSet in interface RedissonClient

getScoredSortedSet

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

Returns Redis Sorted Set instance by name

Specified by:

getScoredSortedSet in interface RedissonClient

Parameters:

name -

Returns:

getScoredSortedSet

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

Specified by:

getScoredSortedSet in interface RedissonClient

getLexSortedSet

public 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

Specified by:

getLexSortedSet in interface RedissonClient

Parameters:

name -

Returns:

getTopic

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

Returns topic instance by name.

Specified by:

getTopic in interface RedissonClient

Parameters:

name - of the distributed topic

Returns:

distributed topic

getTopic

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

Specified by:

getTopic in interface RedissonClient

getPatternTopic

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

Specified by:

getPatternTopic in interface RedissonClient

Parameters:

pattern - of the topic

Returns:

getPatternTopic

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

Specified by:

getPatternTopic in interface RedissonClient

getQueue

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

Returns distributed queue instance by name.

Specified by:

getQueue in interface RedissonClient

Parameters:

name - of the distributed queue

Returns:

distributed queue

getQueue

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

Specified by:

getQueue in interface RedissonClient

getBlockingQueue

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

Returns distributed blocking queue instance by name.

Specified by:

getBlockingQueue in interface RedissonClient

Parameters:

name - of the distributed blocking queue

Returns:

distributed queue

getBlockingQueue

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

Specified by:

getBlockingQueue in interface RedissonClient

getDeque

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

Returns distributed deque instance by name.

Specified by:

getDeque in interface RedissonClient

Parameters:

name - of the distributed queue

Returns:

distributed queue

getDeque

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

Specified by:

getDeque in interface RedissonClient

getAtomicLong

public RAtomicLong getAtomicLong(String name)

Returns distributed "atomic long" instance by name.

Specified by:

getAtomicLong in interface RedissonClient

Parameters:

name - of the distributed "atomic long"

Returns:

distributed "atomic long"

getCountDownLatch

public RCountDownLatch getCountDownLatch(String name)

Returns distributed "count down latch" instance by name.

Specified by:

getCountDownLatch in interface RedissonClient

Parameters:

name - of the distributed "count down latch"

Returns:

distributed "count down latch"

getBitSet

public RBitSet getBitSet(String name)

Specified by:

getBitSet in interface RedissonClient

getKeys

public RKeys getKeys()

Returns keys operations. Each of Redis/Redisson object associated with own key

Specified by:

getKeys in interface RedissonClient

Returns:

shutdown

public void shutdown()

Shuts down Redisson instance NOT Redis server

Specified by:

shutdown in interface RedissonClient

getConfig

public Config getConfig()

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

Specified by:

getConfig in interface RedissonClient

Returns:

Config object

findKeysByPattern

public Collection<String> findKeysByPattern(String pattern)

Find keys by key search pattern 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:

findKeysByPattern in interface RedissonClient

Parameters:

pattern -

Returns:

findKeysByPatternAsync

public io.netty.util.concurrent.Future<Collection<String>> findKeysByPatternAsync(String pattern)

Find keys by key search pattern in async mode 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:

findKeysByPatternAsync in interface RedissonClient

Parameters:

pattern -

Returns:

deleteByPattern

public long deleteByPattern(String pattern)

Delete multiple objects by a key pattern 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:

deleteByPattern in interface RedissonClient

Parameters:

pattern -

Returns:

deleteByPatternAsync

public io.netty.util.concurrent.Future<Long> deleteByPatternAsync(String pattern)

Delete multiple objects by a key pattern in async mode 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:

deleteByPatternAsync in interface RedissonClient

Parameters:

pattern -

Returns:

delete

@Deprecated
public long delete(String... keys)

Deprecated.

Delete multiple objects by name

Specified by:

delete in interface RedissonClient

Parameters:

keys - - object names

Returns:

deleteAsync

@Deprecated
public io.netty.util.concurrent.Future<Long> deleteAsync(String... keys)

Deprecated.

Delete multiple objects by name in async mode

Specified by:

deleteAsync in interface RedissonClient

Parameters:

keys - - object names

Returns:

getNodesGroup

public NodesGroup<Node> getNodesGroup()

Get Redis nodes group for server operations

Specified by:

getNodesGroup in interface RedissonClient

Returns:

getClusterNodesGroup

public NodesGroup<ClusterNode> getClusterNodesGroup()

Get Redis cluster nodes group for server operations

Specified by:

getClusterNodesGroup in interface RedissonClient

Returns:

flushdb

public void flushdb()

Delete all the keys of the currently selected database

Specified by:

flushdb in interface RedissonClient

flushall

public void flushall()

Delete all the keys of all the existing databases

Specified by:

flushall in interface RedissonClient

createBatch

public RBatch createBatch()

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

Specified by:

createBatch in interface RedissonClient

Returns: