org.infinispan.commons.api

Interface BasicCache<K,V>

All Superinterfaces:

AsyncCache<K,V>, ConcurrentMap<K,V>, Lifecycle, Map<K,V>

All Known Subinterfaces:

AdvancedCache<K,V>, Cache<K,V>, RemoteCache<K,V>, SecureCache<K,V>

All Known Implementing Classes:

AbstractDelegatingAdvancedCache, AbstractDelegatingAdvancedCache, AbstractDelegatingCache, AbstractDelegatingCache

public interface BasicCache<K,V>
extends AsyncCache<K,V>, ConcurrentMap<K,V>, Lifecycle

BasicCache provides the common building block for the two different types of caches that Infinispan provides: embedded and remote.

For convenience, BasicCache extends ConcurrentMap and implements all methods accordingly, although methods like Map.keySet(), Map.values() and Map.entrySet() are expensive (prohibitively so when using a distributed cache) and frequent use of these methods is not recommended.

Other methods such as Map.size() provide an approximation-only, and should not be relied on for an accurate picture as to the size of the entire, distributed cache. Remote nodes are not queried and in-fly transactions are not taken into account, even if Map.size() is invoked from within such a transaction.

Also, like many ConcurrentMap implementations, BasicCache does not support the use of null keys or values.

Unsupported operations

Map.containsValue(Object)

Please see the Infinispan documentation and/or the 5 Minute Usage Tutorial for more details.

Since:

5.1

Author:

Mircea.Markus@jboss.com, Manik Surtani, Galder Zamarreño, Tristan Tarrant

See Also:

CacheContainer, DefaultCacheManager, Infinispan documentation, 5 Minute Usage Tutorial

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Retrieves the name of the cache
String	getVersion() Retrieves the version of Infinispan
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 the Flag.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 of BasicCache.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 of BasicCache.put(Object, Object), which takes in lifespan parameters.
void	putAll(Map<? extends K,? extends V> map, long lifespan, TimeUnit unit) An overloaded form of Map.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 of Map.putAll(Map), which takes in lifespan parameters.
V	putIfAbsent(K key, V value, long lifespan, TimeUnit unit) An overloaded form of ConcurrentMap.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 of ConcurrentMap.putIfAbsent(Object, Object), which takes in lifespan parameters.
V	remove(Object key) 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.
V	replace(K key, V value, long lifespan, TimeUnit unit) An overloaded form of ConcurrentMap.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 of ConcurrentMap.replace(Object, Object), which takes in lifespan parameters.
boolean	replace(K key, V oldValue, V value, long lifespan, TimeUnit unit) An overloaded form of ConcurrentMap.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 of ConcurrentMap.replace(Object, Object, Object), which takes in lifespan parameters.

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

clearAsync, getAsync, putAllAsync, putAllAsync, putAllAsync, putAsync, putAsync, putAsync, putIfAbsentAsync, putIfAbsentAsync, putIfAbsentAsync, removeAsync, removeAsync, replaceAsync, replaceAsync, replaceAsync, replaceAsync, replaceAsync, replaceAsync

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

start, stop

Method Detail

getName

String getName()

Retrieves the name of the cache

Returns:

the name of the cache

getVersion

String getVersion()

Retrieves the version of Infinispan

Returns:

a version string

put

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

put

V put(K key,
    V value,
    long lifespan,
    TimeUnit unit)

An overloaded form of BasicCache.put(Object, Object), which takes in lifespan parameters.

Parameters:

key - key to use

value - value to store

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

putIfAbsent

V putIfAbsent(K key,
            V value,
            long lifespan,
            TimeUnit unit)

An overloaded form of ConcurrentMap.putIfAbsent(Object, Object), which takes in lifespan parameters.

Parameters:

key - key to use

value - value to store

lifespan - 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

void putAll(Map<? extends K,? extends V> map,
          long lifespan,
          TimeUnit unit)

An overloaded form of Map.putAll(Map), which takes in lifespan parameters. Note that the lifespan is applied to all mappings in the map passed in.

Parameters:

map - map containing mappings to enter

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

unit - unit of measurement for the lifespan

replace

V replace(K key,
        V value,
        long lifespan,
        TimeUnit unit)

An overloaded form of ConcurrentMap.replace(Object, Object), which takes in lifespan parameters.

Parameters:

key - key to use

value - value to store

lifespan - 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

boolean replace(K key,
              V oldValue,
              V value,
              long lifespan,
              TimeUnit unit)

An overloaded form of ConcurrentMap.replace(Object, Object, Object), which takes in lifespan parameters.

Parameters:

key - key to use

oldValue - value to replace

value - value to store

lifespan - 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

V put(K key,
    V value,
    long lifespan,
    TimeUnit lifespanUnit,
    long maxIdleTime,
    TimeUnit maxIdleTimeUnit)

An overloaded form of BasicCache.put(Object, Object), which takes in lifespan parameters.

Parameters:

key - key to use

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

lifespanUnit - time unit for lifespan

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

maxIdleTimeUnit - time unit for max idle time

Returns:

the value being replaced, or null if nothing is being replaced.

putIfAbsent

V putIfAbsent(K key,
            V value,
            long lifespan,
            TimeUnit lifespanUnit,
            long maxIdleTime,
            TimeUnit maxIdleTimeUnit)

An overloaded form of ConcurrentMap.putIfAbsent(Object, Object), which takes in lifespan parameters.

Parameters:

key - key to use

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

lifespanUnit - time unit for lifespan

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

maxIdleTimeUnit - time unit for max idle time

Returns:

the value being replaced, or null if nothing is being replaced.

putAll

void putAll(Map<? extends K,? extends V> map,
          long lifespan,
          TimeUnit lifespanUnit,
          long maxIdleTime,
          TimeUnit maxIdleTimeUnit)

An overloaded form of Map.putAll(Map), which takes in lifespan parameters. Note that the lifespan is applied to all mappings in the map passed in.

Parameters:

map - map containing mappings to enter

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

lifespanUnit - time unit for lifespan

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

maxIdleTimeUnit - time unit for max idle time

replace

V replace(K key,
        V value,
        long lifespan,
        TimeUnit lifespanUnit,
        long maxIdleTime,
        TimeUnit maxIdleTimeUnit)

An overloaded form of ConcurrentMap.replace(Object, Object), which takes in lifespan parameters.

Parameters:

key - key to use

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

lifespanUnit - time unit for lifespan

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

maxIdleTimeUnit - time unit for max idle time

Returns:

the value being replaced, or null if nothing is being replaced.

replace

boolean replace(K key,
              V oldValue,
              V value,
              long lifespan,
              TimeUnit lifespanUnit,
              long maxIdleTime,
              TimeUnit maxIdleTimeUnit)

An overloaded form of ConcurrentMap.replace(Object, Object, Object), which takes in lifespan parameters.

Parameters:

key - key to use

oldValue - value to replace

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

lifespanUnit - time unit for lifespan

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

maxIdleTimeUnit - time unit for max idle time

Returns:

true if the value was replaced, false otherwise

remove

V remove(Object key)

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