Package org.infinispan.client.hotrod.impl

Class DelegatingRemoteCache<K,V>

java.lang.Object

org.infinispan.client.hotrod.impl.RemoteCacheSupport<K,V>

org.infinispan.client.hotrod.impl.DelegatingRemoteCache<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

ConcurrentMap<K,V>, Map<K,V>, InternalRemoteCache<K,V>, RemoteCache<K,V>, AsyncCache<K,V>, BasicCache<K,V>, Lifecycle, TransactionalCache

Direct Known Subclasses:

InvalidatedNearRemoteCache

public abstract class DelegatingRemoteCache<K,V>
extends RemoteCacheSupport<K,V>
implements InternalRemoteCache<K,V>

Delegates all invocations to the provided underlying InternalRemoteCache but provides extensibility to intercept when a method is invoked. Currently all methods are supported except for iterators produced from the keyIterator(IntSet) and entryIterator(IntSet) which are known to invoke back into the delegate cache.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected final InternalRemoteCache<K,V>	delegate

Fields inherited from class org.infinispan.client.hotrod.impl.RemoteCacheSupport

defaultLifespan, defaultMaxIdleTime

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DelegatingRemoteCache(InternalRemoteCache<K,V> delegate)

Method Summary

Modifier and Type	Method	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.
SocketAddress	addNearCacheListener(Object listener, int bloomBits)	Add a client listener to handle near cache with bloom filter optimization The listener object must be annotated with @ClientListener annotation.
CompletableFuture<Void>	clearAsync()	Asynchronous version of Map.clear().
ClientStatistics	clientStatistics()	Returns client-side statistics for this cache.
CompletableFuture<V>	computeAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.compute(Object, BiFunction, long, TimeUnit, long, TimeUnit).
CompletableFuture<V>	computeIfAbsentAsync(K key, Function<? super K,? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.computeIfAbsent(Object, Function, long, TimeUnit, long, TimeUnit).
CompletableFuture<V>	computeIfPresentAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.computeIfPresent(Object, BiFunction, long, TimeUnit, long, TimeUnit) .
CompletableFuture<Boolean>	containsKeyAsync(K key)	Asynchronous version of Map.containsKey(Object)
boolean	containsValue(Object value)
CloseableIterator<Map.Entry<K,V>>	entryIterator(IntSet segments)
CloseableIteratorSet<Map.Entry<K,V>>	entrySet(IntSet segments)	This method is identical to RemoteCache.entrySet() except that it will only return entries that map to the given segments.
<T> T	execute(String taskName, Map<String,?> params)	Executes a remote task passing a set of named parameters
CompletableFuture<Map<K,V>>	getAllAsync(Set<?> keys)	TODO This should be in AdvancedCache with getAll
CompletableFuture<V>	getAsync(K key)	Asynchronous version of Map.get(Object) that allows user code to retrieve the value associated with a key at a later stage, hence allowing multiple parallel get requests to be sent.
CacheTopologyInfo	getCacheTopologyInfo()	Returns CacheTopologyInfo for this cache.
DataFormat	getDataFormat()	Return the currently DataFormat being used.
Set<Object>	getListeners()	Returns a set with all the listeners registered by this client for the given cache.
String	getName()	Retrieves the name of the cache
org.infinispan.client.hotrod.impl.operations.OperationsFactory	getOperationsFactory()
String	getProtocolVersion()	Returns the HotRod protocol version supported by this RemoteCache implementation
RemoteCacheContainer	getRemoteCacheContainer()	Returns the RemoteCacheContainer that created this cache.
String	getVersion()	Retrieves the version of Infinispan
CompletableFuture<MetadataValue<V>>	getWithMetadataAsync(K key)	Asynchronously returns the MetadataValue associated to the supplied key param, or null if it doesn't exist.
org.infinispan.client.hotrod.impl.operations.RetryAwareCompletionStage<MetadataValue<V>>	getWithMetadataAsync(K key, SocketAddress preferredAddres)
boolean	hasForceReturnFlag()
void	init(org.infinispan.client.hotrod.impl.operations.OperationsFactory operationsFactory, Configuration configuration)
void	init(org.infinispan.client.hotrod.impl.operations.OperationsFactory operationsFactory, Configuration configuration, ObjectName jmxParent)
boolean	isEmpty()
boolean	isObjectStorage()
boolean	isTransactional()
CloseableIterator<K>	keyIterator(IntSet segments)
CloseableIteratorSet<K>	keySet(IntSet segments)	This method is identical to RemoteCache.keySet() except that it will only return keys that map to the given segments.
byte[]	keyToBytes(Object o)
CompletableFuture<V>	mergeAsync(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)	Asynchronous version of BasicCache.merge(Object, Object, BiFunction, long, TimeUnit, long, TimeUnit).
CompletionStage<org.infinispan.client.hotrod.impl.operations.PingResponse>	ping()
<E> org.reactivestreams.Publisher<Map.Entry<K,E>>	publishEntries(String filterConverterFactory, Object[] filterConverterParams, Set<Integer> segments, int batchSize)	Publishes the entries from the server in a non blocking fashion.
<E> org.reactivestreams.Publisher<Map.Entry<K,E>>	publishEntriesByQuery(Query<?> filterQuery, Set<Integer> segments, int batchSize)	Publish entries from the server matching a query.
org.reactivestreams.Publisher<Map.Entry<K,MetadataValue<V>>>	publishEntriesWithMetadata(Set<Integer> segments, int batchSize)	Publish entries with metadata information
CompletableFuture<Void>	putAllAsync(Map<? extends K,? extends V> data, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Adds or overrides each specified entry in the remote cache.
CompletableFuture<V>	putAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.put(Object, Object, long, TimeUnit, long, TimeUnit).
CompletableFuture<V>	putIfAbsentAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.putIfAbsent(Object, Object, long, TimeUnit, long, TimeUnit).
CompletableFuture<V>	removeAsync(Object key)	Asynchronous version of BasicCache.remove(Object).
CompletableFuture<Boolean>	removeAsync(Object key, Object value)	Asynchronous version of ConcurrentMap.remove(Object, Object).
void	removeClientListener(Object listener)	Remove a previously added client listener.
CompletableFuture<Boolean>	removeWithVersionAsync(K key, long version)
void	replaceAll(BiFunction<? super K,? super V,? extends V> function)
CompletableFuture<V>	replaceAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.replace(Object, Object, long, TimeUnit, long, TimeUnit).
CompletableFuture<Boolean>	replaceAsync(K key, V oldValue, V newValue, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.replace(Object, Object, Object, long, TimeUnit, long, TimeUnit).
CompletableFuture<Boolean>	replaceWithVersionAsync(K key, V newValue, long version, long lifespanSeconds, TimeUnit lifespanTimeUnit, long maxIdle, TimeUnit maxIdleTimeUnit)
void	resolveStorage(boolean objectStorage)
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>>	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
ServerStatistics	serverStatistics()	Returns server-side statistics for this cache.
CompletionStage<ServerStatistics>	serverStatisticsAsync()	Returns server-side statistics for this cache.
CompletableFuture<Long>	sizeAsync()	Asynchronous version of Map.size().
void	start()	Invoked on component start
void	stop()	Invoked on component stop
StreamingRemoteCache<K>	streaming()	Returns a cache where values are manipulated using InputStream and OutputStream
CompletionStage<Void>	updateBloomFilter()	Sends the current bloom filter to the listener node where a near cache listener is installed.
CloseableIteratorCollection<V>	values(IntSet segments)	This method is identical to RemoteCache.values() except that it will only return values that map to the given segments.
<T, U> InternalRemoteCache<T,U>	withDataFormat(DataFormat dataFormat)	Return a new instance of RemoteCache using the supplied DataFormat.
InternalRemoteCache<K,V>	withFlags(Flag... flags)	Applies one or more Flags to the scope of a single invocation.

Methods inherited from class org.infinispan.client.hotrod.impl.RemoteCacheSupport

clear, compute, compute, compute, computeAsync, computeAsync, computeIfAbsent, computeIfAbsent, computeIfAbsent, computeIfAbsentAsync, computeIfAbsentAsync, computeIfPresent, computeIfPresent, computeIfPresent, computeIfPresentAsync, computeIfPresentAsync, containsKey, get, getAll, getWithMetadata, merge, merge, merge, mergeAsync, mergeAsync, put, put, put, putAll, putAll, putAll, putAllAsync, putAllAsync, putAsync, putAsync, putIfAbsent, putIfAbsent, putIfAbsent, putIfAbsentAsync, putIfAbsentAsync, remove, remove, removeWithVersion, replace, replace, replace, replace, replace, replace, replaceAsync, replaceAsync, replaceAsync, replaceAsync, replaceWithVersion, replaceWithVersion, replaceWithVersion, replaceWithVersion, replaceWithVersionAsync, replaceWithVersionAsync, replaceWithVersionAsync, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commons.api.AsyncCache

computeAsync, computeAsync, computeIfAbsentAsync, computeIfAbsentAsync, computeIfPresentAsync, computeIfPresentAsync, mergeAsync, mergeAsync, putAsync, putAsync, putIfAbsentAsync, putIfAbsentAsync, replaceAsync, replaceAsync, replaceAsync, replaceAsync

Methods inherited from interface org.infinispan.commons.api.BasicCache

compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, merge, merge, put, put, put, putIfAbsent, putIfAbsent, replace, replace

Methods inherited from interface java.util.concurrent.ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, replace

Methods inherited from interface org.infinispan.client.hotrod.impl.InternalRemoteCache

removeEntry, removeEntry, resolveStorage

Methods inherited from interface java.util.Map

clear, containsKey, equals, get, hashCode, size

Methods inherited from interface org.infinispan.client.hotrod.RemoteCache

entrySet, execute, execute, getAll, getRemoteCacheManager, getWithMetadata, keySet, putAll, putAll, putAll, putAllAsync, putAllAsync, remove, remove, removeWithVersion, replace, replace, replace, replaceWithVersion, replaceWithVersion, replaceWithVersion, replaceWithVersion, replaceWithVersionAsync, replaceWithVersionAsync, replaceWithVersionAsync, retrieveEntries, retrieveEntries, stats, values

Methods inherited from interface org.infinispan.commons.api.TransactionalCache

getTransactionManager

Field Details

delegate

protected final InternalRemoteCache<K,V> delegate

Constructor Details

DelegatingRemoteCache

protected DelegatingRemoteCache(InternalRemoteCache<K,V> delegate)

Method Details

putAllAsync

public CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> data,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: RemoteCache

Adds or overrides each specified entry in the remote cache. This operation provides better performance than calling put() for each entry.

Specified by:

putAllAsync in interface AsyncCache<K,V>

Specified by:

putAllAsync in interface RemoteCache<K,V>

Specified by:

putAllAsync in class RemoteCacheSupport<K,V>

Parameters:

data - to store

lifespan - lifespan of entry

lifespanUnit - time unit for lifespan

maxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleUnit - time unit for max idle time

Returns:

a future containing a void return type

See Also:

• RemoteCache.putAll(java.util.Map, long, java.util.concurrent.TimeUnit)

clearAsync

public CompletableFuture<Void> clearAsync()

Description copied from interface: AsyncCache

Asynchronous version of Map.clear(). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

clearAsync in interface AsyncCache<K,V>

Returns:

a future containing a void return type

clientStatistics

public ClientStatistics clientStatistics()

Description copied from interface: RemoteCache

Returns client-side statistics for this cache.

Specified by:

clientStatistics in interface InternalRemoteCache<K,V>

Specified by:

clientStatistics in interface RemoteCache<K,V>

serverStatistics

public ServerStatistics serverStatistics()

Description copied from interface: RemoteCache

Returns server-side statistics for this cache.

Specified by:

serverStatistics in interface RemoteCache<K,V>

serverStatisticsAsync

public CompletionStage<ServerStatistics> serverStatisticsAsync()

Description copied from interface: RemoteCache

Returns server-side statistics for this cache.

Specified by:

serverStatisticsAsync in interface RemoteCache<K,V>

withFlags

public InternalRemoteCache<K,V> withFlags(Flag... flags)

Description copied from interface: RemoteCache

Applies one or more 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");
 

Specified by:

withFlags in interface InternalRemoteCache<K,V>

Specified by:

withFlags in interface RemoteCache<K,V>

Returns:

the current RemoteCache instance to continue running operations on.

getRemoteCacheContainer

public RemoteCacheContainer getRemoteCacheContainer()

Description copied from interface: RemoteCache

Returns the RemoteCacheContainer that created this cache.

Specified by:

getRemoteCacheContainer in interface RemoteCache<K,V>

getAllAsync

public CompletableFuture<Map<K,V>> getAllAsync(Set<?> keys)

Description copied from interface: AsyncCache

TODO This should be in AdvancedCache with getAll

Specified by:

getAllAsync in interface AsyncCache<K,V>

Specified by:

getAllAsync in class RemoteCacheSupport<K,V>

getProtocolVersion

public String getProtocolVersion()

Description copied from interface: RemoteCache

Returns the HotRod protocol version supported by this RemoteCache implementation

Specified by:

getProtocolVersion in interface RemoteCache<K,V>

addClientListener

public void addClientListener(Object listener)

Description copied from interface: RemoteCache

Add a client listener to receive events that happen in the remote cache. The listener object must be annotated with @ClientListener annotation.

Specified by:

addClientListener in interface RemoteCache<K,V>

addClientListener

public void addClientListener(Object listener,
 Object[] filterFactoryParams,
 Object[] converterFactoryParams)

Description copied from interface: RemoteCache

Add a client listener to receive events that happen in the remote cache. The listener object must be annotated with @ClientListener annotation.

Specified by:

addClientListener in interface RemoteCache<K,V>

removeClientListener

public void removeClientListener(Object listener)

Description copied from interface: RemoteCache

Remove a previously added client listener. If the listener was not added before, this operation is a no-op.

Specified by:

removeClientListener in interface RemoteCache<K,V>

addNearCacheListener

public SocketAddress addNearCacheListener(Object listener,
 int bloomBits)

Description copied from interface: InternalRemoteCache

Add a client listener to handle near cache with bloom filter optimization The listener object must be annotated with @ClientListener annotation.

Specified by:

addNearCacheListener in interface InternalRemoteCache<K,V>

getListeners

public Set<Object> getListeners()

Description copied from interface: RemoteCache

Returns a set with all the listeners registered by this client for the given cache.

Specified by:

getListeners in interface RemoteCache<K,V>

execute

public <T> T execute(String taskName,
 Map<String,?> params)

Description copied from interface: RemoteCache

Executes a remote task passing a set of named parameters

Specified by:

execute in interface RemoteCache<K,V>

getCacheTopologyInfo

public CacheTopologyInfo getCacheTopologyInfo()

Description copied from interface: RemoteCache

Returns CacheTopologyInfo for this cache.

Specified by:

getCacheTopologyInfo in interface RemoteCache<K,V>

streaming

public StreamingRemoteCache<K> streaming()

Description copied from interface: RemoteCache

Returns a cache where values are manipulated using InputStream and OutputStream

Specified by:

streaming in interface RemoteCache<K,V>

withDataFormat

public <T,
U> InternalRemoteCache<T,U> withDataFormat(DataFormat dataFormat)

Description copied from interface: RemoteCache

Return a new instance of RemoteCache using the supplied DataFormat.

Specified by:

withDataFormat in interface InternalRemoteCache<K,V>

Specified by:

withDataFormat in interface RemoteCache<K,V>

getDataFormat

public DataFormat getDataFormat()

Description copied from interface: RemoteCache

Return the currently DataFormat being used.

Specified by:

getDataFormat in interface RemoteCache<K,V>

isTransactional

public boolean isTransactional()

Specified by:

isTransactional in interface RemoteCache<K,V>

Returns:

true if the cache can participate in a transaction, false otherwise.

putIfAbsentAsync

public CompletableFuture<V> putIfAbsentAsync(K key,
 V value,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.putIfAbsent(Object, Object, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

putIfAbsentAsync in interface AsyncCache<K,V>

Specified by:

putIfAbsentAsync in class RemoteCacheSupport<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of entry

lifespanUnit - time unit for lifespan

maxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleUnit - time unit for max idle time

Returns:

a future containing the old value replaced

replaceAsync

public CompletableFuture<Boolean> replaceAsync(K key,
 V oldValue,
 V newValue,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.replace(Object, Object, Object, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

replaceAsync in interface AsyncCache<K,V>

Specified by:

replaceAsync in class RemoteCacheSupport<K,V>

Parameters:

key - key to remove

oldValue - value to overwrite

newValue - value to store

lifespan - lifespan of entry

lifespanUnit - time unit for lifespan

maxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleUnit - time unit for max idle time

Returns:

a future containing a boolean, indicating whether the entry was replaced or not

replaceAsync

public CompletableFuture<V> replaceAsync(K key,
 V value,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.replace(Object, Object, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

replaceAsync in interface AsyncCache<K,V>

Specified by:

replaceAsync in class RemoteCacheSupport<K,V>

Parameters:

key - key to remove

value - value to store

lifespan - lifespan of entry

lifespanUnit - time unit for lifespan

maxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleUnit - time unit for max idle time

Returns:

a future containing the previous value overwritten

getAsync

public CompletableFuture<V> getAsync(K key)

Description copied from interface: AsyncCache

Asynchronous version of Map.get(Object) that allows user code to retrieve the value associated with a key at a later stage, hence allowing multiple parallel get requests to be sent. Normally, when this method detects that the value is likely to be retrieved from from a remote entity, it will span a different thread in order to allow the asynchronous get call to return immediately. If the call will definitely resolve locally, for example when the cache is configured with LOCAL mode and no stores are configured, the get asynchronous call will act sequentially and will have no different to Map.get(Object).

Specified by:

getAsync in interface AsyncCache<K,V>

Specified by:

getAsync in class RemoteCacheSupport<K,V>

Parameters:

key - key to retrieve

Returns:

a future that can be used to retrieve value associated with the key when this is available. The actual value returned by the future follows the same rules as Map.get(Object)

getWithMetadataAsync

public CompletableFuture<MetadataValue<V>> getWithMetadataAsync(K key)

Description copied from interface: RemoteCache

Asynchronously returns the MetadataValue associated to the supplied key param, or null if it doesn't exist.

Specified by:

getWithMetadataAsync in interface RemoteCache<K,V>

Specified by:

getWithMetadataAsync in class RemoteCacheSupport<K,V>

getWithMetadataAsync

public org.infinispan.client.hotrod.impl.operations.RetryAwareCompletionStage<MetadataValue<V>> getWithMetadataAsync(K key,
 SocketAddress preferredAddres)

Specified by:

getWithMetadataAsync in interface InternalRemoteCache<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

keySet

public CloseableIteratorSet<K> keySet(IntSet segments)

Description copied from interface: RemoteCache

This method is identical to RemoteCache.keySet() except that it will only return keys that map to the given segments. Note that these segments will be determined by the remote server. Thus you should be aware of how many segments it has configured and hashing algorithm it is using. If the segments and hashing algorithm are not the same this method may return unexpected keys.

Specified by:

keySet in interface RemoteCache<K,V>

Parameters:

segments - the segments of keys to return - null means all available

Returns:

set containing keys that map to the given segments

See Also:

• RemoteCache.keySet()

values

public CloseableIteratorCollection<V> values(IntSet segments)

Description copied from interface: RemoteCache

This method is identical to RemoteCache.values() except that it will only return values that map to the given segments. Note that these segments will be determined by the remote server. Thus you should be aware of how many segments it has configured and hashing algorithm it is using. If the segments and hashing algorithm are not the same this method may return unexpected values.

Specified by:

values in interface RemoteCache<K,V>

Parameters:

segments - the segments of values to return - null means all available

Returns:

collection containing values that map to the given segments

See Also:

• RemoteCache.values()

entrySet

public CloseableIteratorSet<Map.Entry<K,V>> entrySet(IntSet segments)

Description copied from interface: RemoteCache

This method is identical to RemoteCache.entrySet() except that it will only return entries that map to the given segments. Note that these segments will be determined by the remote server. Thus you should be aware of how many segments it has configured and hashing algorithm it is using. If the segments and hashing algorithm are not the same this method may return unexpected entries.

Specified by:

entrySet in interface RemoteCache<K,V>

Parameters:

segments - the segments of entries to return - null means all available

Returns:

set containing entries that map to the given segments

See Also:

• RemoteCache.entrySet()

containsKeyAsync

public CompletableFuture<Boolean> containsKeyAsync(K key)

Description copied from interface: AsyncCache

Asynchronous version of Map.containsKey(Object)

Specified by:

containsKeyAsync in interface AsyncCache<K,V>

Specified by:

containsKeyAsync in class RemoteCacheSupport<K,V>

Parameters:

key - key to retrieve

Returns:

future containing true if the mapping exists.

putAsync

public CompletableFuture<V> putAsync(K key,
 V value,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.put(Object, Object, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

putAsync in interface AsyncCache<K,V>

Specified by:

putAsync in class RemoteCacheSupport<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of entry

lifespanUnit - time unit for lifespan

maxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleUnit - time unit for max idle time

Returns:

a future containing the old value replaced

replaceWithVersionAsync

public CompletableFuture<Boolean> replaceWithVersionAsync(K key,
 V newValue,
 long version,
 long lifespanSeconds,
 TimeUnit lifespanTimeUnit,
 long maxIdle,
 TimeUnit maxIdleTimeUnit)

Specified by:

replaceWithVersionAsync in interface RemoteCache<K,V>

See Also:

• RemoteCache.replaceWithVersion(Object, Object, long)

retrieveEntries

public CloseableIterator<Map.Entry<Object,Object>> retrieveEntries(String filterConverterFactory,
 Object[] filterConverterParams,
 Set<Integer> segments,
 int batchSize)

Description copied from interface: RemoteCache

Retrieve entries from the server.

Specified by:

retrieveEntries in interface RemoteCache<K,V>

Parameters:

filterConverterFactory - Factory name for the KeyValueFilterConverter or null for no filtering.

filterConverterParams - Parameters to the KeyValueFilterConverter

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

Returns:

Iterator for the entries

publishEntries

public <E>
org.reactivestreams.Publisher<Map.Entry<K,E>> publishEntries(String filterConverterFactory,
 Object[] filterConverterParams,
 Set<Integer> segments,
 int batchSize)

Description copied from interface: RemoteCache

Publishes the entries from the server in a non blocking fashion.

Any subscriber that subscribes to the returned Publisher must not block. It is therefore recommended to offload any blocking or long running operations to a different thread and not use the invoking one. Failure to do so may cause concurrent operations to stall.

Specified by:

publishEntries in interface RemoteCache<K,V>

Parameters:

filterConverterFactory - Factory name for the KeyValueFilterConverter or null for no filtering.

filterConverterParams - Parameters to the KeyValueFilterConverter

segments - The segments to utilize. If null all segments will be utilized. An empty set will filter out all entries.

batchSize - The number of entries transferred from the server at a time.

Returns:

Publisher for the entries

retrieveEntriesByQuery

public CloseableIterator<Map.Entry<Object,Object>> retrieveEntriesByQuery(Query<?> filterQuery,
 Set<Integer> segments,
 int batchSize)

Description copied from interface: RemoteCache

Retrieve entries from the server matching a query.

Specified by:

retrieveEntriesByQuery in interface RemoteCache<K,V>

Parameters:

filterQuery - Query

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

Returns:

CloseableIterator

publishEntriesByQuery

public <E>
org.reactivestreams.Publisher<Map.Entry<K,E>> publishEntriesByQuery(Query<?> filterQuery,
 Set<Integer> segments,
 int batchSize)

Description copied from interface: RemoteCache

Publish entries from the server matching a query.

Any subscriber that subscribes to the returned Publisher must not block. It is therefore recommended to offload any blocking or long running operations to a different thread and not use the invoking one. Failure to do so may cause concurrent operations to stall.

Specified by:

publishEntriesByQuery in interface RemoteCache<K,V>

Parameters:

filterQuery - Query

segments - The segments to utilize. If null all segments will be utilized. An empty set will filter out all entries.

batchSize - The number of entries transferred from the server at a time.

Returns:

Publisher containing matching entries

retrieveEntriesWithMetadata

public CloseableIterator<Map.Entry<Object,MetadataValue<Object>>> retrieveEntriesWithMetadata(Set<Integer> segments,
 int batchSize)

Description copied from interface: RemoteCache

Retrieve entries with metadata information

Specified by:

retrieveEntriesWithMetadata in interface RemoteCache<K,V>

publishEntriesWithMetadata

public org.reactivestreams.Publisher<Map.Entry<K,MetadataValue<V>>> publishEntriesWithMetadata(Set<Integer> segments,
 int batchSize)

Description copied from interface: RemoteCache

Publish entries with metadata information

Any subscriber that subscribes to the returned Publisher must not block. It is therefore recommended to offload any blocking or long running operations to a different thread and not use the invoking one. Failure to do so may cause concurrent operations to stall.

Specified by:

publishEntriesWithMetadata in interface RemoteCache<K,V>

Parameters:

segments - The segments to utilize. If null all segments will be utilized. An empty set will filter out all entries.

batchSize - The number of entries transferred from the server at a time.

Returns:

Publisher containing entries along with metadata

removeAsync

public CompletableFuture<V> removeAsync(Object key)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.remove(Object). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

removeAsync in interface AsyncCache<K,V>

Specified by:

removeAsync in class RemoteCacheSupport<K,V>

Parameters:

key - key to remove

Returns:

a future containing the value removed

removeAsync

public CompletableFuture<Boolean> removeAsync(Object key,
 Object value)

Description copied from interface: AsyncCache

Asynchronous version of ConcurrentMap.remove(Object, Object). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

removeAsync in interface AsyncCache<K,V>

Specified by:

removeAsync in class RemoteCacheSupport<K,V>

Parameters:

key - key to remove

value - value to match on

Returns:

a future containing a boolean, indicating whether the entry was removed or not

removeWithVersionAsync

public CompletableFuture<Boolean> removeWithVersionAsync(K key,
 long version)

Specified by:

removeWithVersionAsync in interface RemoteCache<K,V>

Specified by:

removeWithVersionAsync in class RemoteCacheSupport<K,V>

See Also:

• RemoteCache.remove(Object, Object)

mergeAsync

public CompletableFuture<V> mergeAsync(K key,
 V value,
 BiFunction<? super V,? super V,? extends V> remappingFunction,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdleTime,
 TimeUnit maxIdleTimeUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.merge(Object, Object, BiFunction, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

mergeAsync in interface AsyncCache<K,V>

Specified by:

mergeAsync in class RemoteCacheSupport<K,V>

computeAsync

public CompletableFuture<V> computeAsync(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.compute(Object, BiFunction, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

computeAsync in interface AsyncCache<K,V>

Specified by:

computeAsync in class RemoteCacheSupport<K,V>

computeIfAbsentAsync

public CompletableFuture<V> computeIfAbsentAsync(K key,
 Function<? super K,? extends V> mappingFunction,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.computeIfAbsent(Object, Function, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

computeIfAbsentAsync in interface AsyncCache<K,V>

Specified by:

computeIfAbsentAsync in class RemoteCacheSupport<K,V>

computeIfPresentAsync

public CompletableFuture<V> computeIfPresentAsync(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.computeIfPresent(Object, BiFunction, long, TimeUnit, long, TimeUnit) . This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

computeIfPresentAsync in interface AsyncCache<K,V>

Specified by:

computeIfPresentAsync in class RemoteCacheSupport<K,V>

replaceAll

public void replaceAll(BiFunction<? super K,? super V,? extends V> function)

Specified by:

replaceAll in interface ConcurrentMap<K,V>

Specified by:

replaceAll in interface Map<K,V>

Specified by:

replaceAll in class RemoteCacheSupport<K,V>

sizeAsync

public CompletableFuture<Long> sizeAsync()

Description copied from interface: AsyncCache

Asynchronous version of Map.size(). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

sizeAsync in interface AsyncCache<K,V>

Specified by:

sizeAsync in class RemoteCacheSupport<K,V>

Returns:

a future containing the count of the cache

getName

public String getName()

Description copied from interface: BasicCache

Retrieves the name of the cache

Specified by:

getName in interface BasicCache<K,V>

Returns:

the name of the cache

getVersion

public String getVersion()

Description copied from interface: BasicCache

Retrieves the version of Infinispan

Specified by:

getVersion in interface BasicCache<K,V>

Returns:

a version string

start

public void start()

Description copied from interface: Lifecycle

Invoked on component start

Specified by:

start in interface Lifecycle

stop

public void stop()

Description copied from interface: Lifecycle

Invoked on component stop

Specified by:

stop in interface Lifecycle

keyIterator

public CloseableIterator<K> keyIterator(IntSet segments)

Specified by:

keyIterator in interface InternalRemoteCache<K,V>

entryIterator

public CloseableIterator<Map.Entry<K,V>> entryIterator(IntSet segments)

Specified by:

entryIterator in interface InternalRemoteCache<K,V>

hasForceReturnFlag

public boolean hasForceReturnFlag()

Specified by:

hasForceReturnFlag in interface InternalRemoteCache<K,V>

resolveStorage

public void resolveStorage(boolean objectStorage)

Specified by:

resolveStorage in interface InternalRemoteCache<K,V>

keyToBytes

public byte[] keyToBytes(Object o)

Specified by:

keyToBytes in interface InternalRemoteCache<K,V>

init

public void init(org.infinispan.client.hotrod.impl.operations.OperationsFactory operationsFactory,
 Configuration configuration,
 ObjectName jmxParent)

Specified by:

init in interface InternalRemoteCache<K,V>

init

public void init(org.infinispan.client.hotrod.impl.operations.OperationsFactory operationsFactory,
 Configuration configuration)

Specified by:

init in interface InternalRemoteCache<K,V>

getOperationsFactory

public org.infinispan.client.hotrod.impl.operations.OperationsFactory getOperationsFactory()

Specified by:

getOperationsFactory in interface InternalRemoteCache<K,V>

isObjectStorage

public boolean isObjectStorage()

Specified by:

isObjectStorage in interface InternalRemoteCache<K,V>

ping

public CompletionStage<org.infinispan.client.hotrod.impl.operations.PingResponse> ping()

Specified by:

ping in interface InternalRemoteCache<K,V>

updateBloomFilter

public CompletionStage<Void> updateBloomFilter()

Description copied from interface: InternalRemoteCache

Sends the current bloom filter to the listener node where a near cache listener is installed. If this cache does not have near caching this will return an already completed stage.

Specified by:

updateBloomFilter in interface InternalRemoteCache<K,V>

Returns:

stage that when complete the filter was sent to the listener node