public interface RemoteCache<K,V> extends BasicCache<K,V>
Cache, but given its
nature (remote) some operations are not supported. All these unsupported operations are being overridden within this
interface and documented as such.
New operations: besides the operations inherited from Cache, RemoteCache also adds new
operations to optimize/reduce network traffic: e.g. versioned put operation.
Concurrency: implementors of this interface will support multi-threaded access, similar to the way Cache supports it.
Return values: previously existing values for certain Map operations are not returned, null
is returned instead. E.g. Map.put(Object, Object) returns the previous value associated to the
supplied key. In case of RemoteCache, this returns null.
Synthetic operations: aggregate operations are being implemented based on other Hot Rod operations. E.g. all
the Map.putAll(java.util.Map) is implemented through multiple individual puts. This means that the
these operations are not atomic and that they are costly, e.g. as the number of network round-trips is not one, but
the size of the added map. All these synthetic operations are documented as such.
changing default behavior through Flags: it is possible to change the
default cache behaviour by using flags on an per invocation basis. E.g.
RemoteCache cache = getRemoteCache();
Object oldValue = cache.withFlags(Flag.FORCE_RETURN_VALUE).put(aKey, aValue);
In the previous example, using Flag.FORCE_RETURN_VALUE will make the client to
also return previously existing value associated with aKey. If this flag would not be present, Infinispan
would return (by default) null. This is in order to avoid fetching a possibly large object from the remote
server, which might not be needed. The flags as set by the withFlags(Flag...)
operation only apply for the very next operation executed by the same thread on the RemoteCache.
Eviction and expiration: Unlike local Cache cache, which allows specifying time values with any granularity (as defined by TimeUnit), HotRod only supports seconds as time units. If a different time unit is used instead, HotRod will
transparently convert it to seconds, using TimeUnit.toSeconds(long) method. This might
result in loss of precision for values specified as nanos or milliseconds. | Modifier and Type | Method and Description |
|---|---|
void |
addClientListener(Object listener)
Add a client listener to receive events that happen in the remote cache.
|
void |
addClientListener(Object listener,
Object[] filterFactoryParams,
Object[] converterFactoryParams)
Add a client listener to receive events that happen in the remote cache.
|
boolean |
containsValue(Object value) |
Set<Map.Entry<K,V>> |
entrySet() |
<T> T |
execute(String scriptName,
Map<String,?> params)
Executes a remote script passing a set of named parameters
|
Map<K,V> |
getAll(Set<? extends K> keys)
Retrieves all of the entries for the provided keys.
|
Map<K,V> |
getBulk()
Deprecated.
Bulk retrievals can be quite expensive if for large data sets.
Alternatively, the different
retrieveEntries* methods offer
lazy, pull-style, methods that retrieve bulk data more efficiently. |
Map<K,V> |
getBulk(int size)
Deprecated.
Bulk retrievals can be quite expensive if for large data sets.
Alternatively, the different
retrieveEntries* methods offer
lazy, pull-style, methods that retrieve bulk data more efficiently. |
CacheTopologyInfo |
getCacheTopologyInfo()
Returns
CacheTopologyInfo for this cache. |
Set<Object> |
getListeners()
Returns a set with all the listeners registered by this client for the
given cache.
|
String |
getProtocolVersion()
Returns the HotRod protocol version supported by this RemoteCache implementation
|
RemoteCacheManager |
getRemoteCacheManager()
Returns the
RemoteCacheManager that created this cache. |
VersionedValue<V> |
getVersioned(K key)
Deprecated.
Use
getWithMetadata(Object) instead |
MetadataValue<V> |
getWithMetadata(K key)
Returns the
MetadataValue associated to the supplied key param, or null if it doesn't exist. |
boolean |
isEmpty() |
Set<K> |
keySet()
Returns all keys in the remote server.
|
void |
putAll(Map<? extends K,? extends V> m)
Synthetic operation.
|
void |
putAll(Map<? extends K,? extends V> map,
long lifespan,
TimeUnit unit)
Synthetic operation.
|
void |
putAll(Map<? extends K,? extends V> map,
long lifespan,
TimeUnit lifespanUnit,
long maxIdleTime,
TimeUnit maxIdleTimeUnit)
Synthetic operation.
|
CompletableFuture<Void> |
putAllAsync(Map<? extends K,? extends V> data)
Synthetic operation.
|
CompletableFuture<Void> |
putAllAsync(Map<? extends K,? extends V> data,
long lifespan,
TimeUnit unit)
Synthetic operation.
|
CompletableFuture<Void> |
putAllAsync(Map<? extends K,? extends V> data,
long lifespan,
TimeUnit lifespanUnit,
long maxIdle,
TimeUnit maxIdleUnit)
Synthetic operation.
|
void |
removeClientListener(Object listener)
Remove a previously added client listener.
|
boolean |
removeWithVersion(K key,
long version)
Removes the given entry only if its version matches the supplied version.
|
CompletableFuture<Boolean> |
removeWithVersionAsync(K key,
long version) |
boolean |
replaceWithVersion(K key,
V newValue,
long version)
Replaces the given value only if its version matches the supplied version.
|
boolean |
replaceWithVersion(K key,
V newValue,
long version,
int lifespanSeconds)
A overloaded form of
replaceWithVersion(Object, Object, long)
which takes in lifespan parameters. |
boolean |
replaceWithVersion(K key,
V newValue,
long version,
int lifespanSeconds,
int maxIdleTimeSeconds)
A overloaded form of
replaceWithVersion(Object, Object, long)
which takes in lifespan and maximum idle time parameters. |
boolean |
replaceWithVersion(K key,
V newValue,
long version,
long lifespan,
TimeUnit lifespanTimeUnit,
long maxIdle,
TimeUnit maxIdleTimeUnit)
A overloaded form of
replaceWithVersion(Object, Object, long)
which takes in lifespan and maximum idle time parameters. |
CompletableFuture<Boolean> |
replaceWithVersionAsync(K key,
V newValue,
long version) |
CompletableFuture<Boolean> |
replaceWithVersionAsync(K key,
V newValue,
long version,
int lifespanSeconds) |
CompletableFuture<Boolean> |
replaceWithVersionAsync(K key,
V newValue,
long version,
int lifespanSeconds,
int maxIdleSeconds) |
CloseableIterator<Map.Entry<Object,Object>> |
retrieveEntries(String filterConverterFactory,
int batchSize) |
CloseableIterator<Map.Entry<Object,Object>> |
retrieveEntries(String filterConverterFactory,
Object[] filterConverterParams,
Set<Integer> segments,
int batchSize)
Retrieve entries from the server
|
CloseableIterator<Map.Entry<Object,Object>> |
retrieveEntries(String filterConverterFactory,
Set<Integer> segments,
int batchSize) |
CloseableIterator<Map.Entry<Object,Object>> |
retrieveEntriesByQuery(Query filterQuery,
Set<Integer> segments,
int batchSize)
Retrieve entries from the server matching a query.
|
CloseableIterator<Map.Entry<Object,MetadataValue<Object>>> |
retrieveEntriesWithMetadata(Set<Integer> segments,
int batchSize)
Retrieve entries with metadata information
|
int |
size() |
ServerStatistics |
stats() |
StreamingRemoteCache<K> |
streaming()
Returns a cache where values are manipulated using
InputStream and OutputStream |
Collection<V> |
values() |
RemoteCache<K,V> |
withFlags(Flag... flags)
Applies one or more
Flags to the scope of a single invocation. |
getName, getVersion, put, put, put, putIfAbsent, putIfAbsent, remove, replace, replace, replace, replaceclearAsync, getAsync, putAsync, putAsync, putAsync, putIfAbsentAsync, putIfAbsentAsync, putIfAbsentAsync, removeAsync, removeAsync, replaceAsync, replaceAsync, replaceAsync, replaceAsync, replaceAsync, replaceAsynccompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllboolean removeWithVersion(K key, long version)
VersionedEntry ve = remoteCache.getVersioned(key); //some processing remoteCache.removeWithVersion(key, ve.getVersion();Lat call (removeWithVersion) will make sure that the entry will only be removed if it hasn't been changed in between.
VersionedValue,
getVersioned(Object)CompletableFuture<Boolean> removeWithVersionAsync(K key, long version)
ConcurrentMap.remove(Object, Object)boolean replaceWithVersion(K key, V newValue, long version)
removeWithVersion(Object, long) for a sample usage of the
version-based methods.version - numeric version that should match the one in the server
for the operation to succeedgetVersioned(Object),
VersionedValueboolean replaceWithVersion(K key, V newValue, long version, int lifespanSeconds)
replaceWithVersion(Object, Object, long)
which takes in lifespan parameters.key - key to usenewValue - new value to be associated with the keyversion - numeric version that should match the one in the server
for the operation to succeedlifespanSeconds - lifespan of the entryboolean replaceWithVersion(K key, V newValue, long version, int lifespanSeconds, int maxIdleTimeSeconds)
replaceWithVersion(Object, Object, long)
which takes in lifespan and maximum idle time parameters.key - key to usenewValue - new value to be associated with the keyversion - numeric version that should match the one in the server
for the operation to succeedlifespanSeconds - lifespan of the entrymaxIdleTimeSeconds - the maximum amount of time this key is allowed
to be idle for before it is considered as expiredboolean replaceWithVersion(K key, V newValue, long version, long lifespan, TimeUnit lifespanTimeUnit, long maxIdle, TimeUnit maxIdleTimeUnit)
replaceWithVersion(Object, Object, long)
which takes in lifespan and maximum idle time parameters.key - key to usenewValue - new value to be associated with the keyversion - numeric version that should match the one in the server
for the operation to succeedlifespan - lifespan of the entrylifespanTimeUnit - TimeUnit for lifespanmaxIdle - the maximum amount of time this key is allowed
to be idle for before it is considered as expiredmaxIdleTimeUnit - TimeUnit for maxIdleCompletableFuture<Boolean> replaceWithVersionAsync(K key, V newValue, long version)
replaceWithVersion(Object, Object, long)CompletableFuture<Boolean> replaceWithVersionAsync(K key, V newValue, long version, int lifespanSeconds)
replaceWithVersion(Object, Object, long)CompletableFuture<Boolean> replaceWithVersionAsync(K key, V newValue, long version, int lifespanSeconds, int maxIdleSeconds)
replaceWithVersion(Object, Object, long)CloseableIterator<Map.Entry<Object,Object>> retrieveEntries(String filterConverterFactory, Set<Integer> segments, int batchSize)
CloseableIterator<Map.Entry<Object,Object>> retrieveEntries(String filterConverterFactory, Object[] filterConverterParams, Set<Integer> segments, int batchSize)
filterConverterFactory - Factory name for the KeyValueFilterConverter or null for no filtering.filterConverterParams - Parameters to the KeyValueFilterConvertersegments - The segments to iterate. If null all segments will be iterated. An empty set will filter out all entries.batchSize - The number of entries transferred from the server at a time.CloseableIterator<Map.Entry<Object,Object>> retrieveEntries(String filterConverterFactory, int batchSize)
CloseableIterator<Map.Entry<Object,Object>> retrieveEntriesByQuery(Query filterQuery, Set<Integer> segments, int batchSize)
filterQuery - Querysegments - The segments to iterate. If null all segments will be iterated. An empty set will filter out all entries.batchSize - The number of entries transferred from the server at a time.CloseableIteratorCloseableIterator<Map.Entry<Object,MetadataValue<Object>>> retrieveEntriesWithMetadata(Set<Integer> segments, int batchSize)
@Deprecated VersionedValue<V> getVersioned(K key)
getWithMetadata(Object) insteadVersionedValue associated to the supplied key param, or null if it doesn't exist.MetadataValue<V> getWithMetadata(K key)
MetadataValue associated to the supplied key param, or null if it doesn't exist.int size()
size in interface Map<K,V>UnsupportedOperationExceptionboolean isEmpty()
isEmpty in interface Map<K,V>UnsupportedOperationExceptionboolean containsValue(Object value)
containsValue in interface Map<K,V>UnsupportedOperationExceptionSet<K> keySet()
Collection<V> values()
values in interface Map<K,V>UnsupportedOperationExceptionSet<Map.Entry<K,V>> entrySet()
entrySet in interface Map<K,V>UnsupportedOperationExceptionvoid putAll(Map<? extends K,? extends V> map, long lifespan, TimeUnit unit)
putAll in interface BasicCache<K,V>map - map containing mappings to enterlifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.unit - unit of measurement for the lifespanvoid putAll(Map<? extends K,? extends V> map, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
putAll in interface BasicCache<K,V>map - map containing mappings to enterlifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit - time unit for lifespanmaxIdleTime - the maximum amount of time this key is allowed to be idle for before it is considered as
expiredmaxIdleTimeUnit - time unit for max idle timeputAll(java.util.Map, long, java.util.concurrent.TimeUnit)CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> data)
putAllAsync in interface AsyncCache<K,V>data - to storeputAll(java.util.Map, long, java.util.concurrent.TimeUnit)CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> data, long lifespan, TimeUnit unit)
putAllAsync in interface AsyncCache<K,V>data - to storelifespan - lifespan of entryunit - time unit for lifespanputAll(java.util.Map, long, java.util.concurrent.TimeUnit)CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> data, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
putAllAsync in interface AsyncCache<K,V>data - to storelifespan - lifespan of entrylifespanUnit - time unit for lifespanmaxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as
expiredmaxIdleUnit - time unit for max idle timeputAll(java.util.Map, long, java.util.concurrent.TimeUnit)void putAll(Map<? extends K,? extends V> m)
putAll in interface Map<K,V>putAll(java.util.Map, long, java.util.concurrent.TimeUnit)ServerStatistics stats()
RemoteCache<K,V> withFlags(Flag... flags)
Flags to the scope of a single invocation. See the Flag enumeration to for
information on available flags.
Sample usage:
remoteCache.withFlags(Flag.FORCE_RETURN_VALUE).put("hello", "world");
flags - RemoteCacheManager getRemoteCacheManager()
RemoteCacheManager that created this cache.@Deprecated Map<K,V> getBulk()
retrieveEntries* methods offer
lazy, pull-style, methods that retrieve bulk data more efficiently.@Deprecated Map<K,V> getBulk(int size)
retrieveEntries* methods offer
lazy, pull-style, methods that retrieve bulk data more efficiently.getBulk(), but limits the returned set of values to the specified size. No ordering is guaranteed, and there is no
guarantee that "size" elements are returned( e.g. if the number of elements in the back-end server is smaller that "size")Map<K,V> getAll(Set<? extends K> keys)
keys - The keys to find values forString getProtocolVersion()
void addClientListener(Object listener)
void addClientListener(Object listener, Object[] filterFactoryParams, Object[] converterFactoryParams)
void removeClientListener(Object listener)
Set<Object> getListeners()
<T> T execute(String scriptName, Map<String,?> params)
CacheTopologyInfo getCacheTopologyInfo()
CacheTopologyInfo for this cache.StreamingRemoteCache<K> streaming()
InputStream and OutputStreamCopyright © 2017 JBoss, a division of Red Hat. All rights reserved.