Class EncoderCache<K,V>
- java.lang.Object
-
- org.infinispan.cache.impl.AbstractDelegatingCache<K,V>
-
- org.infinispan.cache.impl.AbstractDelegatingAdvancedCache<K,V>
-
- org.infinispan.cache.impl.EncoderCache<K,V>
-
- All Implemented Interfaces:
ConcurrentMap<K,V>
,Map<K,V>
,AdvancedCache<K,V>
,Cache<K,V>
,org.infinispan.commons.api.AsyncCache<K,V>
,org.infinispan.commons.api.BasicCache<K,V>
,org.infinispan.commons.api.BatchingCache
,org.infinispan.commons.api.Lifecycle
,org.infinispan.commons.api.TransactionalCache
,FilteringListenable<K,V>
,Listenable
public class EncoderCache<K,V> extends AbstractDelegatingAdvancedCache<K,V>
Cache decoration that makes use of theEncoder
andWrapper
to convert between storage value and read/write value.- Since:
- 9.1
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.infinispan.cache.impl.AbstractDelegatingAdvancedCache
AbstractDelegatingAdvancedCache.AdvancedCacheWrapper<K,V>
-
-
Field Summary
-
Fields inherited from class org.infinispan.cache.impl.AbstractDelegatingAdvancedCache
cache
-
-
Constructor Summary
Constructors Constructor Description EncoderCache(AdvancedCache<K,V> cache, DataConversion keyDataConversion, DataConversion valueDataConversion)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <C> void
addFilteredListener(Object listener, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter, Set<Class<? extends Annotation>> filterAnnotations)
Registers a listener limiting the cache-entry specific events only to annotations that are passed in as parameter.void
addListener(Object listener)
Adds a listener to the component.void
addListener(Object listener, KeyFilter<? super K> filter)
Adds a listener to the component.<C> void
addListener(Object listener, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter)
Registers a listener that will be notified on events that pass the filter condition.<C> void
addStorageFormatFilteredListener(Object listener, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter, Set<Class<? extends Annotation>> filterAnnotations)
Same asFilteringListenable.addFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)
, but assumes the filter and/or the converter will be done in the same data format as it's stored in the cache.CacheSet<CacheEntry<K,V>>
cacheEntrySet()
Identical toCache.entrySet()
but is typed to return CacheEntries instead of Entries.V
compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
V
compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)
An overloaded form ofConcurrentMap.compute(Object, BiFunction)
which takes in lifespan parameters.V
compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
An overloaded form ofConcurrentMap.compute(Object, BiFunction)
which takes in lifespan and maxIdleTime parameters.V
compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, Metadata metadata)
An overloaded form of#compute(K, BiFunction)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.V
computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
V
computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit)
An overloaded form ofConcurrentMap.computeIfAbsent(Object, Function)
which takes in lifespan parameters.V
computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
An overloaded form ofConcurrentMap.computeIfAbsent(Object, Function)
which takes in lifespan and maxIdleTime parameters.V
computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction, Metadata metadata)
An overloaded form of#computeIfAbsent(K, Function)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.V
computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
V
computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)
An overloaded form ofConcurrentMap.computeIfPresent(Object, BiFunction)
which takes in lifespan parameters.V
computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
An overloaded form ofConcurrentMap.computeIfPresent(Object, BiFunction)
which takes in lifespan and maxIdleTime parameters.V
computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, Metadata metadata)
An overloaded form of#computeIfPresent(K, BiFunction)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.boolean
containsKey(Object key)
boolean
containsValue(Object value)
CacheSet<Map.Entry<K,V>>
entrySet()
Returns a set view of the mappings contained in this cache and cache loader across the entire cluster.void
evict(K key)
Evicts an entry from the memory of the cache.void
forEach(BiConsumer<? super K,? super V> action)
V
get(Object key)
Map<K,V>
getAll(Set<?> keys)
Gets a collection of entries, returning them asMap
of the values associated with the set of keys requested.CompletableFuture<Map<K,V>>
getAllAsync(Set<?> keys)
Map<K,CacheEntry<K,V>>
getAllCacheEntries(Set<?> keys)
Gets a collection of entries from theAdvancedCache
, returning them asMap
of the cache entries associated with the set of keys requested.CompletableFuture<V>
getAsync(K key)
Asynchronous version ofMap.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.CacheEntry<K,V>
getCacheEntry(Object key)
Retrieves a CacheEntry corresponding to a specific key.CompletableFuture<CacheEntry<K,V>>
getCacheEntryAsync(Object key)
Retrieves a CacheEntry corresponding to a specific key.Map<K,V>
getGroup(String groupName)
It fetches all the keys which belong to the group.DataConversion
getKeyDataConversion()
V
getOrDefault(Object key, V defaultValue)
DataConversion
getValueDataConversion()
K
keyFromStorage(Object key)
CacheSet<K>
keySet()
Returns a set view of the keys contained in this cache and cache loader across the entire cluster.K
keyToStorage(Object key)
boolean
lock(Collection<? extends K> keys)
Locks collections of keys eagerly across cache nodes in a cluster.boolean
lock(K... keys)
Locks a given key or keys eagerly across cache nodes in a cluster.V
merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
V
merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)
An overloaded form ofConcurrentMap.merge(Object, Object, BiFunction)
which takes in lifespan parameters.V
merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
An overloaded form ofConcurrentMap.merge(Object, Object, BiFunction)
which takes in lifespan parameters.V
merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, Metadata metadata)
An overloaded form ofCache.merge(Object, Object, BiFunction)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.V
put(K key, V value)
If the return value of this operation will be ignored by the application, the user is strongly encouraged to use theFlag.IGNORE_RETURN_VALUES
flag when invoking this method in order to make it behave as efficiently as possible (i.e.V
put(K key, V value, long lifespan, TimeUnit unit)
An overloaded form ofBasicCache.put(Object, Object)
, which takes in lifespan parameters.V
put(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
An overloaded form ofBasicCache.put(Object, Object)
, which takes in lifespan parameters.V
put(K key, V value, Metadata metadata)
An overloaded form of#put(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.void
putAll(Map<? extends K,? extends V> t)
void
putAll(Map<? extends K,? extends V> map, long lifespan, TimeUnit unit)
An overloaded form ofMap.putAll(Map)
, which takes in lifespan parameters.void
putAll(Map<? extends K,? extends V> map, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
An overloaded form ofMap.putAll(Map)
, which takes in lifespan parameters.void
putAll(Map<? extends K,? extends V> map, Metadata metadata)
An overloaded form ofMap.putAll(Map)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entries being stored, such as lifespan, version of value...etc.CompletableFuture<Void>
putAllAsync(Map<? extends K,? extends V> data)
Asynchronous version ofMap.putAll(Map)
.CompletableFuture<Void>
putAllAsync(Map<? extends K,? extends V> data, long lifespan, TimeUnit unit)
Asynchronous version ofBasicCache.putAll(Map, long, TimeUnit)
.CompletableFuture<Void>
putAllAsync(Map<? extends K,? extends V> data, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
Asynchronous version ofBasicCache.putAll(Map, long, TimeUnit, long, TimeUnit)
.CompletableFuture<Void>
putAllAsync(Map<? extends K,? extends V> map, Metadata metadata)
CompletableFuture<V>
putAsync(K key, V value)
Asynchronous version ofBasicCache.put(Object, Object)
.CompletableFuture<V>
putAsync(K key, V value, long lifespan, TimeUnit unit)
Asynchronous version ofBasicCache.put(Object, Object, long, TimeUnit)
.CompletableFuture<V>
putAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
Asynchronous version ofBasicCache.put(Object, Object, long, TimeUnit, long, TimeUnit)
.CompletableFuture<V>
putAsync(K key, V value, Metadata metadata)
Asynchronous version ofAdvancedCache.put(Object, Object, Metadata)
which stores metadata alongside the value.void
putForExternalRead(K key, V value)
Under special operating behavior, associates the value with the specified key.void
putForExternalRead(K key, V value, long lifespan, TimeUnit unit)
An overloaded form of#putForExternalRead(K, V)
, which takes in lifespan parameters.void
putForExternalRead(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
An overloaded form of#putForExternalRead(K, V)
, which takes in lifespan parameters.void
putForExternalRead(K key, V value, Metadata metadata)
An overloaded form of#putForExternalRead(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.V
putIfAbsent(K key, V value)
V
putIfAbsent(K key, V value, long lifespan, TimeUnit unit)
An overloaded form ofConcurrentMap.putIfAbsent(Object, Object)
, which takes in lifespan parameters.V
putIfAbsent(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
An overloaded form ofConcurrentMap.putIfAbsent(Object, Object)
, which takes in lifespan parameters.V
putIfAbsent(K key, V value, Metadata metadata)
An overloaded form of#putIfAbsent(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.CompletableFuture<V>
putIfAbsentAsync(K key, V value)
Asynchronous version ofConcurrentMap.putIfAbsent(Object, Object)
.CompletableFuture<V>
putIfAbsentAsync(K key, V value, long lifespan, TimeUnit unit)
Asynchronous version ofBasicCache.putIfAbsent(Object, Object, long, TimeUnit)
.CompletableFuture<V>
putIfAbsentAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
Asynchronous version ofBasicCache.putIfAbsent(Object, Object, long, TimeUnit, long, TimeUnit)
.CompletableFuture<V>
putIfAbsentAsync(K key, V value, Metadata metadata)
An overloaded form of#putIfAbsentAsync(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.V
remove(Object key)
If the return value of this operation will be ignored by the application, the user is strongly encouraged to use theFlag.IGNORE_RETURN_VALUES
flag when invoking this method in order to make it behave as efficiently as possible (i.e.boolean
remove(Object key, Object value)
CompletableFuture<V>
removeAsync(Object key)
Asynchronous version ofBasicCache.remove(Object)
.CompletableFuture<Boolean>
removeAsync(Object key, Object value)
Asynchronous version ofConcurrentMap.remove(Object, Object)
.CompletableFuture<Boolean>
removeLifespanExpired(K key, V value, Long lifespan)
Attempts to remove the entry if it is expired.CompletableFuture<Boolean>
removeMaxIdleExpired(K key, V value)
Attempts to remove the entry for the given key, if it has expired due to max idle.V
replace(K key, V value)
V
replace(K key, V value, long lifespan, TimeUnit unit)
An overloaded form ofConcurrentMap.replace(Object, Object)
, which takes in lifespan parameters.V
replace(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
An overloaded form ofConcurrentMap.replace(Object, Object)
, which takes in lifespan parameters.V
replace(K key, V value, Metadata metadata)
An overloaded form of#replace(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.boolean
replace(K key, V oldValue, V newValue)
boolean
replace(K key, V oldValue, V value, long lifespan, TimeUnit unit)
An overloaded form ofConcurrentMap.replace(Object, Object, Object)
, which takes in lifespan parameters.boolean
replace(K key, V oldValue, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
An overloaded form ofConcurrentMap.replace(Object, Object, Object)
, which takes in lifespan parameters.boolean
replace(K key, V oldValue, V value, Metadata metadata)
An overloaded form of#replace(K, V, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.void
replaceAll(BiFunction<? super K,? super V,? extends V> function)
CompletableFuture<V>
replaceAsync(K key, V value)
Asynchronous version ofConcurrentMap.replace(Object, Object)
.CompletableFuture<V>
replaceAsync(K key, V value, long lifespan, TimeUnit unit)
Asynchronous version ofBasicCache.replace(Object, Object, long, TimeUnit)
.CompletableFuture<V>
replaceAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
Asynchronous version ofBasicCache.replace(Object, Object, long, TimeUnit, long, TimeUnit)
.CompletableFuture<V>
replaceAsync(K key, V value, Metadata metadata)
An overloaded form of#replaceAsync(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.CompletableFuture<Boolean>
replaceAsync(K key, V oldValue, V newValue)
Asynchronous version ofConcurrentMap.replace(Object, Object, Object)
.CompletableFuture<Boolean>
replaceAsync(K key, V oldValue, V newValue, long lifespan, TimeUnit unit)
Asynchronous version ofBasicCache.replace(Object, Object, Object, long, TimeUnit)
.CompletableFuture<Boolean>
replaceAsync(K key, V oldValue, V newValue, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
Asynchronous version ofBasicCache.replace(Object, Object, Object, long, TimeUnit, long, TimeUnit)
.CompletableFuture<Boolean>
replaceAsync(K key, V oldValue, V newValue, Metadata metadata)
protected void
set(K key, V value)
Don't remove.V
valueFromStorage(Object value)
CacheCollection<V>
values()
Returns a collection view of the values contained in this cache across the entire cluster.V
valueToStorage(Object value)
void
wireRealCache()
AdvancedCache<K,V>
withEncoding(Class<? extends org.infinispan.commons.dataconversion.Encoder> encoderClass)
Performs any cache operations using the specifiedEncoder
.AdvancedCache<K,V>
withEncoding(Class<? extends org.infinispan.commons.dataconversion.Encoder> keyEncoderClass, Class<? extends org.infinispan.commons.dataconversion.Encoder> valueEncoderClass)
Performs any cache operations using the specified pair ofEncoder
.AdvancedCache<K,V>
withKeyEncoding(Class<? extends org.infinispan.commons.dataconversion.Encoder> encoderClass)
AdvancedCache<K,V>
withMediaType(String keyMediaType, String valueMediaType)
Perform any cache operations using an alternateMediaType
.AdvancedCache<K,V>
withWrapping(Class<? extends org.infinispan.commons.dataconversion.Wrapper> wrapper)
Performs any cache operations using the specifiedWrapper
.AdvancedCache<K,V>
withWrapping(Class<? extends org.infinispan.commons.dataconversion.Wrapper> keyWrapperClass, Class<? extends org.infinispan.commons.dataconversion.Wrapper> valueWrapperClass)
Performs any cache operations using the specified pair ofWrapper
.-
Methods inherited from class org.infinispan.cache.impl.AbstractDelegatingAdvancedCache
addInterceptor, addInterceptorAfter, addInterceptorBefore, applyDelta, computeAsync, computeAsync, computeAsync, computeAsync, computeIfAbsentAsync, computeIfAbsentAsync, computeIfAbsentAsync, computeIfAbsentAsync, computeIfPresentAsync, computeIfPresentAsync, computeIfPresentAsync, computeIfPresentAsync, getAdvancedCache, getAndPutAll, getAsyncInterceptorChain, getAuthorizationManager, getAvailability, getBatchContainer, getCacheAvailability, getClassLoader, getComponentRegistry, getDataContainer, getDistributionManager, getEvictionManager, getExpirationManager, getInterceptorChain, getInvocationContextContainer, getKeyEncoder, getKeyWrapper, getLockManager, getRpcManager, getStats, getTransactionManager, getValueEncoder, getValueWrapper, getXAResource, isRebalancingEnabled, lockAs, lockedStream, mergeAsync, mergeAsync, mergeAsync, mergeAsync, noFlags, putForExternalRead, putForExternalRead, removeGroup, removeInterceptor, removeInterceptor, setAvailability, setCacheAvailability, setRebalancingEnabled, transform, with, withFlags, withFlags, withSubject
-
Methods inherited from class org.infinispan.cache.impl.AbstractDelegatingCache
clear, clearAsync, endBatch, getCacheConfiguration, getCacheManager, getCacheName, getCacheStatus, getConfigurationAsProperties, getDelegate, getListeners, getName, getStatus, getVersion, isEmpty, removeListener, shutdown, size, start, startBatch, stop, toString, unwrapCache
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.infinispan.AdvancedCache
compute, computeAsync, computeIfAbsent, computeIfAbsentAsync, computeIfPresent, computeIfPresentAsync, merge, mergeAsync
-
Methods inherited from interface org.infinispan.Cache
clear, compute, computeIfAbsent, computeIfAbsent, computeIfAbsent, computeIfPresent, getCacheConfiguration, getCacheManager, getStatus, merge, shutdown, size, stop
-
Methods inherited from interface org.infinispan.notifications.Listenable
getListeners, removeListener
-
-
-
-
Constructor Detail
-
EncoderCache
public EncoderCache(AdvancedCache<K,V> cache, DataConversion keyDataConversion, DataConversion valueDataConversion)
-
-
Method Detail
-
wireRealCache
public void wireRealCache()
-
putForExternalRead
public void putForExternalRead(K key, V value)
Description copied from interface:Cache
Under special operating behavior, associates the value with the specified key.- Only goes through if the
key specified does not exist; no-op otherwise (similar to
ConcurrentMap.putIfAbsent(Object, Object)
) - Force asynchronous mode for replication to prevent any blocking.
- invalidation does not take place.
- 0ms lock timeout to prevent any blocking here either. If the lock is not acquired, this method is a no-op, and swallows the timeout exception.
- Ongoing transactions are suspended before this call, so failures here will not affect any ongoing transactions.
- Errors and exceptions are 'silent' - logged at a much lower level than normal, and this method does not throw exceptions
- Specified by:
putForExternalRead
in interfaceCache<K,V>
- Overrides:
putForExternalRead
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.
- Only goes through if the
key specified does not exist; no-op otherwise (similar to
-
putForExternalRead
public void putForExternalRead(K key, V value, long lifespan, TimeUnit unit)
Description copied from interface:Cache
An overloaded form of#putForExternalRead(K, V)
, which takes in lifespan parameters.- Specified by:
putForExternalRead
in interfaceCache<K,V>
- Overrides:
putForExternalRead
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value to storelifespan
- lifespan of the entry. Negative values are interpreted as unlimited lifespan.unit
- unit of measurement for the lifespan
-
putForExternalRead
public void putForExternalRead(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
Description copied from interface:Cache
An overloaded form of#putForExternalRead(K, V)
, which takes in lifespan parameters.- Specified by:
putForExternalRead
in interfaceCache<K,V>
- Overrides:
putForExternalRead
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value to storelifespan
- lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit
- 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 time
-
evict
public void evict(K key)
Description copied from interface:Cache
Evicts an entry from the memory of the cache. Note that the entry is not removed from any configured cache stores or any other caches in the cluster (if used in a clustered mode). UseBasicCache.remove(Object)
to remove an entry from the entire cache system. This method is designed to evict an entry from memory to free up memory used by the application. This method uses a 0 lock acquisition timeout so it does not block in attempting to acquire locks. It behaves as a no-op if the lock on the entry cannot be acquired immediately. Important: this method should not be called from within a transaction scope.
-
put
public V put(K key, V value, long lifespan, TimeUnit unit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofBasicCache.put(Object, Object)
, which takes in lifespan parameters.- Specified by:
put
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
put
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value to storelifespan
- lifespan of the entry. Negative values are interpreted as unlimited lifespan.unit
- unit of measurement for the lifespan- Returns:
- the value being replaced, or null if nothing is being replaced.
-
getKeyDataConversion
public DataConversion getKeyDataConversion()
- Specified by:
getKeyDataConversion
in interfaceAdvancedCache<K,V>
- Overrides:
getKeyDataConversion
in classAbstractDelegatingAdvancedCache<K,V>
- Returns:
- The associated
DataConversion
for the keys.
-
getValueDataConversion
public DataConversion getValueDataConversion()
- Specified by:
getValueDataConversion
in interfaceAdvancedCache<K,V>
- Overrides:
getValueDataConversion
in classAbstractDelegatingAdvancedCache<K,V>
- Returns:
- The associated
DataConversion
for the cache's values.
-
set
protected void set(K key, V value)
Description copied from class:AbstractDelegatingCache
Don't remove.- Overrides:
set
in classAbstractDelegatingCache<K,V>
-
putIfAbsent
public V putIfAbsent(K key, V value, long lifespan, TimeUnit unit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.putIfAbsent(Object, Object)
, which takes in lifespan parameters.- Specified by:
putIfAbsent
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
putIfAbsent
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value to storelifespan
- lifespan of the entry. Negative values are interpreted as unlimited lifespan.unit
- unit of measurement for the lifespan- Returns:
- the value being replaced, or null if nothing is being replaced.
-
putAll
public void putAll(Map<? extends K,? extends V> map, long lifespan, TimeUnit unit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofMap.putAll(Map)
, which takes in lifespan parameters. Note that the lifespan is applied to all mappings in the map passed in.- Specified by:
putAll
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
putAll
in classAbstractDelegatingCache<K,V>
- Parameters:
map
- map containing mappings to enterlifespan
- lifespan of the entry. Negative values are interpreted as unlimited lifespan.unit
- unit of measurement for the lifespan
-
replace
public V replace(K key, V value, long lifespan, TimeUnit unit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.replace(Object, Object)
, which takes in lifespan parameters.- Specified by:
replace
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
replace
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value to storelifespan
- lifespan of the entry. Negative values are interpreted as unlimited lifespan.unit
- unit of measurement for the lifespan- Returns:
- the value being replaced, or null if nothing is being replaced.
-
replace
public boolean replace(K key, V oldValue, V value, long lifespan, TimeUnit unit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.replace(Object, Object, Object)
, which takes in lifespan parameters.- Specified by:
replace
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
replace
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to useoldValue
- value to replacevalue
- value to storelifespan
- lifespan of the entry. Negative values are interpreted as unlimited lifespan.unit
- unit of measurement for the lifespan- Returns:
- true if the value was replaced, false otherwise
-
put
public V put(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofBasicCache.put(Object, Object)
, which takes in lifespan parameters.- Specified by:
put
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
put
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value to storelifespan
- 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 time- Returns:
- the value being replaced, or null if nothing is being replaced.
-
putIfAbsent
public V putIfAbsent(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.putIfAbsent(Object, Object)
, which takes in lifespan parameters.- Specified by:
putIfAbsent
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
putIfAbsent
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value to storelifespan
- 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 time- Returns:
- the value being replaced, or null if nothing is being replaced.
-
putAll
public void putAll(Map<? extends K,? extends V> map, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofMap.putAll(Map)
, which takes in lifespan parameters. Note that the lifespan is applied to all mappings in the map passed in.- Specified by:
putAll
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
putAll
in classAbstractDelegatingCache<K,V>
- Parameters:
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 time
-
replace
public V replace(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.replace(Object, Object)
, which takes in lifespan parameters.- Specified by:
replace
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
replace
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value to storelifespan
- 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 time- Returns:
- the value being replaced, or null if nothing is being replaced.
-
replace
public boolean replace(K key, V oldValue, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.replace(Object, Object, Object)
, which takes in lifespan parameters.- Specified by:
replace
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
replace
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to useoldValue
- value to replacevalue
- value to storelifespan
- 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 time- Returns:
- true if the value was replaced, false otherwise
-
replaceAll
public void replaceAll(BiFunction<? super K,? super V,? extends V> function)
- Specified by:
replaceAll
in interfaceConcurrentMap<K,V>
- Specified by:
replaceAll
in interfaceMap<K,V>
- Overrides:
replaceAll
in classAbstractDelegatingCache<K,V>
-
putAsync
public CompletableFuture<V> putAsync(K key, V value)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.put(Object, Object)
. This method does not block on remote calls, even if your cache mode is synchronous.
-
putAsync
public CompletableFuture<V> putAsync(K key, V value, long lifespan, TimeUnit unit)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.put(Object, Object, long, TimeUnit)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
putAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value to storelifespan
- lifespan of entryunit
- time unit for lifespan- Returns:
- a future containing the old value replaced
-
putAsync
public CompletableFuture<V> putAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.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 interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
putAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value 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 time- Returns:
- a future containing the old value replaced
-
putAllAsync
public CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> data)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofMap.putAll(Map)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putAllAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
putAllAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
data
- to store- Returns:
- a future containing a void return type
-
putAllAsync
public CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> data, long lifespan, TimeUnit unit)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.putAll(Map, long, TimeUnit)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putAllAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
putAllAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
data
- to storelifespan
- lifespan of entryunit
- time unit for lifespan- Returns:
- a future containing a void return type
-
putAllAsync
public CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> data, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.putAll(Map, long, TimeUnit, long, TimeUnit)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putAllAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
putAllAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
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 time- Returns:
- a future containing a void return type
-
putAllAsync
public CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> map, Metadata metadata)
- Specified by:
putAllAsync
in interfaceAdvancedCache<K,V>
- Overrides:
putAllAsync
in classAbstractDelegatingAdvancedCache<K,V>
-
putIfAbsentAsync
public CompletableFuture<V> putIfAbsentAsync(K key, V value)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofConcurrentMap.putIfAbsent(Object, Object)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putIfAbsentAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
putIfAbsentAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value to store- Returns:
- a future containing the old value replaced.
-
putIfAbsentAsync
public CompletableFuture<V> putIfAbsentAsync(K key, V value, long lifespan, TimeUnit unit)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.putIfAbsent(Object, Object, long, TimeUnit)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putIfAbsentAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
putIfAbsentAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value to storelifespan
- lifespan of entryunit
- time unit for lifespan- Returns:
- a future containing the old value replaced
-
lock
public boolean lock(K... keys)
Description copied from interface:AdvancedCache
Locks a given key or keys eagerly across cache nodes in a cluster.Keys can be locked eagerly in the context of a transaction only.
- Specified by:
lock
in interfaceAdvancedCache<K,V>
- Overrides:
lock
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
keys
- the keys to lock- Returns:
- true if the lock acquisition attempt was successful for all keys; false will only be returned if
the lock acquisition timed out and the operation has been called with
Flag.FAIL_SILENTLY
.
-
lock
public boolean lock(Collection<? extends K> keys)
Description copied from interface:AdvancedCache
Locks collections of keys eagerly across cache nodes in a cluster.Collections of keys can be locked eagerly in the context of a transaction only.
- Specified by:
lock
in interfaceAdvancedCache<K,V>
- Overrides:
lock
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
keys
- collection of keys to lock- Returns:
- true if the lock acquisition attempt was successful for all keys; false will only be returned if
the lock acquisition timed out and the operation has been called with
Flag.FAIL_SILENTLY
.
-
putIfAbsentAsync
public CompletableFuture<V> putIfAbsentAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.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 interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
putIfAbsentAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- value 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 time- Returns:
- a future containing the old value replaced
-
putIfAbsentAsync
public CompletableFuture<V> putIfAbsentAsync(K key, V value, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form of#putIfAbsentAsync(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadata
is only stored if the call is successful.- Specified by:
putIfAbsentAsync
in interfaceAdvancedCache<K,V>
- Overrides:
putIfAbsentAsync
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified keymetadata
- information to store alongside the new value- Returns:
- A future containing the previous value associated with the specified key, or null if there was no mapping for the key.
-
removeAsync
public CompletableFuture<V> removeAsync(Object key)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.remove(Object)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
removeAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
removeAsync
in classAbstractDelegatingCache<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:org.infinispan.commons.api.AsyncCache
Asynchronous version ofConcurrentMap.remove(Object, Object)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
removeAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
removeAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to removevalue
- value to match on- Returns:
- a future containing a boolean, indicating whether the entry was removed or not
-
replaceAsync
public CompletableFuture<V> replaceAsync(K key, V value)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofConcurrentMap.replace(Object, Object)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
replaceAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
replaceAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to removevalue
- value to store- Returns:
- a future containing the previous value overwritten
-
replaceAsync
public CompletableFuture<V> replaceAsync(K key, V value, long lifespan, TimeUnit unit)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.replace(Object, Object, long, TimeUnit)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
replaceAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
replaceAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to removevalue
- value to storelifespan
- lifespan of entryunit
- time unit for lifespan- Returns:
- a future containing the previous value overwritten
-
replaceAsync
public CompletableFuture<V> replaceAsync(K key, V value, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form of#replaceAsync(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadata
is only stored if the call is successful.- Specified by:
replaceAsync
in interfaceAdvancedCache<K,V>
- Overrides:
replaceAsync
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- key with which the specified value is associatedvalue
- value to be associated with the specified keymetadata
- information to store alongside the new value- Returns:
- the future that contains previous value associated with the specified key, or null if there was no mapping for the key.
-
getAll
public Map<K,V> getAll(Set<?> keys)
Description copied from interface:AdvancedCache
Gets a collection of entries, returning them asMap
of the values associated with the set of keys requested.If the cache is configured read-through, and a get for a key would return null because an entry is missing from the cache, the Cache's
CacheLoader
is called in an attempt to load the entry. If an entry cannot be loaded for a given key, the returned Map will contain null for value of the key.Unlike other bulk methods if this invoked in an existing transaction all entries will be stored in the current transactional context
The returned
Map
will be a copy and updates to the map will not be reflected in the Cache and vice versa. The keys and values themselves however may not be copies depending on if storeAsBinary is enabled and the value was retrieved from the local node.- Specified by:
getAll
in interfaceAdvancedCache<K,V>
- Overrides:
getAll
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
keys
- The keys whose associated values are to be returned.- Returns:
- A map of entries that were found for the given keys. If an entry is not found for a given key, it will not be in the returned map.
-
getAllAsync
public CompletableFuture<Map<K,V>> getAllAsync(Set<?> keys)
- Specified by:
getAllAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
getAllAsync
in classAbstractDelegatingAdvancedCache<K,V>
-
getCacheEntry
public CacheEntry<K,V> getCacheEntry(Object key)
Description copied from interface:AdvancedCache
Retrieves a CacheEntry corresponding to a specific key.- Specified by:
getCacheEntry
in interfaceAdvancedCache<K,V>
- Overrides:
getCacheEntry
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- the key whose associated cache entry is to be returned- Returns:
- the cache entry to which the specified key is mapped, or
null
if this map contains no mapping for the key
-
getCacheEntryAsync
public CompletableFuture<CacheEntry<K,V>> getCacheEntryAsync(Object key)
Description copied from interface:AdvancedCache
Retrieves a CacheEntry corresponding to a specific key.- Specified by:
getCacheEntryAsync
in interfaceAdvancedCache<K,V>
- Overrides:
getCacheEntryAsync
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- the key whose associated cache entry is to be returned- Returns:
- a future with the cache entry to which the specified key is mapped, or with
null
if this map contains no mapping for the key
-
replaceAsync
public CompletableFuture<V> replaceAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.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 interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
replaceAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to removevalue
- value 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 time- Returns:
- a future containing the previous value overwritten
-
getAllCacheEntries
public Map<K,CacheEntry<K,V>> getAllCacheEntries(Set<?> keys)
Description copied from interface:AdvancedCache
Gets a collection of entries from theAdvancedCache
, returning them asMap
of the cache entries associated with the set of keys requested.If the cache is configured read-through, and a get for a key would return null because an entry is missing from the cache, the Cache's
CacheLoader
is called in an attempt to load the entry. If an entry cannot be loaded for a given key, the returned Map will contain null for value of the key.Unlike other bulk methods if this invoked in an existing transaction all entries will be stored in the current transactional context
The returned
Map
will be a copy and updates to the map will not be reflected in the Cache and vice versa. The keys and values themselves however may not be copies depending on if storeAsBinary is enabled and the value was retrieved from the local node.- Specified by:
getAllCacheEntries
in interfaceAdvancedCache<K,V>
- Overrides:
getAllCacheEntries
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
keys
- The keys whose associated values are to be returned.- Returns:
- A map of entries that were found for the given keys. Keys not found in the cache are present in the map with null values.
-
getGroup
public Map<K,V> getGroup(String groupName)
Description copied from interface:AdvancedCache
It fetches all the keys which belong to the group. Semantically, it iterates over all the keys in memory and persistence, and performs a read operation in the keys found. Multiple invocations inside a transaction ensures that all the keys previous read are returned and it may return newly added keys to the group from other committed transactions (also known as phantom reads). Themap
returned is immutable and represents the group at the time of the invocation. If you want to add or remove keys from a group useBasicCache.put(Object, Object)
andBasicCache.remove(Object)
. To remove all the keys in the group useAdvancedCache.removeGroup(String)
. To improve performance you may use theflag
Flag.SKIP_CACHE_LOAD
to avoid fetching the key/value from persistence. However, you will get an inconsistent snapshot of the group.- Specified by:
getGroup
in interfaceAdvancedCache<K,V>
- Overrides:
getGroup
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
groupName
- the group name.- Returns:
- an immutable
Map
with the key/value pairs.
-
replaceAsync
public CompletableFuture<Boolean> replaceAsync(K key, V oldValue, V newValue)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofConcurrentMap.replace(Object, Object, Object)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
replaceAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
replaceAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to removeoldValue
- value to overwritenewValue
- value to store- Returns:
- a future containing a boolean, indicating whether the entry was replaced or not
-
replaceAsync
public CompletableFuture<Boolean> replaceAsync(K key, V oldValue, V newValue, long lifespan, TimeUnit unit)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.replace(Object, Object, Object, long, TimeUnit)
. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
replaceAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
replaceAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to removeoldValue
- value to overwritenewValue
- value to storelifespan
- lifespan of entryunit
- time unit for lifespan- Returns:
- a future containing a boolean, indicating whether the entry was replaced or not
-
put
public V put(K key, V value, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form of#put(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.- Specified by:
put
in interfaceAdvancedCache<K,V>
- Overrides:
put
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- key to usevalue
- value to storemetadata
- information to store alongside the value- Returns:
- the previous value associated with key, or null if there was no mapping for key.
-
replace
public V replace(K key, V value, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form of#replace(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadata
is only stored if the call is successful.- Specified by:
replace
in interfaceAdvancedCache<K,V>
- Overrides:
replace
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- key with which the specified value is associatedvalue
- value to be associated with the specified keymetadata
- information to store alongside the new value- Returns:
- the previous value associated with the specified key, or null if there was no mapping for the key.
-
replaceAsync
public CompletableFuture<Boolean> replaceAsync(K key, V oldValue, V newValue, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofBasicCache.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 interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
replaceAsync
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to removeoldValue
- value to overwritenewValue
- value 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 time- Returns:
- a future containing a boolean, indicating whether the entry was replaced or not
-
replace
public boolean replace(K key, V oldValue, V value, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form of#replace(K, V, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadata
is only stored if the call is successful.- Specified by:
replace
in interfaceAdvancedCache<K,V>
- Overrides:
replace
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- key with which the specified value is associatedoldValue
- value expected to be associated with the specified keyvalue
- value to be associated with the specified keymetadata
- information to store alongside the new value- Returns:
- true if the value was replaced
-
replaceAsync
public CompletableFuture<Boolean> replaceAsync(K key, V oldValue, V newValue, Metadata metadata)
- Specified by:
replaceAsync
in interfaceAdvancedCache<K,V>
- Overrides:
replaceAsync
in classAbstractDelegatingAdvancedCache<K,V>
-
putIfAbsent
public V putIfAbsent(K key, V value, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form of#putIfAbsent(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadata
is only stored if the call is successful.- Specified by:
putIfAbsent
in interfaceAdvancedCache<K,V>
- Overrides:
putIfAbsent
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified keymetadata
- information to store alongside the new value- Returns:
- the previous value associated with the specified key, or null if there was no mapping for the key.
-
putAsync
public CompletableFuture<V> putAsync(K key, V value, Metadata metadata)
Description copied from interface:AdvancedCache
Asynchronous version ofAdvancedCache.put(Object, Object, Metadata)
which stores metadata alongside the value. This method does not block on remote calls, even if your cache mode is synchronous. Has no benefit overAdvancedCache.put(Object, Object, Metadata)
if used in LOCAL mode.- Specified by:
putAsync
in interfaceAdvancedCache<K,V>
- Overrides:
putAsync
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- key to usevalue
- value to storemetadata
- information to store alongside the new value- Returns:
- a future containing the old value replaced.
-
putForExternalRead
public void putForExternalRead(K key, V value, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form of#putForExternalRead(K, V)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadata
is only stored if the call is successful.- Specified by:
putForExternalRead
in interfaceAdvancedCache<K,V>
- Overrides:
putForExternalRead
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified keymetadata
- information to store alongside the new value
-
putAll
public void putAll(Map<? extends K,? extends V> map, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form ofMap.putAll(Map)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entries being stored, such as lifespan, version of value...etc.- Specified by:
putAll
in interfaceAdvancedCache<K,V>
- Overrides:
putAll
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
map
- the values to storemetadata
- information to store alongside the value(s)
-
cacheEntrySet
public CacheSet<CacheEntry<K,V>> cacheEntrySet()
Description copied from interface:AdvancedCache
Identical toCache.entrySet()
but is typed to return CacheEntries instead of Entries. Please see the other method for a description of its behaviors.This method is needed since nested generics do not support covariance
- Specified by:
cacheEntrySet
in interfaceAdvancedCache<K,V>
- Overrides:
cacheEntrySet
in classAbstractDelegatingAdvancedCache<K,V>
- Returns:
- the entry set containing all of the CacheEntries
- See Also:
Cache.entrySet()
-
removeLifespanExpired
public CompletableFuture<Boolean> removeLifespanExpired(K key, V value, Long lifespan)
Description copied from interface:AdvancedCache
Attempts to remove the entry if it is expired. Due to expired entries not being consistent across nodes, this will still attempt to remove the value if it is not present. Note that this will raise an expired event even if the entry is not present. Normally this method should never be invoked except by theExpirationManager
.This command will only remove the value if the value and lifespan also match if provided.
This method will suspend any ongoing transaction and start a new one just for the invocation of this command. It is automatically committed or rolled back after the command completes, either successfully or via an exception.
NOTE: This method may be removed at any point including in a minor release and is not supported for external usage.
- Specified by:
removeLifespanExpired
in interfaceAdvancedCache<K,V>
- Overrides:
removeLifespanExpired
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- the key that is expiringvalue
- the value that mapped to the given. Null means it will match any valuelifespan
- the lifespan that should match. If null is provided it will match any lifespan value- Returns:
- if the entry was removed
-
removeMaxIdleExpired
public CompletableFuture<Boolean> removeMaxIdleExpired(K key, V value)
Description copied from interface:AdvancedCache
Attempts to remove the entry for the given key, if it has expired due to max idle. This command first locks the key and then verifies that the entry has expired via maxIdle across all nodes. If it has this will then remove the given key.This method returns a boolean when it has determined if the entry has expired. This is useful for when a backup node invokes this command for a get that found the entry expired. This way the node can return back to the caller much faster when the entry is not expired and do any additional processing asynchronously if needed.
This method will suspend any ongoing transaction and start a new one just for the invocation of this command. It is automatically committed or rolled back after the command completes, either successfully or via an exception.
NOTE: This method may be removed at any point including in a minor release and is not supported for external usage.
- Specified by:
removeMaxIdleExpired
in interfaceAdvancedCache<K,V>
- Overrides:
removeMaxIdleExpired
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- the key that expired via max idle for the given entry- Returns:
- if the entry was removed
-
putIfAbsent
public V putIfAbsent(K key, V value)
- Specified by:
putIfAbsent
in interfaceConcurrentMap<K,V>
- Specified by:
putIfAbsent
in interfaceMap<K,V>
- Overrides:
putIfAbsent
in classAbstractDelegatingCache<K,V>
-
withEncoding
public AdvancedCache<K,V> withEncoding(Class<? extends org.infinispan.commons.dataconversion.Encoder> keyEncoderClass, Class<? extends org.infinispan.commons.dataconversion.Encoder> valueEncoderClass)
Description copied from interface:AdvancedCache
Performs any cache operations using the specified pair ofEncoder
.- Specified by:
withEncoding
in interfaceAdvancedCache<K,V>
- Overrides:
withEncoding
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
keyEncoderClass
-Encoder
for the keys.valueEncoderClass
-Encoder
for the values.- Returns:
- an instance of
AdvancedCache
where all operations will use the supplied encoders.
-
withEncoding
public AdvancedCache<K,V> withEncoding(Class<? extends org.infinispan.commons.dataconversion.Encoder> encoderClass)
Description copied from interface:AdvancedCache
Performs any cache operations using the specifiedEncoder
.- Specified by:
withEncoding
in interfaceAdvancedCache<K,V>
- Overrides:
withEncoding
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
encoderClass
-Encoder
used for both keys and values.- Returns:
- an instance of
AdvancedCache
where all operations will use the supplied encoder.
-
withKeyEncoding
public AdvancedCache<K,V> withKeyEncoding(Class<? extends org.infinispan.commons.dataconversion.Encoder> encoderClass)
- Specified by:
withKeyEncoding
in interfaceAdvancedCache<K,V>
- Overrides:
withKeyEncoding
in classAbstractDelegatingAdvancedCache<K,V>
-
withWrapping
public AdvancedCache<K,V> withWrapping(Class<? extends org.infinispan.commons.dataconversion.Wrapper> keyWrapperClass, Class<? extends org.infinispan.commons.dataconversion.Wrapper> valueWrapperClass)
Description copied from interface:AdvancedCache
Performs any cache operations using the specified pair ofWrapper
.- Specified by:
withWrapping
in interfaceAdvancedCache<K,V>
- Overrides:
withWrapping
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
keyWrapperClass
-Wrapper
for the keys.valueWrapperClass
-Wrapper
for the values.- Returns:
AdvancedCache
where all operations will use the supplied wrappers.
-
withWrapping
public AdvancedCache<K,V> withWrapping(Class<? extends org.infinispan.commons.dataconversion.Wrapper> wrapper)
Description copied from interface:AdvancedCache
Performs any cache operations using the specifiedWrapper
.- Specified by:
withWrapping
in interfaceAdvancedCache<K,V>
- Overrides:
withWrapping
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
wrapper
-Wrapper
for the keys and values.- Returns:
- an instance of
AdvancedCache
where all operations will use the supplied wrapper.
-
withMediaType
public AdvancedCache<K,V> withMediaType(String keyMediaType, String valueMediaType)
Description copied from interface:AdvancedCache
Perform any cache operations using an alternateMediaType
.- Specified by:
withMediaType
in interfaceAdvancedCache<K,V>
- Overrides:
withMediaType
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
keyMediaType
-MediaType
for the keys.valueMediaType
-org.infinispan.commons.dataconversion
for the values.- Returns:
- an instance of
AdvancedCache
where all data will formatted according to the suppliedMediaType
.
-
containsKey
public boolean containsKey(Object key)
- Specified by:
containsKey
in interfaceMap<K,V>
- Overrides:
containsKey
in classAbstractDelegatingCache<K,V>
-
containsValue
public boolean containsValue(Object value)
- Specified by:
containsValue
in interfaceMap<K,V>
- Overrides:
containsValue
in classAbstractDelegatingCache<K,V>
-
compute
public V compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
Description copied from interface:Cache
When this method is used on a clustered cache, either replicated or distributed, the bifunction will be serialized to owning nodes to perform the operation in the most performant way. However this means the bifunction must have an appropriate
Externalizer
or beSerializable
itself.For transactional caches, whenever the values of the caches are collections, and the mapping function modifies the collection, the collection must be copied and not directly modified, otherwise whenever rollback is called it won't work. This limitation could disappear in following releases if technically possible.
-
compute
public V compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form of#compute(K, BiFunction)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.- Specified by:
compute
in interfaceAdvancedCache<K,V>
- Overrides:
compute
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- key with which the specified value is associatedremappingFunction
- function to be applied to the specified key/valuemetadata
- information to store alongside the new value- Returns:
- the previous value associated with the specified key, or null if remapping function is gives null.
-
compute
public V compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.compute(Object, BiFunction)
which takes in lifespan parameters.- Specified by:
compute
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
compute
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to useremappingFunction
- function to use to compute and store the value under keylifespan
- lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit
- time unit for lifespan- Returns:
- the computed value that was stored under key
-
compute
public V compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.compute(Object, BiFunction)
which takes in lifespan and maxIdleTime parameters.- Specified by:
compute
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
compute
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to useremappingFunction
- function to use to compute and store the value under keylifespan
- 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 time- Returns:
- the computed value that was stored under key
-
computeIfPresent
public V computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
Description copied from interface:Cache
When this method is used on a clustered cache, either replicated or distributed, the bifunction will be serialized to owning nodes to perform the operation in the most performant way. However this means the bifunction must have an appropriate
Externalizer
or beSerializable
itself.For transactional caches, whenever the values of the caches are collections, and the mapping function modifies the collection, the collection must be copied and not directly modified, otherwise whenever rollback is called it won't work. This limitation could disappear in following releases if technically possible.
- Specified by:
computeIfPresent
in interfaceCache<K,V>
- Specified by:
computeIfPresent
in interfaceConcurrentMap<K,V>
- Specified by:
computeIfPresent
in interfaceMap<K,V>
- Overrides:
computeIfPresent
in classAbstractDelegatingCache<K,V>
-
computeIfPresent
public V computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form of#computeIfPresent(K, BiFunction)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadata
is only stored if the call is successful.- Specified by:
computeIfPresent
in interfaceAdvancedCache<K,V>
- Overrides:
computeIfPresent
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- key with which the specified value is associatedremappingFunction
- function to be applied to the specified key/valuemetadata
- information to store alongside the new value- Returns:
- the previous value associated with the specified key, or null if there was no mapping for the key.
-
computeIfPresent
public V computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.computeIfPresent(Object, BiFunction)
which takes in lifespan parameters.- Specified by:
computeIfPresent
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
computeIfPresent
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to useremappingFunction
- function to use to compute and store the value under key, if such existslifespan
- lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit
- time unit for lifespan- Returns:
- the computed value that was stored under key
-
computeIfPresent
public V computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.computeIfPresent(Object, BiFunction)
which takes in lifespan and maxIdleTime parameters.- Specified by:
computeIfPresent
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
computeIfPresent
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to useremappingFunction
- function to use to compute and store the value under key, if such existslifespan
- 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 time- Returns:
- the computed value that was stored under key
-
computeIfAbsent
public V computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
Description copied from interface:Cache
When this method is used on a clustered cache, either replicated or distributed, the function will be serialized to owning nodes to perform the operation in the most performant way. However this means the function must have an appropriate
Externalizer
or beSerializable
itself.For transactional caches, whenever the values of the caches are collections, and the mapping function modifies the collection, the collection must be copied and not directly modified, otherwise whenever rollback is called it won't work. This limitation could disappear in following releases if technically possible.
- Specified by:
computeIfAbsent
in interfaceCache<K,V>
- Specified by:
computeIfAbsent
in interfaceConcurrentMap<K,V>
- Specified by:
computeIfAbsent
in interfaceMap<K,V>
- Overrides:
computeIfAbsent
in classAbstractDelegatingCache<K,V>
-
computeIfAbsent
public V computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form of#computeIfAbsent(K, Function)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadata
is only stored if the call is successful.- Specified by:
computeIfAbsent
in interfaceAdvancedCache<K,V>
- Overrides:
computeIfAbsent
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- key with which the specified value is associatedmappingFunction
- function to be applied to the specified keymetadata
- information to store alongside the new value- Returns:
- the value created with the mapping function associated with the specified key, or the previous value associated with the specified key if the key is not absent.
-
computeIfAbsent
public V computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.computeIfAbsent(Object, Function)
which takes in lifespan parameters.- Specified by:
computeIfAbsent
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
computeIfAbsent
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usemappingFunction
- function to use to compute and store the value under key, if the key is absentlifespan
- lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit
- time unit for lifespan- Returns:
- the computed value that was stored under key
-
computeIfAbsent
public V computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.computeIfAbsent(Object, Function)
which takes in lifespan and maxIdleTime parameters.- Specified by:
computeIfAbsent
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
computeIfAbsent
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usemappingFunction
- function to use to compute and store the value under key, if the key is absentlifespan
- 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 time- Returns:
- the computed value that was stored under key
-
getOrDefault
public V getOrDefault(Object key, V defaultValue)
- Specified by:
getOrDefault
in interfaceConcurrentMap<K,V>
- Specified by:
getOrDefault
in interfaceMap<K,V>
- Overrides:
getOrDefault
in classAbstractDelegatingCache<K,V>
-
put
public V put(K key, V value)
Description copied from interface:org.infinispan.commons.api.BasicCache
If the return value of this operation will be ignored by the application, the user is strongly encouraged to use theFlag.IGNORE_RETURN_VALUES
flag when invoking this method in order to make it behave as efficiently as possible (i.e. avoiding needless remote or network calls).
-
remove
public V remove(Object key)
Description copied from interface:org.infinispan.commons.api.BasicCache
If the return value of this operation will be ignored by the application, the user is strongly encouraged to use theFlag.IGNORE_RETURN_VALUES
flag when invoking this method in order to make it behave as efficiently as possible (i.e. avoiding needless remote or network calls).
-
merge
public V merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
Description copied from interface:Cache
When this method is used on a clustered cache, either replicated or distributed, the bifunction will be serialized to owning nodes to perform the operation in the most performant way. However this means the bifunction must have an appropriate
Externalizer
or beSerializable
itself.For transactional caches, whenever the values of the caches are collections, and the mapping function modifies the collection, the collection must be copied and not directly modified, otherwise whenever rollback is called it won't work. This limitation could disappear in following releases if technically possible.
-
merge
public V merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, Metadata metadata)
Description copied from interface:AdvancedCache
An overloaded form ofCache.merge(Object, Object, BiFunction)
, which takes in an instance ofMetadata
which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadata
is only stored if the call is successful.- Specified by:
merge
in interfaceAdvancedCache<K,V>
- Overrides:
merge
in classAbstractDelegatingAdvancedCache<K,V>
- Parameters:
key
- , key with which the resulting value is to be associatedvalue
- , the non-null value to be merged with the existing value associated with the key or, if no existing value or a null value is associated with the key, to be associated with the keyremappingFunction
- , the function to recompute a value if presentmetadata
- , information to store alongside the new value- Returns:
- the new value associated with the specified key, or null if no value is associated with the key
-
merge
public V merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.merge(Object, Object, BiFunction)
which takes in lifespan parameters.- Specified by:
merge
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
merge
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- new value to merge with existing valueremappingFunction
- function to use to merge new and existing values into a merged value to store under keylifespan
- lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit
- time unit for lifespan- Returns:
- the merged value that was stored under key
-
merge
public V merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)
Description copied from interface:org.infinispan.commons.api.BasicCache
An overloaded form ofConcurrentMap.merge(Object, Object, BiFunction)
which takes in lifespan parameters.- Specified by:
merge
in interfaceorg.infinispan.commons.api.BasicCache<K,V>
- Overrides:
merge
in classAbstractDelegatingCache<K,V>
- Parameters:
key
- key to usevalue
- new value to merge with existing valueremappingFunction
- function to use to merge new and existing values into a merged value to store under keylifespan
- 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 time- Returns:
- the merged value that was stored under key
-
forEach
public void forEach(BiConsumer<? super K,? super V> action)
-
keySet
public CacheSet<K> keySet()
Description copied from interface:Cache
Returns a set view of the keys contained in this cache and cache loader across the entire cluster. Modifications and changes to the cache will be reflected in the set and vice versa. When this method is called nothing is actually queried as the backing set is just returned. Invocation on the set itself is when the various operations are ran.Unsupported Operations
Care should be taken when invokingSet.toArray()
,Set.toArray(Object[])
,Set.size()
,Set.retainAll(Collection)
andSet.iterator()
methods as they will traverse the entire contents of the cluster including a configuredCacheLoader
and remote entries. The former 2 methods especially have a very high likely hood of causing aOutOfMemoryError
due to storing all the keys in the entire cluster in the array. Use involving execution of this method on a production system is not recommended as they can be quite expensive operationsSupported Flags
Note any flag configured for the cache will also be passed along to the backing set when it was created. If additional flags are configured on the cache they will not affect any existing backings sets. If there are performance concerns then theFlag.SKIP_CACHE_LOAD
flag should be used to avoid hitting the cache store as this will cause all entries there to be read in (albeit in a batched form to preventOutOfMemoryError
) Also if you want the local contents only you can use theFlag.CACHE_MODE_LOCAL
flag so that other remote nodes are not queried for data. However the loader will still be used unless the previously mentionedFlag.SKIP_CACHE_LOAD
is also configured.Iterator Use
This class implements theCloseableIteratorSet
interface which creates aCloseableIterator
instead of a regular one. This means this iterator must be explicitly closed either through try with resource or calling the close method directly. Technically this iterator will also close itself if you iterate fully over it, but it is safest to always make sure you close it explicitly.Unsupported Operations
Due to not being able to add null values the following methods are not supported and will throwUnsupportedOperationException
if invoked.Set.add(Object)
Set.addAll(java.util.Collection)
-
entrySet
public CacheSet<Map.Entry<K,V>> entrySet()
Description copied from interface:Cache
Returns a set view of the mappings contained in this cache and cache loader across the entire cluster. Modifications and changes to the cache will be reflected in the set and vice versa. When this method is called nothing is actually queried as the backing set is just returned. Invocation on the set itself is when the various operations are ran. Care should be taken when invokingSet.toArray()
,Set.toArray(Object[])
,Set.size()
,Set.retainAll(Collection)
andSet.iterator()
methods as they will traverse the entire contents of the cluster including a configuredCacheLoader
and remote entries. The former 2 methods especially have a very high likely hood of causing aOutOfMemoryError
due to storing all the keys in the entire cluster in the array. Use involving execution of this method on a production system is not recommended as they can be quite expensive operations *Supported Flags
Note any flag configured for the cache will also be passed along to the backing set when it was created. If additional flags are configured on the cache they will not affect any existing backings sets. If there are performance concerns then theFlag.SKIP_CACHE_LOAD
flag should be used to avoid hitting the cache store as this will cause all entries there to be read in (albeit in a batched form to preventOutOfMemoryError
) Also if you want the local contents only you can use theFlag.CACHE_MODE_LOCAL
flag so that other remote nodes are not queried for data. However the loader will still be used unless the previously mentionedFlag.SKIP_CACHE_LOAD
is also configured.Modifying or Adding Entries
An entry's value is supported to be modified by using theMap.Entry.setValue(Object)
and it will update the cache as well. Also this backing set does allow addition of a new Map.Entry(s) via theSet.add(Object)
orSet.addAll(java.util.Collection)
methods.Iterator Use
This class implements theCloseableIteratorSet
interface which creates aCloseableIterator
instead of a regular one. This means this iterator must be explicitly closed either through try with resource or calling the close method directly. Technically this iterator will also close itself if you iterate fully over it, but it is safest to always make sure you close it explicitly.
-
values
public CacheCollection<V> values()
Description copied from interface:Cache
Returns a collection view of the values contained in this cache across the entire cluster. Modifications and changes to the cache will be reflected in the set and vice versa. When this method is called nothing is actually queried as the backing collection is just returned. Invocation on the collection itself is when the various operations are ran. Care should be taken when invokingCollection.toArray()
,Collection.toArray(Object[])
,Collection.size()
,Collection.retainAll(Collection)
andCollection.iterator()
methods as they will traverse the entire contents of the cluster including a configuredCacheLoader
and remote entries. The former 2 methods especially have a very high likely hood of causing aOutOfMemoryError
due to storing all the keys in the entire cluster in the array. Use involving execution of this method on a production system is not recommended as they can be quite expensive operations *Supported Flags
Note any flag configured for the cache will also be passed along to the backing set when it was created. If additional flags are configured on the cache they will not affect any existing backings sets. If there are performance concerns then theFlag.SKIP_CACHE_LOAD
flag should be used to avoid hitting the cache store as this will cause all entries there to be read in (albeit in a batched form to preventOutOfMemoryError
) Also if you want the local contents only you can use theFlag.CACHE_MODE_LOCAL
flag so that other remote nodes are not queried for data. However the loader will still be used unless the previously mentionedFlag.SKIP_CACHE_LOAD
is also configured.Iterator Use
This class implements the
CloseableIteratorCollection
interface which creates aCloseableIterator
instead of a regular one. This means this iterator must be explicitly closed either through try with resource or calling the close method directly. Technically this iterator will also close itself if you iterate fully over it, but it is safest to always make sure you close it explicitly.The iterator retrieved using
CloseableIteratorCollection.iterator()
supports the remove method, however the iterator retrieved fromCacheStream.iterator()
will not support remove.Unsupported Operations
Due to not being able to add null values the following methods are not supported and will throwUnsupportedOperationException
if invoked.Set.add(Object)
Set.addAll(java.util.Collection)
-
getAsync
public CompletableFuture<V> getAsync(K key)
Description copied from interface:org.infinispan.commons.api.AsyncCache
Asynchronous version ofMap.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 toMap.get(Object)
.- Specified by:
getAsync
in interfaceorg.infinispan.commons.api.AsyncCache<K,V>
- Overrides:
getAsync
in classAbstractDelegatingCache<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)
-
addListener
public void addListener(Object listener)
Description copied from interface:Listenable
Adds a listener to the component. Typically, listeners would need to be annotated withListener
and further to that, contain methods annotated appropriately, otherwise the listener will not be registered. See theListener
annotation for more information.- Specified by:
addListener
in interfaceListenable
- Overrides:
addListener
in classAbstractDelegatingCache<K,V>
- Parameters:
listener
- must not be null.
-
addListener
public void addListener(Object listener, KeyFilter<? super K> filter)
Description copied from interface:FilteringListenable
Adds a listener to the component. Typically, listeners would need to be annotated withListener
and further to that, contain methods annotated appropriately, otherwise the listener will not be registered. See theListener
annotation for more information.- Specified by:
addListener
in interfaceFilteringListenable<K,V>
- Overrides:
addListener
in classAbstractDelegatingCache<K,V>
- Parameters:
listener
- must not be null.
-
addListener
public <C> void addListener(Object listener, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter)
Description copied from interface:FilteringListenable
Registers a listener that will be notified on events that pass the filter condition. The value presented in the notifications will be first converted using the provided converter if there is one.Some implementations may provide optimizations when a
CacheEventFilterConverter
is provided as both arguments to the filter and converter arguments. Note the provided object must have reference equality ie. (==) to be recognized. This allows for the filter and conversion step to take place in the same method call reducing possible overhead.- Specified by:
addListener
in interfaceFilteringListenable<K,V>
- Overrides:
addListener
in classAbstractDelegatingCache<K,V>
- Type Parameters:
C
- The type of the resultant value after being converted- Parameters:
listener
- The listener to callback upon event notifications. Must not be null.filter
- The filter to see if the notification should be sent to the listener. Can be null.converter
- The converter to apply to the entry before being sent to the listener. Can be null.
-
addFilteredListener
public <C> void addFilteredListener(Object listener, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter, Set<Class<? extends Annotation>> filterAnnotations)
Description copied from interface:FilteringListenable
Registers a listener limiting the cache-entry specific events only to annotations that are passed in as parameter. For example, if the listener passed in contains callbacks forCacheEntryCreated
andCacheEntryModified
, and filtered annotations contains onlyCacheEntryCreated
, then the listener will be registered only forCacheEntryCreated
callbacks. Callback filtering only applies toCacheEntryCreated
,CacheEntryModified
,CacheEntryRemoved
andCacheEntryExpired
annotations. If the listener contains other annotations, these are preserved. This methods enables dynamic registration of listener interests at runtime without the need to create several different listener classes.- Specified by:
addFilteredListener
in interfaceFilteringListenable<K,V>
- Overrides:
addFilteredListener
in classAbstractDelegatingCache<K,V>
- Type Parameters:
C
- The type of the resultant value after being converted- Parameters:
listener
- The listener to callback upon event notifications. Must not be null.filter
- The filter to see if the notification should be sent to the listener. Can be null.converter
- The converter to apply to the entry before being sent to the listener. Can be null.filterAnnotations
- cache-entry annotations to allow listener to be registered on. Must not be null.
-
addStorageFormatFilteredListener
public <C> void addStorageFormatFilteredListener(Object listener, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter, Set<Class<? extends Annotation>> filterAnnotations)
Description copied from interface:FilteringListenable
Same asFilteringListenable.addFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)
, but assumes the filter and/or the converter will be done in the same data format as it's stored in the cache.- Specified by:
addStorageFormatFilteredListener
in interfaceFilteringListenable<K,V>
- Overrides:
addStorageFormatFilteredListener
in classAbstractDelegatingCache<K,V>
-
-