K - keyV - valuepublic class RedissonMapCache<K,V> extends RedissonMap<K,V> implements RMapCache<K,V>
Map-based cache with ability to set TTL for each entry via
put(Object, Object, long, TimeUnit) or putIfAbsent(Object, Object, long, TimeUnit) methods.
And therefore has an complex lua-scripts inside.
Current redis implementation doesnt have map entry eviction functionality.
Thus entries are checked for TTL expiration during any key/value/entry read operation.
If key/value/entry expired then it doesn't returns and clean task runs asynchronous.
Clean task deletes removes 100 expired entries at once.
In addition there is EvictionScheduler. This scheduler
deletes expired entries in time interval between 5 seconds to 2 hours.
If eviction is not required then it's better to use RedissonMap object.
| Modifier | Constructor and Description |
|---|---|
|
RedissonMapCache(Codec codec,
EvictionScheduler evictionScheduler,
CommandAsyncExecutor commandExecutor,
String name) |
protected |
RedissonMapCache(EvictionScheduler evictionScheduler,
CommandAsyncExecutor commandExecutor,
String name) |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
await(RFuture<?> future,
long timeout,
TimeUnit timeoutUnit) |
boolean |
clearExpire()
Clear an expire timeout or expire date for object.
|
RFuture<Boolean> |
clearExpireAsync()
Clear an expire timeout or expire date for object in async mode.
|
RFuture<Boolean> |
containsKeyAsync(Object key) |
RFuture<Boolean> |
containsValueAsync(Object value) |
boolean |
delete()
Deletes the object
|
RFuture<Boolean> |
deleteAsync()
Delete object in async mode
|
protected byte[] |
encode(Object value) |
protected byte[] |
encodeMapKey(Object value) |
protected byte[] |
encodeMapValue(Object value) |
boolean |
expire(long timeToLive,
TimeUnit timeUnit)
Set a timeout for object.
|
RFuture<Boolean> |
expireAsync(long timeToLive,
TimeUnit timeUnit)
Set a timeout for object in async mode.
|
boolean |
expireAt(Date timestamp)
Set an expire date for object.
|
boolean |
expireAt(long timestamp)
Set an expire date for object.
|
RFuture<Boolean> |
expireAtAsync(Date timestamp)
Set an expire date for object in async mode.
|
RFuture<Boolean> |
expireAtAsync(long timestamp)
Set an expire date for object in async mode.
|
boolean |
fastPut(K key,
V value,
long ttl,
TimeUnit ttlUnit)
Stores value mapped by key with specified time to live.
|
boolean |
fastPut(K key,
V value,
long ttl,
TimeUnit ttlUnit,
long maxIdleTime,
TimeUnit maxIdleUnit)
Stores value mapped by key with specified time to live and max idle time.
|
RFuture<Boolean> |
fastPutAsync(K key,
V value)
Associates the specified
value with the specified key
in async manner. |
RFuture<Boolean> |
fastPutAsync(K key,
V value,
long ttl,
TimeUnit ttlUnit)
Stores value mapped by key with specified time to live.
|
RFuture<Boolean> |
fastPutAsync(K key,
V value,
long ttl,
TimeUnit ttlUnit,
long maxIdleTime,
TimeUnit maxIdleUnit)
Stores value mapped by key with specified time to live and max idle time.
|
RFuture<Boolean> |
fastPutIfAbsentAsync(K key,
V value) |
RFuture<Long> |
fastRemoveAsync(K... keys)
Removes
keys from map by one operation in async manner
Works faster than RMap.removeAsync but doesn't return
the value associated with key |
protected <V> V |
get(RFuture<V> future) |
RFuture<Map<K,V>> |
getAllAsync(Set<K> keys) |
RFuture<V> |
getAsync(K key) |
Codec |
getCodec()
Returns the underlying Codec used by this RObject
|
String |
getName()
Returns name of object
|
boolean |
isExists()
Check object existence
|
RFuture<Boolean> |
isExistsAsync()
Check object existence in async mode.
|
void |
migrate(String host,
int port,
int database)
Transfer an object from source Redis instance to destination Redis instance
|
RFuture<Void> |
migrateAsync(String host,
int port,
int database)
Transfer an object from source Redis instance to destination Redis instance
in async mode
|
boolean |
move(int database)
Move object to another database
|
RFuture<Boolean> |
moveAsync(int database)
Move object to another database in async mode
|
protected <V> RPromise<V> |
newPromise() |
protected <V> RFuture<V> |
newSucceededFuture(V result) |
V |
put(K key,
V value,
long ttl,
TimeUnit unit)
Stores value mapped by key with specified time to live.
|
V |
put(K key,
V value,
long ttl,
TimeUnit ttlUnit,
long maxIdleTime,
TimeUnit maxIdleUnit)
Stores value mapped by key with specified time to live and max idle time.
|
RFuture<Void> |
putAllAsync(Map<? extends K,? extends V> map) |
RFuture<V> |
putAsync(K key,
V value) |
RFuture<V> |
putAsync(K key,
V value,
long ttl,
TimeUnit ttlUnit)
Stores value mapped by key with specified time to live.
|
RFuture<V> |
putAsync(K key,
V value,
long ttl,
TimeUnit ttlUnit,
long maxIdleTime,
TimeUnit maxIdleUnit)
Stores value mapped by key with specified time to live and max idle time.
|
V |
putIfAbsent(K key,
V value,
long ttl,
TimeUnit ttlUnit)
If the specified key is not already associated
with a value, associate it with the given value.
|
V |
putIfAbsent(K key,
V value,
long ttl,
TimeUnit ttlUnit,
long maxIdleTime,
TimeUnit maxIdleUnit)
If the specified key is not already associated
with a value, associate it with the given value.
|
RFuture<V> |
putIfAbsentAsync(K key,
V value) |
RFuture<V> |
putIfAbsentAsync(K key,
V value,
long ttl,
TimeUnit ttlUnit)
If the specified key is not already associated
with a value, associate it with the given value.
|
RFuture<V> |
putIfAbsentAsync(K key,
V value,
long ttl,
TimeUnit ttlUnit,
long maxIdleTime,
TimeUnit maxIdleUnit)
If the specified key is not already associated
with a value, associate it with the given value.
|
RFuture<Set<Map.Entry<K,V>>> |
readAllEntrySetAsync()
Read all map entries at once
|
RFuture<Collection<V>> |
readAllValuesAsync()
Read all values at once
|
long |
remainTimeToLive()
Remaining time to live of Redisson object that has a timeout
|
RFuture<Long> |
remainTimeToLiveAsync()
Get remaining time to live of object in seconds.
|
RFuture<V> |
removeAsync(K key) |
RFuture<Boolean> |
removeAsync(Object key,
Object value) |
void |
rename(String newName)
Rename current object key to
newName |
RFuture<Void> |
renameAsync(String newName)
Rename current object key to
newName
in async mode |
boolean |
renamenx(String newName)
Rename current object key to
newName
only if new key is not exists |
RFuture<Boolean> |
renamenxAsync(String newName)
Rename current object key to
newName
in async mode only if new key is not exists |
RFuture<V> |
replaceAsync(K key,
V value) |
RFuture<Boolean> |
replaceAsync(K key,
V oldValue,
V newValue) |
addAndGet, addAndGetAsync, clear, containsKey, containsValue, entryIterator, entrySet, equals, fastPut, fastPutIfAbsent, fastRemove, get, getAll, getName, hashCode, isEmpty, keyIterator, keySet, put, putAll, putIfAbsent, readAllEntrySet, readAllKeySet, readAllKeySetAsync, readAllValues, remove, remove, replace, replace, size, sizeAsync, valueIterator, values, valueSize, valueSizeAsyncclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitaddAndGet, entrySet, fastPut, fastPutIfAbsent, fastRemove, getAll, keySet, readAllEntrySet, readAllKeySet, readAllValues, values, valueSizeputIfAbsent, remove, replace, replaceclear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, removeclearExpire, expire, expireAt, expireAt, remainTimeToLivedelete, getCodec, getName, isExists, migrate, move, rename, renamenxsizeAsyncaddAndGetAsync, readAllKeySetAsync, valueSizeAsyncexpireAtAsync, remainTimeToLiveAsyncisExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsyncprotected RedissonMapCache(EvictionScheduler evictionScheduler, CommandAsyncExecutor commandExecutor, String name)
public RedissonMapCache(Codec codec, EvictionScheduler evictionScheduler, CommandAsyncExecutor commandExecutor, String name)
public RFuture<Boolean> containsKeyAsync(Object key)
containsKeyAsync in interface RMapAsync<K,V>containsKeyAsync in class RedissonMap<K,V>public RFuture<Boolean> containsValueAsync(Object value)
containsValueAsync in interface RMapAsync<K,V>containsValueAsync in class RedissonMap<K,V>public RFuture<Map<K,V>> getAllAsync(Set<K> keys)
getAllAsync in interface RMapAsync<K,V>getAllAsync in class RedissonMap<K,V>public V putIfAbsent(K key, V value, long ttl, TimeUnit ttlUnit)
RMapCacheStores value mapped by key with specified time to live. Entry expires after specified time to live.
If the map previously contained a mapping for the key, the old value is replaced by the specified value.
putIfAbsent in interface RMapCache<K,V>key - - map keyvalue - - map valuettl - - time to live for key\value entry.
If 0 then stores infinitely.ttlUnit - - time unitpublic RFuture<V> putIfAbsentAsync(K key, V value, long ttl, TimeUnit ttlUnit)
RMapCacheAsyncStores value mapped by key with specified time to live. Entry expires after specified time to live. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
putIfAbsentAsync in interface RMapCacheAsync<K,V>key - - map keyvalue - - map valuettl - - time to live for key\value entry.
If 0 then stores infinitely.ttlUnit - - time unitpublic V putIfAbsent(K key, V value, long ttl, TimeUnit ttlUnit, long maxIdleTime, TimeUnit maxIdleUnit)
RMapCacheStores value mapped by key with specified time to live and max idle time. Entry expires when specified time to live or max idle time has expired.
If the map previously contained a mapping for the key, the old value is replaced by the specified value.
putIfAbsent in interface RMapCache<K,V>key - - map keyvalue - - map valuettl - - time to live for key\value entry.
If 0 then time to live doesn't affect entry expiration.ttlUnit - - time unitmaxIdleTime - - max idle time for key\value entry.
If 0 then max idle time doesn't affect entry expiration.maxIdleUnit - - time unit
if maxIdleTime and ttl params are equal to 0
then entry stores infinitely.
public RFuture<V> putIfAbsentAsync(K key, V value, long ttl, TimeUnit ttlUnit, long maxIdleTime, TimeUnit maxIdleUnit)
RMapCacheAsyncStores value mapped by key with specified time to live and max idle time. Entry expires when specified time to live or max idle time has expired.
If the map previously contained a mapping for the key, the old value is replaced by the specified value.
putIfAbsentAsync in interface RMapCacheAsync<K,V>key - - map keyvalue - - map valuettl - - time to live for key\value entry.
If 0 then time to live doesn't affect entry expiration.ttlUnit - - time unitmaxIdleTime - - max idle time for key\value entry.
If 0 then max idle time doesn't affect entry expiration.maxIdleUnit - - time unit
if maxIdleTime and ttl params are equal to 0
then entry stores infinitely.
public RFuture<Boolean> removeAsync(Object key, Object value)
removeAsync in interface RMapAsync<K,V>removeAsync in class RedissonMap<K,V>public V put(K key, V value, long ttl, TimeUnit unit)
RMapCacheIf the map previously contained a mapping for the key, the old value is replaced by the specified value.
public RFuture<V> putIfAbsentAsync(K key, V value)
putIfAbsentAsync in interface RMapAsync<K,V>putIfAbsentAsync in class RedissonMap<K,V>public boolean fastPut(K key, V value, long ttl, TimeUnit ttlUnit)
RMapCacheIf the map previously contained a mapping for the key, the old value is replaced by the specified value.
Works faster than usual RMapCache.put(Object, Object, long, TimeUnit)
as it not returns previous value.
public RFuture<Boolean> fastPutAsync(K key, V value, long ttl, TimeUnit ttlUnit)
RMapCacheAsyncIf the map previously contained a mapping for the key, the old value is replaced by the specified value.
Works faster than usual RMapCacheAsync.putAsync(Object, Object, long, TimeUnit)
as it not returns previous value.
fastPutAsync in interface RMapCacheAsync<K,V>key - - map keyvalue - - map valuettl - - time to live for key\value entry.
If 0 then stores infinitely.ttlUnit - - time unittrue if value has been set successfullypublic boolean fastPut(K key, V value, long ttl, TimeUnit ttlUnit, long maxIdleTime, TimeUnit maxIdleUnit)
RMapCacheIf the map previously contained a mapping for the key, the old value is replaced by the specified value.
Works faster than usual RMapCache.put(Object, Object, long, TimeUnit, long, TimeUnit)
as it not returns previous value.
fastPut in interface RMapCache<K,V>key - - map keyvalue - - map valuettl - - time to live for key\value entry.
If 0 then time to live doesn't affect entry expiration.ttlUnit - - time unitmaxIdleTime - - max idle time for key\value entry.
If 0 then max idle time doesn't affect entry expiration.maxIdleUnit - - time unit
if maxIdleTime and ttl params are equal to 0
then entry stores infinitely.
public RFuture<Boolean> fastPutAsync(K key, V value, long ttl, TimeUnit ttlUnit, long maxIdleTime, TimeUnit maxIdleUnit)
RMapCacheAsyncIf the map previously contained a mapping for the key, the old value is replaced by the specified value.
Works faster than usual RMapCacheAsync.putAsync(Object, Object, long, TimeUnit, long, TimeUnit)
as it not returns previous value.
fastPutAsync in interface RMapCacheAsync<K,V>key - - map keyvalue - - map valuettl - - time to live for key\value entry.
If 0 then time to live doesn't affect entry expiration.ttlUnit - - time unitmaxIdleTime - - max idle time for key\value entry.
If 0 then max idle time doesn't affect entry expiration.maxIdleUnit - - time unit
if maxIdleTime and ttl params are equal to 0
then entry stores infinitely.
true if value has been set successfullypublic RFuture<V> putAsync(K key, V value, long ttl, TimeUnit ttlUnit)
RMapCacheAsyncputAsync in interface RMapCacheAsync<K,V>key - - map keyvalue - - map valuettl - - time to live for key\value entry.
If 0 then stores infinitely.ttlUnit - - time unitpublic V put(K key, V value, long ttl, TimeUnit ttlUnit, long maxIdleTime, TimeUnit maxIdleUnit)
RMapCacheIf the map previously contained a mapping for the key, the old value is replaced by the specified value.
put in interface RMapCache<K,V>key - - map keyvalue - - map valuettl - - time to live for key\value entry.
If 0 then time to live doesn't affect entry expiration.ttlUnit - - time unitmaxIdleTime - - max idle time for key\value entry.
If 0 then max idle time doesn't affect entry expiration.maxIdleUnit - - time unit
if maxIdleTime and ttl params are equal to 0
then entry stores infinitely.
public RFuture<V> putAsync(K key, V value, long ttl, TimeUnit ttlUnit, long maxIdleTime, TimeUnit maxIdleUnit)
RMapCacheAsyncIf the map previously contained a mapping for the key, the old value is replaced by the specified value.
putAsync in interface RMapCacheAsync<K,V>key - - map keyvalue - - map valuettl - - time to live for key\value entry.
If 0 then time to live doesn't affect entry expiration.ttlUnit - - time unitmaxIdleTime - - max idle time for key\value entry.
If 0 then max idle time doesn't affect entry expiration.maxIdleUnit - - time unit
if maxIdleTime and ttl params are equal to 0
then entry stores infinitely.
public RFuture<V> removeAsync(K key)
removeAsync in interface RMapAsync<K,V>removeAsync in class RedissonMap<K,V>public RFuture<Long> fastRemoveAsync(K... keys)
RMapAsynckeys from map by one operation in async manner
Works faster than RMap.removeAsync but doesn't return
the value associated with keyfastRemoveAsync in interface RMapAsync<K,V>fastRemoveAsync in class RedissonMap<K,V>keys - - map keyspublic RFuture<Boolean> fastPutAsync(K key, V value)
RMapAsyncvalue with the specified key
in async manner.
Works faster than RMap.putAsync but not returning
the previous value associated with keyfastPutAsync in interface RMapAsync<K,V>fastPutAsync in class RedissonMap<K,V>key - - map keyvalue - - map valuetrue if key is a new key in the hash and value was set.
false if key already exists in the hash and the value was updated.public RFuture<Boolean> fastPutIfAbsentAsync(K key, V value)
fastPutIfAbsentAsync in interface RMapAsync<K,V>fastPutIfAbsentAsync in class RedissonMap<K,V>public RFuture<Boolean> replaceAsync(K key, V oldValue, V newValue)
replaceAsync in interface RMapAsync<K,V>replaceAsync in class RedissonMap<K,V>public RFuture<V> replaceAsync(K key, V value)
replaceAsync in interface RMapAsync<K,V>replaceAsync in class RedissonMap<K,V>public RFuture<Void> putAllAsync(Map<? extends K,? extends V> map)
putAllAsync in interface RMapAsync<K,V>putAllAsync in class RedissonMap<K,V>public RFuture<Boolean> deleteAsync()
RObjectAsyncdeleteAsync in interface RObjectAsynctrue if object was deleted false if notpublic RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit)
RExpirableAsyncexpireAsync in interface RExpirableAsynctimeToLive - - timeout before object will be deletedtimeUnit - - timeout time unittrue if the timeout was set and false if notpublic RFuture<Boolean> expireAtAsync(long timestamp)
RExpirableAsyncexpireAtAsync in interface RExpirableAsynctimestamp - - expire date in seconds (Unix timestamp)true if the timeout was set and false if notpublic RFuture<Boolean> clearExpireAsync()
RExpirableAsyncclearExpireAsync in interface RExpirableAsynctrue if the timeout was cleared and false if notpublic RFuture<Set<Map.Entry<K,V>>> readAllEntrySetAsync()
RMapAsyncreadAllEntrySetAsync in interface RMapAsync<K,V>readAllEntrySetAsync in class RedissonMap<K,V>public RFuture<Collection<V>> readAllValuesAsync()
RMapAsyncreadAllValuesAsync in interface RMapAsync<K,V>readAllValuesAsync in class RedissonMap<K,V>public boolean expire(long timeToLive,
TimeUnit timeUnit)
RExpirableexpire in interface RExpirabletimeToLive - - timeout before object will be deletedtimeUnit - - timeout time unittrue if the timeout was set and false if notpublic boolean expireAt(long timestamp)
RExpirableexpireAt in interface RExpirabletimestamp - - expire date in milliseconds (Unix timestamp)true if the timeout was set and false if notpublic boolean expireAt(Date timestamp)
RExpirableexpireAt in interface RExpirabletimestamp - - expire datetrue if the timeout was set and false if notpublic RFuture<Boolean> expireAtAsync(Date timestamp)
RExpirableAsyncexpireAtAsync in interface RExpirableAsynctimestamp - - expire datetrue if the timeout was set and false if notpublic boolean clearExpire()
RExpirableclearExpire in interface RExpirabletrue if timeout was removed
false if object does not exist or does not have an associated timeoutpublic long remainTimeToLive()
RExpirableremainTimeToLive in interface RExpirablepublic RFuture<Long> remainTimeToLiveAsync()
RExpirableAsyncremainTimeToLiveAsync in interface RExpirableAsync-1 if object does not exist or time in secondsprotected boolean await(RFuture<?> future, long timeout, TimeUnit timeoutUnit) throws InterruptedException
InterruptedExceptionprotected <V> V get(RFuture<V> future)
protected <V> RPromise<V> newPromise()
protected <V> RFuture<V> newSucceededFuture(V result)
public void rename(String newName)
RObjectnewNamepublic RFuture<Void> renameAsync(String newName)
RObjectAsyncnewName
in async moderenameAsync in interface RObjectAsyncnewName - - new name of objectpublic void migrate(String host, int port, int database)
RObjectpublic RFuture<Void> migrateAsync(String host, int port, int database)
RObjectAsyncmigrateAsync in interface RObjectAsynchost - - destination hostport - - destination portdatabase - - destination databasepublic boolean move(int database)
RObjectpublic RFuture<Boolean> moveAsync(int database)
RObjectAsyncmoveAsync in interface RObjectAsyncdatabase - - number of Redis databasetrue if key was moved false if notpublic boolean renamenx(String newName)
RObjectnewName
only if new key is not existspublic RFuture<Boolean> renamenxAsync(String newName)
RObjectAsyncnewName
in async mode only if new key is not existsrenamenxAsync in interface RObjectAsyncnewName - - new name of objecttrue if object has been renamed successfully and false otherwisepublic boolean delete()
RObjectpublic boolean isExists()
RObjectpublic RFuture<Boolean> isExistsAsync()
RObjectAsyncisExistsAsync in interface RObjectAsynctrue if object exists and false otherwisepublic Codec getCodec()
RObjectprotected byte[] encode(Object value)
protected byte[] encodeMapKey(Object value)
protected byte[] encodeMapValue(Object value)
Copyright © 2014–2016 The Redisson Project. All rights reserved.