Package org.infinispan.cache.impl

Class AbstractDelegatingAdvancedCache<K,V>

java.lang.Object
org.infinispan.cache.impl.AbstractDelegatingCache<K,V>
org.infinispan.cache.impl.AbstractDelegatingAdvancedCache<K,V>
All Implemented Interfaces:
ConcurrentMap<K,V>, Map<K,V>, AdvancedCache<K,V>, Cache<K,V>, InternalCache<K,V>, AsyncCache<K,V>, BasicCache<K,V>, BatchingCache, Lifecycle, TransactionalCache, FilteringListenable<K,V>, Listenable
Direct Known Subclasses:
AliasCache, DecoratedCache, EncoderCache, SecureCacheImpl
public abstract class AbstractDelegatingAdvancedCache<K,V> extends AbstractDelegatingCache<K,V> implements AdvancedCache<K,V>, InternalCache<K,V>
Similar to AbstractDelegatingCache, but for AdvancedCache.
Author:
Mircea.Markus@jboss.com, Tristan Tarrant
See Also:

  • Field Details

  • Constructor Details

    • AbstractDelegatingAdvancedCache

      protected AbstractDelegatingAdvancedCache(AdvancedCache<K,V> cache)

  • Method Details

    • getAdvancedCache

      public AdvancedCache<K,V> getAdvancedCache()
      Specified by:
      getAdvancedCache in interface Cache<K,V>
      Overrides:
      getAdvancedCache in class AbstractDelegatingCache<K,V>

    • getExpirationManager

      public ExpirationManager<K,V> getExpirationManager()
      Specified by:
      getExpirationManager in interface AdvancedCache<K,V>
      Returns:
      the expiration manager - if one is configured - for this cache instance

    • getComponentRegistry

      public ComponentRegistry getComponentRegistry()
      Specified by:
      getComponentRegistry in interface InternalCache<K,V>
      Overrides:
      getComponentRegistry in class AbstractDelegatingCache<K,V>

    • getDistributionManager

      public DistributionManager getDistributionManager()
      Description copied from interface: AdvancedCache
      Retrieves a reference to the DistributionManager if the cache is configured to use Distribution. Otherwise, returns a null.
      Specified by:
      getDistributionManager in interface AdvancedCache<K,V>
      Returns:
      a DistributionManager, or null.

    • getAuthorizationManager

      public AuthorizationManager getAuthorizationManager()
      Description copied from interface: AdvancedCache
      Retrieves the AuthorizationManager if the cache has security enabled. Otherwise returns null
      Specified by:
      getAuthorizationManager in interface AdvancedCache<K,V>
      Returns:
      an AuthorizationManager or null

    • lockAs

      public AdvancedCache<K,V> lockAs(Object lockOwner)
      Description copied from interface: AdvancedCache
      Whenever this cache acquires a lock it will do so using the given Object as the owner of said lock.

      This can be useful when a lock may have been manually acquired and you wish to reuse that lock across invocations.

      Great care should be taken with this command as misuse can very easily lead to deadlocks.

      Specified by:
      lockAs in interface AdvancedCache<K,V>
      Parameters:
      lockOwner - the lock owner to lock any keys as
      Returns:
      an AdvancedCache instance on which when an operation is invoked it will use lock owner object to acquire any locks

    • getRpcManager

      public RpcManager getRpcManager()
      Description copied from interface: AdvancedCache
      Returns the component in charge of communication with other caches in the cluster. If the cache's ClusteringConfiguration.cacheMode() is CacheMode.LOCAL, this method will return null.
      Specified by:
      getRpcManager in interface AdvancedCache<K,V>
      Returns:
      the RPC manager component associated with this cache instance or null

    • getBatchContainer

      public BatchContainer getBatchContainer()
      Description copied from interface: AdvancedCache
      Returns the component in charge of batching cache operations.
      Specified by:
      getBatchContainer in interface AdvancedCache<K,V>
      Returns:
      the batching component associated with this cache instance

    • getDataContainer

      public DataContainer<K,V> getDataContainer()
      Description copied from interface: AdvancedCache
      Returns the container where data is stored in the cache. Users should interact with this component with care because direct calls on it bypass the internal interceptors and other infrastructure in place to guarantee the consistency of data.
      Specified by:
      getDataContainer in interface AdvancedCache<K,V>
      Returns:
      the data container associated with this cache instance

    • getTransactionManager

      public jakarta.transaction.TransactionManager getTransactionManager()
      Specified by:
      getTransactionManager in interface TransactionalCache
      Returns:
      the TransactionManager in use by this cache or null if the cache isn't transactional.

    • getLockManager

      public LockManager getLockManager()
      Description copied from interface: AdvancedCache
      Returns the component that deals with all aspects of acquiring and releasing locks for cache entries.
      Specified by:
      getLockManager in interface AdvancedCache<K,V>
      Returns:
      retrieves the lock manager associated with this cache instance

    • getXAResource

      public XAResource getXAResource()
      Description copied from interface: AdvancedCache
      Returns the XAResource associated with this cache which can be used to do transactional recovery.
      Specified by:
      getXAResource in interface AdvancedCache<K,V>
      Returns:
      an instance of XAResource

    • getAvailability

      public AvailabilityMode getAvailability()
      Description copied from interface: AdvancedCache
      Returns the cache's availability. In local mode this method will always return AvailabilityMode.AVAILABLE. In clustered mode, the PartitionHandlingManager is queried to obtain the availability mode.
      Specified by:
      getAvailability in interface AdvancedCache<K,V>

    • setAvailability

      public void setAvailability(AvailabilityMode availabilityMode)
      Description copied from interface: AdvancedCache
      Manually change the availability of the cache. Doesn't change anything if the cache is not clustered or PartitionHandlingConfiguration.whenSplit() is set to PartitionHandling.ALLOW_READ_WRITES.
      Specified by:
      setAvailability in interface AdvancedCache<K,V>

    • getCacheAvailability

      @ManagedAttribute(description="Returns the cache availability", displayName="Cache availability", dataType=TRAIT, writable=true) public String getCacheAvailability()

    • setCacheAvailability

      public void setCacheAvailability(String availabilityString)

    • isRebalancingEnabled

      @ManagedAttribute(description="Returns whether cache rebalancing is enabled", displayName="Cache rebalacing", dataType=TRAIT, writable=true) public boolean isRebalancingEnabled()

    • setRebalancingEnabled

      public void setRebalancingEnabled(boolean enabled)

    • touch

      public CompletionStage<Boolean> touch(Object key, boolean touchEvenIfExpired)
      Description copied from interface: AdvancedCache
      Touches the given key if present. This will refresh its last access time, used for max idle, and count as a recent access for eviction purposes.

      Note that it is possible to touch an entry that is expired via max idle if touchEvenIfExpired argument is true.

      This method will return without blocking and complete the returned stage with a value after all appropriate nodes have actually touched the value.

      Specified by:
      touch in interface AdvancedCache<K,V>
      Parameters:
      key - key of the entry to touch
      touchEvenIfExpired - true if the entry should be touched even if already expired via max idle, effectively making it so the entry is no longer expired via max idle
      Returns:
      true if the entry was actually touched

    • touch

      public CompletionStage<Boolean> touch(Object key, int segment, boolean touchEvenIfExpired)
      Description copied from interface: AdvancedCache
      The same as AdvancedCache.touch(Object, boolean) except that the segment is already known. This can be helpful to reduce an extra segment computation
      Specified by:
      touch in interface AdvancedCache<K,V>
      Parameters:
      key - key of the entry to touch
      segment - segment of the key
      touchEvenIfExpired - true if the entry should be touched even if already expired via max idle, effectively making it so the entry is no longer expired via max idle
      Returns:
      true if the entry was actually touched

    • withFlags

      public AdvancedCache<K,V> withFlags(Flag flag)
      Description copied from interface: AdvancedCache
      An alternative to AdvancedCache.withFlags(Flag...) optimized for a single flag.
      Specified by:
      withFlags in interface AdvancedCache<K,V>

    • withFlags

      public AdvancedCache<K,V> withFlags(Flag... flags)
      Description copied from interface: AdvancedCache
      A method that adds flags to any API call. For example, consider the following code snippet: 
         cache.withFlags(Flag.FORCE_WRITE_LOCK).get(key);
      will invoke a cache.get() with a write lock forced.

      Note that for the flag to take effect, the cache operation must be invoked on the instance returned by this method.

      As an alternative to setting this on every invocation, users should also consider saving the decorated cache, as this allows for more readable code. E.g.: 

          AdvancedCache<?, ?> forceWriteLockCache = cache.withFlags(Flag.FORCE_WRITE_LOCK);
    forceWriteLockCache.get(key1);
    forceWriteLockCache.get(key2);
    forceWriteLockCache.get(key3);
      Specified by:
      withFlags in interface AdvancedCache<K,V>
      Parameters:
      flags - a set of flags to apply. See the Flag documentation.
      Returns:
      an AdvancedCache instance on which a real operation is to be invoked, if the flags are to be applied.

    • withFlags

      public AdvancedCache<K,V> withFlags(Collection<Flag> flags)
      Description copied from interface: AdvancedCache
      An alternative to AdvancedCache.withFlags(Flag...) not requiring array allocation.
      Specified by:
      withFlags in interface AdvancedCache<K,V>

    • noFlags

      public AdvancedCache<K,V> noFlags()
      Description copied from interface: AdvancedCache
      Unset all flags set on this cache using AdvancedCache.withFlags(Flag...) or AdvancedCache.withFlags(Collection) methods.
      Specified by:
      noFlags in interface AdvancedCache<K,V>
      Returns:
      Cache not applying any flags to the command; possibly this.

    • transform

      public AdvancedCache<K,V> transform(Function<AdvancedCache<K,V>,? extends AdvancedCache<K,V>> transformation)
      Description copied from interface: AdvancedCache
      Apply the transformation on each AdvancedCache instance in a delegation chain, starting with the innermost implementation.
      Specified by:
      transform in interface AdvancedCache<K,V>
      Parameters:
      transformation -
      Returns:
      The outermost transformed cache.

    • withSubject

      public AdvancedCache<K,V> withSubject(Subject subject)
      Description copied from interface: AdvancedCache
      Performs any cache operations using the specified Subject. Only applies to caches with authorization enabled (see ConfigurationBuilder.security()).
      Specified by:
      withSubject in interface AdvancedCache<K,V>
      Parameters:
      subject -
      Returns:
      an AdvancedCache instance on which a real operation is to be invoked, using the specified subject

    • lock

      public boolean lock(K... key)
      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 interface AdvancedCache<K,V>
      Parameters:
      key - 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 interface AdvancedCache<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.

    • getStats

      public Stats getStats()
      Description copied from interface: AdvancedCache
      Returns a Stats object that allows several statistics associated with this cache at runtime.
      Specified by:
      getStats in interface AdvancedCache<K,V>
      Returns:
      this cache's Stats object

    • getClassLoader

      public ClassLoader getClassLoader()
      Description copied from interface: AdvancedCache
      Returns the cache loader associated associated with this cache. As an alternative to setting this on every invocation, users could also consider using the DecoratedCache wrapper.
      Specified by:
      getClassLoader in interface AdvancedCache<K,V>
      Returns:
      this cache's cache loader

    • getAll

      public Map<K,V> getAll(Set<?> keys)
      Description copied from interface: AdvancedCache
      Gets a collection of entries, returning them as Map 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 interface AdvancedCache<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.

    • 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 interface AdvancedCache<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 interface AdvancedCache<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

    • getAllCacheEntries

      public Map<K,CacheEntry<K,V>> getAllCacheEntries(Set<?> keys)
      Description copied from interface: AdvancedCache
      Gets a collection of entries from the AdvancedCache, returning them as Map 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 interface AdvancedCache<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.

    • getAndPutAll

      public Map<K,V> getAndPutAll(Map<? extends K,? extends V> map)
      Description copied from interface: AdvancedCache
      Executes an equivalent of Map.putAll(Map), returning previous values of the modified entries.
      Specified by:
      getAndPutAll in interface AdvancedCache<K,V>
      Parameters:
      map - mappings to be stored in this map
      Returns:
      A map of previous values for the given keys. If the previous mapping does not exist it will not be in the returned map.

    • 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).

      The map returned is immutable and represents the group at the time of the invocation. If you want to add or remove keys from a group use BasicCache.put(Object, Object) and BasicCache.remove(Object). To remove all the keys in the group use AdvancedCache.removeGroup(String).

      To improve performance you may use the flag 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 interface AdvancedCache<K,V>
      Parameters:
      groupName - the group name.
      Returns:
      an immutable Map with the key/value pairs.

    • removeGroup

      public void removeGroup(String groupName)
      Description copied from interface: AdvancedCache
      It removes all the key which belongs to a group.

      Semantically, it fetches the most recent group keys/values and removes them.

      Note that, concurrent addition perform by other transactions/threads to the group may not be removed.

      Specified by:
      removeGroup in interface AdvancedCache<K,V>
      Parameters:
      groupName - the group name.

    • put

      public V put(K key, V value, Metadata metadata)
      Description copied from interface: AdvancedCache
      An overloaded form of
      invalid reference 
      #put(K, V)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
      Specified by:
      put in interface AdvancedCache<K,V>
      Parameters:
      key - key to use
      value - value to store
      metadata - 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
      invalid reference 
      #replace(K, V)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      replace in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is associated
      value - value to be associated with the specified key
      metadata - 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<V> replaceAsync(K key, V value, Metadata metadata)
      Description copied from interface: AdvancedCache
      An overloaded form of
      invalid reference 
      #replaceAsync(K, V)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      replaceAsync in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is associated
      value - value to be associated with the specified key
      metadata - 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.

    • replaceAsyncEntry

      public CompletableFuture<CacheEntry<K,V>> replaceAsyncEntry(K key, V value, Metadata metadata)
      Description copied from interface: AdvancedCache
      An extension of AdvancedCache.replaceAsync(K, V, Metadata), which returns a CacheEntry instead of only the value.
      Specified by:
      replaceAsyncEntry in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is associated
      value - value to be associated with the specified key
      metadata - information to store alongside the new value
      Returns:
      the future that contains previous CacheEntry associated with the specified key, or null if there was no mapping for the key.
      See Also:

    • replace

      public boolean replace(K key, V oldValue, V value, Metadata metadata)
      Description copied from interface: AdvancedCache
      An overloaded form of
      invalid reference 
      #replace(K, V, V)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      replace in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is associated
      oldValue - value expected to be associated with the specified key
      value - value to be associated with the specified key
      metadata - 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 interface AdvancedCache<K,V>

    • putIfAbsent

      public V putIfAbsent(K key, V value, Metadata metadata)
      Description copied from interface: AdvancedCache
      An overloaded form of
      invalid reference 
      #putIfAbsent(K, V)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      putIfAbsent in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is to be associated
      value - value to be associated with the specified key
      metadata - 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.

    • putIfAbsentAsync

      public CompletableFuture<V> putIfAbsentAsync(K key, V value, Metadata metadata)
      Description copied from interface: AdvancedCache
      An overloaded form of
      invalid reference 
      #putIfAbsentAsync(K, V)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      putIfAbsentAsync in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is to be associated
      value - value to be associated with the specified key
      metadata - 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.

    • putIfAbsentAsyncEntry

      public CompletableFuture<CacheEntry<K,V>> putIfAbsentAsyncEntry(K key, V value, Metadata metadata)
      Description copied from interface: AdvancedCache
      An extension form of AdvancedCache.putIfAbsentAsync(K, V, Metadata), which returns a CacheEntry instead of only the value.
      Specified by:
      putIfAbsentAsyncEntry in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is to be associated
      value - value to be associated with the specified key
      metadata - information to store alongside the new value
      Returns:
      the future that contains previous CacheEntry associated with the specified key, or null if there was no mapping for the key.
      See Also:

    • putAsync

      public CompletableFuture<V> putAsync(K key, V value, Metadata metadata)
      Description copied from interface: AdvancedCache
      Asynchronous version of AdvancedCache.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 over AdvancedCache.put(Object, Object, Metadata) if used in LOCAL mode.

      Specified by:
      putAsync in interface AdvancedCache<K,V>
      Parameters:
      key - key to use
      value - value to store
      metadata - information to store alongside the new value
      Returns:
      a future containing the old value replaced.

    • putAsyncEntry

      public CompletableFuture<CacheEntry<K,V>> putAsyncEntry(K key, V value, Metadata metadata)
      Description copied from interface: AdvancedCache
      Extension of AdvancedCache.putAsync(K, V, Metadata) which returns a CacheEntry instead of only the previous value.
      Specified by:
      putAsyncEntry in interface AdvancedCache<K,V>
      Parameters:
      key - key to use
      value - value to store
      metadata - information to store alongside the new value
      Returns:
      a future containing the old CacheEntry replaced.

    • putForExternalRead

      public void putForExternalRead(K key, V value, Metadata metadata)
      Description copied from interface: AdvancedCache
      An overloaded form of
      invalid reference 
      #putForExternalRead(K, V)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      putForExternalRead in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is to be associated
      value - value to be associated with the specified key
      metadata - information to store alongside the new value

    • 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
      invalid reference 
      #compute(K, BiFunction)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
      Specified by:
      compute in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is associated
      remappingFunction - function to be applied to the specified key/value
      metadata - information to store alongside the new value
      Returns:
      the previous value associated with the specified key, or null if remapping function is gives null.

    • 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
      invalid reference 
      #computeIfPresent(K, BiFunction)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      computeIfPresent in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is associated
      remappingFunction - function to be applied to the specified key/value
      metadata - 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.

    • computeIfAbsent

      public V computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction, Metadata metadata)
      Description copied from interface: AdvancedCache
      An overloaded form of
      invalid reference 
      #computeIfAbsent(K, Function)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      computeIfAbsent in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is associated
      mappingFunction - function to be applied to the specified key
      metadata - 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.

    • 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 of Cache.merge(Object, Object, BiFunction), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      merge in interface AdvancedCache<K,V>
      Parameters:
      key - , key with which the resulting value is to be associated
      value - , 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 key
      remappingFunction - , the function to recompute a value if present
      metadata - , 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

    • computeAsync

      public CompletableFuture<V> computeAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, Metadata metadata)
      Description copied from interface: AdvancedCache
      Overloaded
      invalid reference 
      #computeAsync(K, BiFunction)
      , which stores metadata alongside the value. This method does not block on remote calls, even if your cache mode is synchronous.
      Specified by:
      computeAsync in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is associated
      remappingFunction - function to be applied to the specified key/value
      metadata - information to store alongside the new value
      Returns:
      the previous value associated with the specified key, or null if remapping function is gives null.

    • computeIfPresentAsync

      public CompletableFuture<V> computeIfPresentAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, Metadata metadata)
      Description copied from interface: AdvancedCache
      Overloaded
      invalid reference 
      #computeIfPresentAsync(K, BiFunction)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      computeIfPresentAsync in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is associated
      remappingFunction - function to be applied to the specified key/value
      metadata - 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.

    • computeIfAbsentAsync

      public CompletableFuture<V> computeIfAbsentAsync(K key, Function<? super K,? extends V> mappingFunction, Metadata metadata)
      Description copied from interface: AdvancedCache
      Overloaded
      invalid reference 
      #computeIfAbsentAsync(K, Function)
      , which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      computeIfAbsentAsync in interface AdvancedCache<K,V>
      Parameters:
      key - key with which the specified value is associated
      mappingFunction - function to be applied to the specified key
      metadata - 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.

    • mergeAsync

      public CompletableFuture<V> mergeAsync(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)
      Description copied from interface: AsyncCache
      Asynchronous version of BasicCache.merge(Object, Object, BiFunction, 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>
      Overrides:
      mergeAsync in class AbstractDelegatingCache<K,V>

    • 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>
      Overrides:
      mergeAsync in class AbstractDelegatingCache<K,V>

    • mergeAsync

      public CompletableFuture<V> mergeAsync(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, Metadata metadata)
      Description copied from interface: AdvancedCache
      Overloaded AsyncCache.mergeAsync(Object, Object, BiFunction), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.
      Specified by:
      mergeAsync in interface AdvancedCache<K,V>
      Parameters:
      key - , key with which the resulting value is to be associated
      value - , 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 key
      remappingFunction - , the function to recompute a value if present
      metadata - , 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

    • computeAsync

      public CompletableFuture<V> computeAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
      Description copied from interface: AsyncCache
      Asynchronous version of ConcurrentMap.compute(Object, BiFunction). This method does not block on remote calls, even if your cache mode is synchronous.
      Specified by:
      computeAsync in interface AsyncCache<K,V>
      Overrides:
      computeAsync in class AbstractDelegatingCache<K,V>

    • computeAsync

      public CompletableFuture<V> computeAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)
      Description copied from interface: AsyncCache
      Asynchronous version of BasicCache.compute(Object, BiFunction, 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>
      Overrides:
      computeAsync in class AbstractDelegatingCache<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>
      Overrides:
      computeAsync in class AbstractDelegatingCache<K,V>

    • computeIfAbsentAsync

      public CompletableFuture<V> computeIfAbsentAsync(K key, Function<? super K,? extends V> mappingFunction)
      Description copied from interface: AsyncCache
      Asynchronous version of ConcurrentMap.computeIfAbsent(Object, Function). This method does not block on remote calls, even if your cache mode is synchronous.
      Specified by:
      computeIfAbsentAsync in interface AsyncCache<K,V>
      Overrides:
      computeIfAbsentAsync in class AbstractDelegatingCache<K,V>

    • computeIfAbsentAsync

      public CompletableFuture<V> computeIfAbsentAsync(K key, Function<? super K,? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit)
      Description copied from interface: AsyncCache
      Asynchronous version of BasicCache.computeIfAbsent(Object, Function, 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>
      Overrides:
      computeIfAbsentAsync in class AbstractDelegatingCache<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>
      Overrides:
      computeIfAbsentAsync in class AbstractDelegatingCache<K,V>

    • computeIfPresentAsync

      public CompletableFuture<V> computeIfPresentAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
      Description copied from interface: AsyncCache
      Asynchronous version of ConcurrentMap.computeIfPresent(Object, BiFunction). This method does not block on remote calls, even if your cache mode is synchronous.
      Specified by:
      computeIfPresentAsync in interface AsyncCache<K,V>
      Overrides:
      computeIfPresentAsync in class AbstractDelegatingCache<K,V>

    • computeIfPresentAsync

      public CompletableFuture<V> computeIfPresentAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)
      Description copied from interface: AsyncCache
      Asynchronous version of BasicCache.computeIfPresent(Object, BiFunction, 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>
      Overrides:
      computeIfPresentAsync in class AbstractDelegatingCache<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>
      Overrides:
      computeIfPresentAsync in class AbstractDelegatingCache<K,V>

    • mergeAsync

      public CompletableFuture<V> mergeAsync(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
      Description copied from interface: AsyncCache
      Asynchronous version of ConcurrentMap.merge(Object, Object, BiFunction). This method does not block on remote calls, even if your cache mode is synchronous.
      Specified by:
      mergeAsync in interface AsyncCache<K,V>
      Overrides:
      mergeAsync in class AbstractDelegatingCache<K,V>

    • putAll

      public void putAll(Map<? extends K,? extends V> map, Metadata metadata)
      Description copied from interface: AdvancedCache
      An overloaded form of Map.putAll(Map), which takes in an instance of Metadata which can be used to provide metadata information for the entries being stored, such as lifespan, version of value...etc.
      Specified by:
      putAll in interface AdvancedCache<K,V>
      Parameters:
      map - the values to store
      metadata - information to store alongside the value(s)

    • putAllAsync

      public CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> map, Metadata metadata)
      Specified by:
      putAllAsync in interface AdvancedCache<K,V>

    • cacheEntrySet

      public CacheSet<CacheEntry<K,V>> cacheEntrySet()
      Description copied from interface: AdvancedCache
      Identical to Cache.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 interface AdvancedCache<K,V>
      Returns:
      the entry set containing all of the CacheEntries
      See Also:

    • lockedStream

      public LockedStream<K,V> lockedStream()
      Description copied from interface: AdvancedCache
      Returns a sequential stream using this Cache as the source. This stream is very similar to using the CacheStream returned from the CacheCollection.stream() method of the collection returned via AdvancedCache.cacheEntrySet(). The use of this locked stream is that when an entry is being processed by the user the entry is locked for the invocation preventing a different thread from modifying it.

      Note that this stream is not supported when using a optimistic transactional or simple cache. Both non transactional and pessimistic transactional caches are supported.

      The stream will not share any ongoing transaction the user may have. Code executed by the stream should be treated as completely independent. That is any operation performed via the stream will require the user to start their own transaction or will be done intrinsically on the invocation. Note that if there is an ongoing transaction that has a lock on a key from the cache, that it will cause a deadlock.

      Currently simple cache, ConfigurationBuilder.simpleCache(boolean) was set to true, and optimistic caches, TransactionConfigurationBuilder.lockingMode(LockingMode) was set to LockingMode.OPTIMISTIC, do not support this method. In this case it will throw an UnsupportedOperationException. This restriction may be removed in a future version. Also this method cannot be used on a cache that has a lock owner already specified via AdvancedCache.lockAs(Object) as this could lead to a deadlock or the release of locks early and will throw an IllegalStateException.

      Specified by:
      lockedStream in interface AdvancedCache<K,V>
      Returns:
      the locked stream

    • 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 the ExpirationManager.

      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 interface AdvancedCache<K,V>
      Parameters:
      key - the key that is expiring
      value - the value that mapped to the given. Null means it will match any value
      lifespan - 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 interface AdvancedCache<K,V>
      Parameters:
      key - the key that expired via max idle for the given entry
      Returns:
      if the entry was removed

    • withEncoding

      public AdvancedCache<?,?> withEncoding(Class<? extends Encoder> encoder)
      Description copied from interface: AdvancedCache
      Performs any cache operations using the specified Encoder.
      Specified by:
      withEncoding in interface AdvancedCache<K,V>
      Parameters:
      encoder - Encoder used for both keys and values.
      Returns:
      an instance of AdvancedCache where all operations will use the supplied encoder.

    • withEncoding

      public AdvancedCache withEncoding(Class<? extends Encoder> keyEncoder, Class<? extends Encoder> valueEncoder)
      Description copied from interface: AdvancedCache
      Performs any cache operations using the specified pair of Encoder.
      Specified by:
      withEncoding in interface AdvancedCache<K,V>
      Parameters:
      keyEncoder - Encoder for the keys.
      valueEncoder - Encoder for the values.
      Returns:
      an instance of AdvancedCache where all operations will use the supplied encoders.

    • withKeyEncoding

      public AdvancedCache<?,?> withKeyEncoding(Class<? extends Encoder> encoder)
      Specified by:
      withKeyEncoding in interface AdvancedCache<K,V>

    • withWrapping

      @Deprecated(forRemoval=true, since="11.0") public AdvancedCache<K,V> withWrapping(Class<? extends Wrapper> wrapper)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AdvancedCache
      Performs any cache operations using the specified Wrapper.
      Specified by:
      withWrapping in interface AdvancedCache<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<?,?> withMediaType(String keyMediaType, String valueMediaType)
      Description copied from interface: AdvancedCache
      Perform any cache operations using an alternate MediaType.
      Specified by:
      withMediaType in interface AdvancedCache<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 supplied MediaType.

    • withMediaType

      public <K1, V1> AdvancedCache<K1,V1> withMediaType(MediaType keyMediaType, MediaType valueMediaType)
      Specified by:
      withMediaType in interface AdvancedCache<K,V>
      See Also:

    • withStorageMediaType

      public AdvancedCache<K,V> withStorageMediaType()
      Description copied from interface: AdvancedCache
      Perform any cache operations using the same MediaType of the cache storage. This is equivalent to disabling transcoding on the cache.
      Specified by:
      withStorageMediaType in interface AdvancedCache<K,V>
      Returns:
      an instance of AdvancedCache where no data conversion will take place.

    • withWrapping

      @Deprecated(forRemoval=true, since="11.0") public AdvancedCache<K,V> withWrapping(Class<? extends Wrapper> keyWrapper, Class<? extends Wrapper> valueWrapper)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AdvancedCache
      Performs any cache operations using the specified pair of Wrapper.
      Specified by:
      withWrapping in interface AdvancedCache<K,V>
      Parameters:
      keyWrapper - Wrapper for the keys.
      valueWrapper - Wrapper for the values.
      Returns:
      AdvancedCache where all operations will use the supplied wrappers.

    • rewrap

      public abstract AdvancedCache rewrap(AdvancedCache newDelegate)
      No generics because some methods return AdvancedCache<?, ?>, and returning the proper type would require erasure anyway.

    • getKeyDataConversion

      public DataConversion getKeyDataConversion()
      Specified by:
      getKeyDataConversion in interface AdvancedCache<K,V>
      Returns:
      The associated DataConversion for the keys.

    • getValueDataConversion

      public DataConversion getValueDataConversion()
      Specified by:
      getValueDataConversion in interface AdvancedCache<K,V>
      Returns:
      The associated DataConversion for the cache's values.

    • 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>
      Overrides:
      getAllAsync in class AbstractDelegatingCache<K,V>

    • removeAsyncEntry

      public CompletableFuture<CacheEntry<K,V>> removeAsyncEntry(Object key)
      Description copied from interface: AdvancedCache
      An extension of AsyncCache.removeAsync(Object), which returns a CacheEntry instead of only the value.
      Specified by:
      removeAsyncEntry in interface AdvancedCache<K,V>
      Parameters:
      key - key to remove
      Returns:
      a future containing the CacheEntry removed or null if not found.
      See Also: