Package org.infinispan.cache.impl

Class StatsCollectingCache<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 StatsCollectingCache<K,​V>
extends SimpleCacheImpl<K,​V>
    Wraps existing AdvancedCache to collect statistics
    Author:
    Radim Vansa <rvansa@redhat.com>

    • Constructor Detail

      • StatsCollectingCache

        public StatsCollectingCache​(String cacheName)

    • Method Detail

      • 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 could also consider using the DecoratedCache wrapper, as this allows for more readable code. E.g.: 

            Cache forceWriteLockCache = new DecoratedCache(cache, Flag.FORCE_WRITE_LOCK);
    forceWriteLockCache.get(key1);
    forceWriteLockCache.get(key2);
    forceWriteLockCache.get(key3);
        Specified by:
        withFlags in interface AdvancedCache<K,​V>
        Overrides:
        withFlags in class SimpleCacheImpl<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.

      • with

        public AdvancedCache<K,​V> with​(ClassLoader classLoader)
        Description copied from interface: AdvancedCache
        Using this operation, users can call any AdvancedCache operation with a given ClassLoader. This means that any ClassLoader happening as a result of the cache operation will be done using the ClassLoader given. For example:

        When users store POJO instances in caches configured with 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 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. 

            cache.with(classLoader).get(key);
        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 could also consider using the DecoratedCache wrapper, as this allows for more readable code. E.g.: 

            Cache classLoaderSpecificCache = new DecoratedCache(cache, classLoader);
    classLoaderSpecificCache.get(key1);
    classLoaderSpecificCache.get(key2);
    classLoaderSpecificCache.get(key3);
        Specified by:
        with in interface AdvancedCache<K,​V>
        Overrides:
        with in class SimpleCacheImpl<K,​V>
        Returns:
        an AdvancedCache instance upon which operations can be called with a particular ClassLoader.

      • getCacheEntry

        public CacheEntry<K,​V> getCacheEntry​(Object k)
        Description copied from interface: AdvancedCache
        Retrieves a CacheEntry corresponding to a specific key.
        Specified by:
        getCacheEntry in interface AdvancedCache<K,​V>
        Overrides:
        getCacheEntry in class SimpleCacheImpl<K,​V>
        Parameters:
        k - 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

      • 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>
        Overrides:
        getAll in class SimpleCacheImpl<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.

      • 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>
        Overrides:
        getAllCacheEntries in class SimpleCacheImpl<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> entries)
        Description copied from interface: AdvancedCache
        Executes an equivalent of Map.putAll(Map), returning previous values of the modified entries.
        Parameters:
        entries - 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.

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

        Specified by:
        evict in interface Cache<K,​V>
        Overrides:
        evict in class SimpleCacheImpl<K,​V>
        Parameters:
        key - key to evict

      • 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 the Flag.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).
        Specified by:
        remove in interface org.infinispan.commons.api.BasicCache<K,​V>
        Specified by:
        remove in interface Map<K,​V>
        Overrides:
        remove in class SimpleCacheImpl<K,​V>