package org.infinispan;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import javax.transaction.TransactionManager;
import javax.transaction.xa.XAResource;
import org.infinispan.atomic.Delta;
import org.infinispan.batch.BatchContainer;
import org.infinispan.cache.impl.DecoratedCache;
import org.infinispan.commons.util.Experimental;
import org.infinispan.configuration.cache.PartitionHandlingConfiguration;
import org.infinispan.container.DataContainer;
import org.infinispan.container.entries.CacheEntry;
import org.infinispan.context.Flag;
import org.infinispan.context.InvocationContextContainer;
import org.infinispan.distribution.DistributionManager;
import org.infinispan.eviction.EvictionManager;
import org.infinispan.expiration.ExpirationManager;
import org.infinispan.factories.ComponentRegistry;
import org.infinispan.interceptors.AsyncInterceptorChain;
import org.infinispan.interceptors.base.CommandInterceptor;
import org.infinispan.metadata.Metadata;
import org.infinispan.partitionhandling.AvailabilityMode;
import org.infinispan.partitionhandling.impl.PartitionHandlingManager;
import org.infinispan.persistence.spi.CacheLoader;
import org.infinispan.remoting.rpc.RpcManager;
import org.infinispan.security.AuthorizationManager;
import org.infinispan.stats.Stats;
import org.infinispan.util.concurrent.locks.LockManager;
/**
* An advanced interface that exposes additional methods not available on {@link Cache}.
*
* @author Manik Surtani
* @author Galder Zamarreño
* @author Tristan Tarrant
* @since 4.0
*/
public interface AdvancedCache<K, V> extends Cache<K, V> {
/**
* A method that adds flags to any API call. For example, consider the following code snippet:
* <pre>
* cache.withFlags(Flag.FORCE_WRITE_LOCK).get(key);
* </pre>
* will invoke a cache.get() with a write lock forced.
* <p />
* <b>Note</b> that for the flag to take effect, the cache operation <b>must</b> be invoked on the instance returned by
* this method.
* <p />
* As an alternative to setting this on every
* invocation, users could also consider using the {@link DecoratedCache} wrapper, as this allows for more readable
* code. E.g.:
* <pre>
* Cache forceWriteLockCache = new DecoratedCache(cache, Flag.FORCE_WRITE_LOCK);
* forceWriteLockCache.get(key1);
* forceWriteLockCache.get(key2);
* forceWriteLockCache.get(key3);
* </pre>
*
* @param flags a set of flags to apply. See the {@link Flag} documentation.
* @return an {@link AdvancedCache} instance on which a real operation is to be invoked, if the flags are
* to be applied.
*/
AdvancedCache<K, V> withFlags(Flag... flags);
/**
* Adds a custom interceptor to the interceptor chain, at specified position, where the first interceptor in the
* chain is at position 0 and the last one at NUM_INTERCEPTORS - 1.
*
* @param i the interceptor to add
* @param position the position to add the interceptor
* @deprecated Since 9.0, use {@link #getAsyncInterceptorChain()} instead.
*/
@Deprecated
void addInterceptor(CommandInterceptor i, int position);
/**
* Adds a custom interceptor to the interceptor chain, after an instance of the specified interceptor type. Throws a
* cache exception if it cannot find an interceptor of the specified type.
*
* @param i interceptor to add
* @param afterInterceptor interceptor type after which to place custom interceptor
* @return true if successful, false otherwise.
* @deprecated Since 9.0, use {@link #getAsyncInterceptorChain()} instead.
*/
@Deprecated
boolean addInterceptorAfter(CommandInterceptor i, Class<? extends CommandInterceptor> afterInterceptor);
/**
* Adds a custom interceptor to the interceptor chain, before an instance of the specified interceptor type. Throws a
* cache exception if it cannot find an interceptor of the specified type.
*
* @param i interceptor to add
* @param beforeInterceptor interceptor type before which to place custom interceptor
* @return true if successful, false otherwise.
* @deprecated Since 9.0, use {@link #getAsyncInterceptorChain()} instead.
*/
@Deprecated
boolean addInterceptorBefore(CommandInterceptor i, Class<? extends CommandInterceptor> beforeInterceptor);
/**
* Removes the interceptor at a specified position, where the first interceptor in the chain is at position 0 and the
* last one at getInterceptorChain().size() - 1.
*
* @param position the position at which to remove an interceptor
* @deprecated Since 9.0, use {@link #getAsyncInterceptorChain()} instead.
*/
@Deprecated
void removeInterceptor(int position);
/**
* Removes the interceptor of specified type.
*
* @param interceptorType type of interceptor to remove
* @deprecated Since 9.0, use {@link #getAsyncInterceptorChain()} instead.
*/
@Deprecated
void removeInterceptor(Class<? extends CommandInterceptor> interceptorType);
/**
* @deprecated Since 9.0, use {@link #getAsyncInterceptorChain()} instead.
*/
@Deprecated
List<CommandInterceptor> getInterceptorChain();
/**
* Allows the modification of the interceptor chain.
*
* Experimental: The ability to modify the interceptors at runtime may be removed in future versions.
*
* @since 9.0
*/
@Experimental
AsyncInterceptorChain getAsyncInterceptorChain();
/**
* @return the eviction manager - if one is configured - for this cache instance
*/
EvictionManager getEvictionManager();
/**
* @return the expiration manager - if one is configured - for this cache instance
*/
ExpirationManager<K, V> getExpirationManager();
/**
* @return the component registry for this cache instance
*/
ComponentRegistry getComponentRegistry();
/**
* Retrieves a reference to the {@link org.infinispan.distribution.DistributionManager} if the cache is configured
* to use Distribution. Otherwise, returns a null.
* @return a DistributionManager, or null.
*/
DistributionManager getDistributionManager();
/**
* Retrieves the {@link AuthorizationManager} if the cache has security enabled. Otherwise returns null
*
* @return an AuthorizationManager or null
*/
AuthorizationManager getAuthorizationManager();
/**
* Locks a given key or keys eagerly across cache nodes in a cluster.
* <p>
* Keys can be locked eagerly in the context of a transaction only.
*
* @param keys the keys to lock
* @return true if the lock acquisition attempt was successful for <i>all</i> keys;
* false will only be returned if the lock acquisition timed out and the
* operation has been called with {@link Flag#FAIL_SILENTLY}.
* @throws org.infinispan.util.concurrent.TimeoutException if the lock
* cannot be acquired within the configured lock acquisition time.
*/
boolean lock(K... keys);
/**
* Locks collections of keys eagerly across cache nodes in a cluster.
* <p>
* Collections of keys can be locked eagerly in the context of a transaction only.
*
* @param keys collection of keys to lock
* @return true if the lock acquisition attempt was successful for <i>all</i> keys;
* false will only be returned if the lock acquisition timed out and the
* operation has been called with {@link Flag#FAIL_SILENTLY}.
* @throws org.infinispan.util.concurrent.TimeoutException if the lock
* cannot be acquired within the configured lock acquisition time.
*/
boolean lock(Collection<? extends K> keys);
/**
* Applies the given Delta to the DeltaAware object stored under deltaAwareValueKey if and only if all
* locksToAcquire locks are successfully obtained
*
*
* @param deltaAwareValueKey the key for DeltaAware object
* @param delta the delta to be applied to DeltaAware object
* @param locksToAcquire keys to be locked in DeltaAware scope
*/
void applyDelta(K deltaAwareValueKey, Delta delta, Object... locksToAcquire);
/**
* Returns the component in charge of communication with other caches in
* the cluster. If the cache's {@link org.infinispan.configuration.cache.ClusteringConfiguration#cacheMode()}
* is {@link org.infinispan.configuration.cache.CacheMode#LOCAL}, this
* method will return null.
*
* @return the RPC manager component associated with this cache instance or null
*/
RpcManager getRpcManager();
/**
* Returns the component in charge of batching cache operations.
*
* @return the batching component associated with this cache instance
*/
BatchContainer getBatchContainer();
/**
* Returns the component in charge of managing the interactions between the
* cache operations and the context information associated with them.
*
* @return the invocation context container component
* @deprecated No longer in use, implementations might return null.
*/
@Deprecated
InvocationContextContainer getInvocationContextContainer();
/**
* 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.
*
* @return the data container associated with this cache instance
*/
DataContainer<K, V> getDataContainer();
/**
* Returns the transaction manager configured for this cache. If no
* transaction manager was configured, this method returns null.
*
* @return the transaction manager associated with this cache instance or null
*/
TransactionManager getTransactionManager();
/**
* Returns the component that deals with all aspects of acquiring and
* releasing locks for cache entries.
*
* @return retrieves the lock manager associated with this cache instance
*/
LockManager getLockManager();
/**
* Returns a {@link Stats} object that allows several statistics associated
* with this cache at runtime.
*
* @return this cache's {@link Stats} object
*/
Stats getStats();
/**
* Returns the {@link XAResource} associated with this cache which can be
* used to do transactional recovery.
*
* @return an instance of {@link XAResource}
*/
XAResource getXAResource();
/**
* Returns the cache loader associated associated with this cache. As an alternative to setting this on every
* invocation, users could also consider using the {@link DecoratedCache} wrapper.
*
* @return this cache's cache loader
*/
ClassLoader getClassLoader();
/**
* Using this operation, users can call any {@link AdvancedCache} operation
* with a given {@link ClassLoader}. This means that any {@link ClassLoader} happening
* as a result of the cache operation will be done using the {@link ClassLoader}
* given. For example:
* <p />
* When users store POJO instances in caches configured with {@link org.infinispan.configuration.cache.StoreAsBinaryConfiguration},
* these instances are transformed into byte arrays. When these entries are
* read from the cache, a lazy unmarshalling process happens where these byte
* arrays are transformed back into POJO instances. Using {@link AdvancedCache#with(ClassLoader)}
* when reading that enables users to provide the class loader that should
* be used when trying to locate the classes that are constructed as a result
* of the unmarshalling process.
* <pre>
* cache.with(classLoader).get(key);
* </pre>
* <b>Note</b> that for the flag to take effect, the cache operation <b>must</b> be invoked on the instance
* returned by this method.
* <p />
* As an alternative to setting this on every
* invocation, users could also consider using the {@link DecoratedCache} wrapper, as this allows for more readable
* code. E.g.:
* <pre>
* Cache classLoaderSpecificCache = new DecoratedCache(cache, classLoader);
* classLoaderSpecificCache.get(key1);
* classLoaderSpecificCache.get(key2);
* classLoaderSpecificCache.get(key3);
* </pre>
*
* @return an {@link AdvancedCache} instance upon which operations can be called
* with a particular {@link ClassLoader}.
* @deprecated A cache manager, and all caches within it, can only have
* one classloader associated to it, so it's no longer possible to read
* cached data with a different classloader.
*/
@Deprecated
AdvancedCache<K, V> with(ClassLoader classLoader);
/**
* An overloaded form of {@link #put(K, V)}, which takes in an instance of
* {@link org.infinispan.metadata.Metadata} which can be used to provide metadata information for
* the entry being stored, such as lifespan, version of value...etc.
*
* @param key key to use
* @param value value to store
* @param metadata information to store alongside the value
* @return the previous value associated with <tt>key</tt>, or
* <tt>null</tt> if there was no mapping for <tt>key</tt>.
*
* @since 5.3
*/
V put(K key, V value, Metadata metadata);
/**
* An overloaded form of {@link #putAll(Map)}, which takes in an instance of
* {@link org.infinispan.metadata.Metadata} which can be used to provide metadata information for
* the entries being stored, such as lifespan, version of value...etc.
*
* @param map the values to store
* @param metadata information to store alongside the value(s)
* @since 7.2
*/
void putAll(Map<? extends K, ? extends V> map, Metadata metadata);
/**
* An overloaded form of {@link #replace(K, V)}, which takes in an
* instance of {@link Metadata} which can be used to provide metadata
* information for the entry being stored, such as lifespan, version
* of value...etc. The {@link Metadata} is only stored if the call is
* successful.
*
* @param key key with which the specified value is associated
* @param value value to be associated with the specified key
* @param metadata information to store alongside the new value
* @return the previous value associated with the specified key, or
* <tt>null</tt> if there was no mapping for the key.
*
* @since 5.3
*/
V replace(K key, V value, Metadata metadata);
/**
* An overloaded form of {@link #replace(K, V, V)}, which takes in an
* instance of {@link Metadata} which can be used to provide metadata
* information for the entry being stored, such as lifespan, version
* of value...etc. The {@link Metadata} is only stored if the call is
* successful.
*
* @param key key with which the specified value is associated
* @param oldValue value expected to be associated with the specified key
* @param newValue value to be associated with the specified key
* @param metadata information to store alongside the new value
* @return <tt>true</tt> if the value was replaced
*
* @since 5.3
*/
boolean replace(K key, V oldValue, V newValue, Metadata metadata);
/**
* An overloaded form of {@link #putIfAbsent(K, V)}, which takes in an
* instance of {@link Metadata} which can be used to provide metadata
* information for the entry being stored, such as lifespan, version
* of value...etc. The {@link Metadata} is only stored if the call is
* successful.
*
* @param key key with which the specified value is to be associated
* @param value value to be associated with the specified key
* @param metadata information to store alongside the new value
* @return the previous value associated with the specified key, or
* <tt>null</tt> if there was no mapping for the key.
*
* @since 5.3
*/
V putIfAbsent(K key, V value, Metadata metadata);
/**
* An overloaded form of {@link #putForExternalRead(K, V)}, which takes in an
* instance of {@link Metadata} which can be used to provide metadata
* information for the entry being stored, such as lifespan, version
* of value...etc. The {@link Metadata} is only stored if the call is
* successful.
*
* @param key key with which the specified value is to be associated
* @param value value to be associated with the specified key
* @param metadata information to store alongside the new value
*
* @since 7.0
*/
void putForExternalRead(K key, V value, Metadata metadata);
/**
* Asynchronous version of {@link #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
* {@link #put(Object, Object, Metadata)} if used in LOCAL mode.
* <p/>
*
* @param key key to use
* @param value value to store
* @param metadata information to store alongside the new value
* @return a future containing the old value replaced.
*
* @since 5.3
*/
CompletableFuture<V> putAsync(K key, V value, Metadata metadata);
// TODO: Even better: add replace/remove calls that apply the changes if a given function is successful
// That way, you could do comparison not only on the cache value, but also based on version...etc
/**
* Gets a collection of entries, returning them as {@link Map} of the values
* associated with the set of keys requested.
* <p>
* 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
* {@link 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.
* <p>
* Unlike other bulk methods if this invoked in an existing transaction all entries
* will be stored in the current transactional context
* <p>
* The returned {@link 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.
*
* @param keys The keys whose associated values are to be returned.
* @return 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.
* @throws NullPointerException if keys is null or if keys contains a null
*/
Map<K, V> getAll(Set<?> keys);
/**
* Retrieves a CacheEntry corresponding to a specific key.
*
* @param key the key whose associated cache entry is to be returned
* @return the cache entry to which the specified key is mapped, or
* {@code null} if this map contains no mapping for the key
*
* @since 5.3
*/
CacheEntry<K, V> getCacheEntry(Object key);
/**
* Gets a collection of entries from the {@link AdvancedCache}, returning them as
* {@link Map} of the cache entries associated with the set of keys requested.
* <p>
* 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
* {@link 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.
* <p>
* Unlike other bulk methods if this invoked in an existing transaction all entries
* will be stored in the current transactional context
* <p>
* The returned {@link 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.
*
* @param keys The keys whose associated values are to be returned.
* @return 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.
* @throws NullPointerException if keys is null or if keys contains a null
*/
Map<K, CacheEntry<K, V>> getAllCacheEntries(Set<?> keys);
/**
* It fetches all the keys which belong to the group.
* <p/>
* 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).
* <p/>
* The {@code 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 {@link #put(Object, Object)} and {@link #remove(Object)}. To remove all the keys
* in the group use {@link #removeGroup(String)}.
* <p/>
* To improve performance you may use the {@code flag} {@link org.infinispan.context.Flag#SKIP_CACHE_LOAD} to avoid
* fetching the key/value from persistence. However, you will get an inconsistent snapshot of the group.
*
* @param groupName the group name.
* @return an immutable {@link java.util.Map} with the key/value pairs.
*/
Map<K, V> getGroup(String groupName);
/**
* It removes all the key which belongs to a group.
* <p/>
* Semantically, it fetches the most recent group keys/values and removes them.
* <p/>
* Note that, concurrent addition perform by other transactions/threads to the group may not be removed.
*
* @param groupName the group name.
*/
void removeGroup(String groupName);
/**
* Returns the cache's availability. In local mode this method will always return {@link AvailabilityMode#AVAILABLE}. In
* clustered mode, the {@link PartitionHandlingManager} is queried to obtain the availability mode.
*/
AvailabilityMode getAvailability();
/**
* Manually change the availability of the cache.
* Doesn't change anything if the cache is not clustered or partition handling is not enabled
* ({@link PartitionHandlingConfiguration#enabled()}.
*/
void setAvailability(AvailabilityMode availabilityMode);
/**
* Identical to {@link Cache#entrySet()} but is typed to return CacheEntries instead of Entries. Please see
* the other method for a description of its behaviors.
* <p>
* This method is needed since nested generics do not support covariance
* @see Cache#entrySet()
* @return the entry set containing all of the CacheEntries
*/
CacheSet<CacheEntry<K, V>> cacheEntrySet();
/**
* 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
* {@link ExpirationManager}.
* <p>
* This command will only remove the value if the value and lifespan also match if provided.
* <p>
* NOTE: This method may be removed at any point including in a minor release and is not supported for external
* usage.
* @param key the key that is expiring
* @param value the value that mapped to the given. Null means it will match any value
* @param lifespan the lifespan that should match. If null is provided it will match any lifespan value
*/
void removeExpired(K key, V value, Long lifespan);
}