org.ehcache.core.spi.store.tiering

Interface AuthoritativeTier<K,V>

Type Parameters:

K - the key type

V - the value type

All Superinterfaces:

ConfigurationChangeSupport, Store<K,V>

public interface AuthoritativeTier<K,V>
extends Store<K,V>

Authoritative tier, that is the lower most tier of a multi tiered store.

By design this tier will always hold all the mappings contained in the Cache

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AuthoritativeTier.InvalidationValve Invalidation valve, that is the mechanism through which an AuthoritativeTier can request invalidations from the CachingTier.
static interface	AuthoritativeTier.Provider Service interface for providing AuthoritativeTier instances.

Nested classes/interfaces inherited from interface org.ehcache.core.spi.store.Store

Store.Configuration<K,V>, Store.ElementalProvider, Store.Iterator<T>, Store.PutStatus, Store.RemoveStatus, Store.ReplaceStatus, Store.ValueHolder<V>

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<? extends java.util.Map.Entry<? extends K,? extends Store.ValueHolder<V>>>	bulkComputeIfAbsentAndFault(java.lang.Iterable<? extends K> keys, java.util.function.Function<java.lang.Iterable<? extends K>,java.lang.Iterable<? extends java.util.Map.Entry<? extends K,? extends V>>> mappingFunction) Bulk method to compute a value for every key passed in the Iterable keys argument using the mappingFunction to compute the value.
Store.ValueHolder<V>	computeIfAbsentAndFault(K key, java.util.function.Function<? super K,? extends V> mappingFunction) Marks the mapping as not evictable and performs computeIfAbsent() atomically.
boolean	flush(K key, Store.ValueHolder<V> valueHolder) This marks a mapping as evictable again if it matches the Store.ValueHolder received.
Store.ValueHolder<V>	getAndFault(K key) Marks the mapping as not evictable and returns it atomically.
void	setInvalidationValve(AuthoritativeTier.InvalidationValve valve) Sets the AuthoritativeTier.InvalidationValve to be used by this AuthoritativeTier.

Methods inherited from interface org.ehcache.core.spi.store.Store

bulkCompute, bulkCompute, bulkComputeIfAbsent, clear, computeAndGet, computeIfAbsent, containsKey, get, getAndCompute, getAndPut, getAndRemove, getStoreEventSource, iterator, put, putIfAbsent, remove, remove, replace, replace

Methods inherited from interface org.ehcache.core.spi.store.ConfigurationChangeSupport

getConfigurationChangeListeners

Method Detail

getAndFault

Store.ValueHolder<V> getAndFault(K key)
                          throws org.ehcache.spi.resilience.StoreAccessException

Marks the mapping as not evictable and returns it atomically.

Returns:

the value holder

Throws:

org.ehcache.spi.resilience.StoreAccessException - if the mapping can't be retrieved or updated.

computeIfAbsentAndFault

Store.ValueHolder<V> computeIfAbsentAndFault(K key,
                                             java.util.function.Function<? super K,? extends V> mappingFunction)
                                      throws org.ehcache.spi.resilience.StoreAccessException

Marks the mapping as not evictable and performs computeIfAbsent() atomically.

Returns:

the value holder.

Throws:

org.ehcache.spi.resilience.StoreAccessException - if the mapping can't be retrieved or updated.

flush

boolean flush(K key,
              Store.ValueHolder<V> valueHolder)

This marks a mapping as evictable again if it matches the Store.ValueHolder received.

Returns:

true if a mapping exists for that key, the mapping was faulted, and the value of the ValueHolder is equal to the value of the mapping in the AuthoritativeTier, false otherwise

Throws:

java.lang.IllegalArgumentException - if the ValueHolder is not an instance from the CachingTier

setInvalidationValve

void setInvalidationValve(AuthoritativeTier.InvalidationValve valve)

Sets the AuthoritativeTier.InvalidationValve to be used by this AuthoritativeTier.

The invalidation valve provides a way for the AuthoritativeTier to force invalidation of CachingTier entries when that is required.

Parameters:

valve - the valve to use for triggering invalidations

bulkComputeIfAbsentAndFault

java.lang.Iterable<? extends java.util.Map.Entry<? extends K,? extends Store.ValueHolder<V>>> bulkComputeIfAbsentAndFault(java.lang.Iterable<? extends K> keys,
                                                                                                                          java.util.function.Function<java.lang.Iterable<? extends K>,java.lang.Iterable<? extends java.util.Map.Entry<? extends K,? extends V>>> mappingFunction)
                                                                                                                   throws org.ehcache.spi.resilience.StoreAccessException

Bulk method to compute a value for every key passed in the Iterable keys argument using the mappingFunction to compute the value.

The function takes an Iterable of Map.Entry key/value pairs, where each entry's value is its currently stored value for each key that is not mapped in the store. It is expected that the function should return an Iterable of Map.Entry key/value pairs containing an entry for each key that was passed to it.

Note: This method guarantees atomicity of computations for each individual key in keys. Implementations may choose to provide coarser grained atomicity.

Parameters:

keys - the keys to compute a new value for, if they're not in the store.

mappingFunction - the function that generates new values.

Returns:

a Map of key/value pairs for each key in keys to the previously missing value.

Throws:

org.ehcache.spi.resilience.StoreAccessException - when a failure occurs when accessing the store