Package org.cache2k.core

Class WiredCache<K,V>

java.lang.Object

org.cache2k.core.BaseCache<K,V>

org.cache2k.core.WiredCache<K,V>

All Implemented Interfaces:

AutoCloseable, org.cache2k.Cache<K,V>, InternalCache<K,V>, InternalCacheCloseContext, InternalEvictionListener<K,V>, TimerEventListener<K,V>, org.cache2k.DataAware<K,V>, org.cache2k.KeyValueSource<K,V>

public class WiredCache<K,V>
extends BaseCache<K,V>
implements InternalEvictionListener<K,V>

A cache implementation that builds on a heap cache and coordinates with additional attachments like storage, listeners and a writer.

Author:

Jens Wilke

Field Summary

Fields inherited from interface org.cache2k.core.eviction.InternalEvictionListener

NO_OPERATION

Constructor Summary

Constructors

Constructor	Description
WiredCache()

Method Summary

Modifier and Type	Method	Description
void	cancelTimerJobs()	used from the cache manager for shutdown
void	checkIntegrity()	Cache checks its internal integrity.
void	clear()
void	close()
V	computeIfAbsent(K key, Function<? super K,? extends V> function)
boolean	containsAndRemove(K key)
boolean	containsKey(K key)
protected <R> EntryAction<K,V,R>	createEntryAction(K key, Entry<K,V> e, Semantic<K,V,R> op)
protected <R> org.cache2k.core.WiredCache.MyEntryAction<R>	createFireAndForgetAction(Entry<K,V> e, Semantic<K,V,R> op)
V	get(K key)
Map<K,V>	getAll(Iterable<? extends K> requestedKeys)	This takes four different execution paths depending on cache setup and state: no loader and/or all data present in heap, async or async bulk, parallel single load, bulk load.
org.cache2k.CacheManager	getCacheManager()	The cache manager
org.cache2k.operation.TimeReference	getClock()	Time reference for the cache.
CommonMetrics	getCommonMetrics()
InternalCacheInfo	getConsistentInfo()	Generate fresh statistics within a global cache lock.
org.cache2k.CacheEntry<K,V>	getEntry(K key)
String	getEntryState(K key)
Eviction	getEviction()
Executor	getExecutor()
HeapCache	getHeapCache()	For testing
InternalCacheInfo	getInfo()	Return cache statistic counters.
org.cache2k.config.CacheType	getKeyType()
Log	getLog()	used from the cache manager
String	getName()	Designation of target for logging and exceptions.
long	getTotalEntryCount()	This method is used for ConcurrentMapWrapper.size()
org.cache2k.Cache<K,V>	getUserCache()	Cache used by user, eventually wrapped.
org.cache2k.config.CacheType	getValueType()
void	init()
<R> R	invoke(K key, org.cache2k.processor.EntryProcessor<K,V,R> processor)
<@Nullable R> Map<K,org.cache2k.processor.EntryProcessingResult<R>>	invokeAll(Iterable<? extends K> keys, org.cache2k.processor.EntryProcessor<K,V,@Nullable R> entryProcessor)
boolean	isClosed()
boolean	isLoaderPresent()
boolean	isNullValuePermitted()
boolean	isWeigherPresent()
Iterator<org.cache2k.CacheEntry<K,V>>	iterator()
CompletableFuture<Void>	loadAll(Iterable<? extends K> keys)
void	logAndCountInternalException(String s, Throwable t)
void	onEvictionFromHeap(Entry<K,V> e)	Calls eviction listeners.
V	peek(K key)
Map<K,V>	peekAll(Iterable<? extends K> keys)	We need to deal with possible null values and exceptions.
V	peekAndPut(K key, V value)
V	peekAndRemove(K key)
V	peekAndReplace(K key, V value)
org.cache2k.CacheEntry<K,V>	peekEntry(K key)
void	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
boolean	putIfAbsent(K key, V value)
CompletableFuture<Void>	reloadAll(Iterable<? extends K> keys)
void	remove(K key)
boolean	removeIfEquals(K key, V value)
boolean	replace(K key, V newValue)
boolean	replaceIfEquals(K key, V oldValue, V newValue)
org.cache2k.CacheEntry<K,V>	returnCacheEntry(ExaminationEntry<K,V> e)
void	timerEventExpireEntry(Entry<K,V> e, Object task)	If not expired yet, negate time to enforce time checks, schedule task for expiry otherwise.
void	timerEventProbationTerminated(Entry<K,V> e, Object task)
void	timerEventRefresh(Entry<K,V> e, Object task)	Starts a refresh operation or expires if no threads in the loader thread pool are available.

Methods inherited from class org.cache2k.core.BaseCache

asMap, closeCustomization, entries, execute, execute, expireAt, getQualifiedName, keys, removeAll, removeAll, requestInterface, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cache2k.Cache

mutate, mutateAll

Constructor Detail

WiredCache

public WiredCache()

Method Detail

getLog

public Log getLog()

Description copied from interface: InternalCache

used from the cache manager

Specified by:

getLog in interface InternalCache<K,V>

getHeapCache

public HeapCache getHeapCache()

For testing

getClock

public org.cache2k.operation.TimeReference getClock()

Description copied from interface: InternalCache

Time reference for the cache.

Specified by:

getClock in interface InternalCache<K,V>

isNullValuePermitted

public boolean isNullValuePermitted()

Specified by:

isNullValuePermitted in interface InternalCache<K,V>

getName

public String getName()

Description copied from interface: TimerEventListener

Designation of target for logging and exceptions.

Specified by:

getName in interface org.cache2k.Cache<K,V>

Specified by:

getName in interface InternalCacheCloseContext

Specified by:

getName in interface TimerEventListener<K,V>

getKeyType

public org.cache2k.config.CacheType getKeyType()

Specified by:

getKeyType in interface InternalCache<K,V>

getValueType

public org.cache2k.config.CacheType getValueType()

Specified by:

getValueType in interface InternalCache<K,V>

getCacheManager

public org.cache2k.CacheManager getCacheManager()

Description copied from interface: InternalCacheCloseContext

The cache manager

Specified by:

getCacheManager in interface org.cache2k.Cache<K,V>

Specified by:

getCacheManager in interface InternalCacheCloseContext

computeIfAbsent

public V computeIfAbsent(K key,
                         Function<? super K,? extends V> function)

Specified by:

computeIfAbsent in interface org.cache2k.Cache<K,V>

peekAndPut

public V peekAndPut(K key,
                    V value)

Specified by:

peekAndPut in interface org.cache2k.Cache<K,V>

peekAndRemove

public V peekAndRemove(K key)

Specified by:

peekAndRemove in interface org.cache2k.Cache<K,V>

peekAndReplace

public V peekAndReplace(K key,
                        V value)

Specified by:

peekAndReplace in interface org.cache2k.Cache<K,V>

peekEntry

public org.cache2k.CacheEntry<K,V> peekEntry(K key)

Specified by:

peekEntry in interface org.cache2k.Cache<K,V>

containsKey

public boolean containsKey(K key)

Specified by:

containsKey in interface org.cache2k.Cache<K,V>

putIfAbsent

public boolean putIfAbsent(K key,
                           V value)

Specified by:

putIfAbsent in interface org.cache2k.Cache<K,V>

put

public void put(K key,
                V value)

Specified by:

put in interface org.cache2k.Cache<K,V>

putAll

public void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface org.cache2k.Cache<K,V>

remove

public void remove(K key)

Specified by:

remove in interface org.cache2k.Cache<K,V>

removeIfEquals

public boolean removeIfEquals(K key,
                              V value)

Specified by:

removeIfEquals in interface org.cache2k.Cache<K,V>

containsAndRemove

public boolean containsAndRemove(K key)

Specified by:

containsAndRemove in interface org.cache2k.Cache<K,V>

replace

public boolean replace(K key,
                       V newValue)

Specified by:

replace in interface org.cache2k.Cache<K,V>

replaceIfEquals

public boolean replaceIfEquals(K key,
                               V oldValue,
                               V newValue)

Specified by:

replaceIfEquals in interface org.cache2k.Cache<K,V>

loadAll

public CompletableFuture<Void> loadAll(Iterable<? extends K> keys)

Specified by:

loadAll in interface org.cache2k.Cache<K,V>

reloadAll

public CompletableFuture<Void> reloadAll(Iterable<? extends K> keys)

Specified by:

reloadAll in interface org.cache2k.Cache<K,V>

createFireAndForgetAction

protected <R> org.cache2k.core.WiredCache.MyEntryAction<R> createFireAndForgetAction(Entry<K,V> e,
                                                                                     Semantic<K,V,R> op)

Specified by:

createFireAndForgetAction in class BaseCache<K,V>

getExecutor

public Executor getExecutor()

Specified by:

getExecutor in class BaseCache<K,V>

isWeigherPresent

public boolean isWeigherPresent()

Specified by:

isWeigherPresent in interface InternalCache<K,V>

isLoaderPresent

public boolean isLoaderPresent()

Specified by:

isLoaderPresent in interface InternalCache<K,V>

get

public V get(K key)

Specified by:

get in interface org.cache2k.Cache<K,V>

Specified by:

get in interface org.cache2k.KeyValueSource<K,V>

getAll

public Map<K,V> getAll(Iterable<? extends K> requestedKeys)

This takes four different execution paths depending on cache setup and state: no loader and/or all data present in heap, async or async bulk, parallel single load, bulk load.

Specified by:

getAll in interface org.cache2k.Cache<K,V>

getEntry

public org.cache2k.CacheEntry<K,V> getEntry(K key)

Specified by:

getEntry in interface org.cache2k.Cache<K,V>

getTotalEntryCount

public long getTotalEntryCount()

Description copied from interface: InternalCache

This method is used for ConcurrentMapWrapper.size()

Specified by:

getTotalEntryCount in interface InternalCache<K,V>

invoke

public <R> R invoke(K key,
                    org.cache2k.processor.EntryProcessor<K,V,R> processor)

Specified by:

invoke in interface org.cache2k.Cache<K,V>

invokeAll

public <@Nullable R> Map<K,org.cache2k.processor.EntryProcessingResult<R>> invokeAll(Iterable<? extends K> keys,
                                                                                           org.cache2k.processor.EntryProcessor<K,V,@Nullable R> entryProcessor)

Specified by:

invokeAll in interface org.cache2k.Cache<K,V>

Overrides:

invokeAll in class BaseCache<K,V>

iterator

public Iterator<org.cache2k.CacheEntry<K,V>> iterator()

Specified by:

iterator in class BaseCache<K,V>

peek

public V peek(K key)

Specified by:

peek in interface org.cache2k.Cache<K,V>

peekAll

public Map<K,V> peekAll(Iterable<? extends K> keys)

We need to deal with possible null values and exceptions. This is a simple placeholder implementation that covers it all by working on the entry.

Specified by:

peekAll in interface org.cache2k.Cache<K,V>

getConsistentInfo

public InternalCacheInfo getConsistentInfo()

Description copied from interface: InternalCache

Generate fresh statistics within a global cache lock. This version is used by internal consistency tests. This method is not intended to be called at high frequencies or for attaching monitoring or logging. Use the InternalCache.getInfo() method for requesting information for monitoring.

Specified by:

getConsistentInfo in interface InternalCache<K,V>

getInfo

public InternalCacheInfo getInfo()

Description copied from interface: InternalCache

Return cache statistic counters. This method is intended for regular statistics polling. No extensive locking is performed to extract a consistent set of counters.

Specified by:

getInfo in interface InternalCache<K,V>

getCommonMetrics

public CommonMetrics getCommonMetrics()

Specified by:

getCommonMetrics in interface InternalCache<K,V>

logAndCountInternalException

public void logAndCountInternalException(String s,
                                         Throwable t)

Specified by:

logAndCountInternalException in interface InternalCache<K,V>

checkIntegrity

public void checkIntegrity()

Description copied from interface: InternalCache

Cache checks its internal integrity. This is a expansive operation because it may traverse all cache entries. Used for testing.

Specified by:

checkIntegrity in interface InternalCache<K,V>

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.cache2k.Cache<K,V>

init

public void init()

cancelTimerJobs

public void cancelTimerJobs()

Description copied from interface: InternalCache

used from the cache manager for shutdown

Specified by:

cancelTimerJobs in interface InternalCache<K,V>

clear

public void clear()

Specified by:

clear in interface org.cache2k.Cache<K,V>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.cache2k.Cache<K,V>

returnCacheEntry

public org.cache2k.CacheEntry<K,V> returnCacheEntry(ExaminationEntry<K,V> e)

Specified by:

returnCacheEntry in interface InternalCache<K,V>

getEviction

public Eviction getEviction()

Specified by:

getEviction in interface InternalCache<K,V>

onEvictionFromHeap

public void onEvictionFromHeap(Entry<K,V> e)

Calls eviction listeners.

Specified by:

onEvictionFromHeap in interface InternalEvictionListener<K,V>

createEntryAction

protected <R> EntryAction<K,V,R> createEntryAction(K key,
                                                               Entry<K,V> e,
                                                               Semantic<K,V,R> op)

Specified by:

createEntryAction in class BaseCache<K,V>

getEntryState

public String getEntryState(K key)

Specified by:

getEntryState in interface InternalCache<K,V>

timerEventExpireEntry

public void timerEventExpireEntry(Entry<K,V> e,
                                  Object task)

If not expired yet, negate time to enforce time checks, schedule task for expiry otherwise. Semantics double with HeapCache.timerEventExpireEntry(Entry, Object)

Specified by:

timerEventExpireEntry in interface TimerEventListener<K,V>

task - timer task as returned by Entry.getTask() to check whether the timer task is still valid after we obtained the entry lock

timerEventRefresh

public void timerEventRefresh(Entry<K,V> e,
                              Object task)

Starts a refresh operation or expires if no threads in the loader thread pool are available. If no async loader is available we execute the synchronous loader via the loader thread pool.

Specified by:

timerEventRefresh in interface TimerEventListener<K,V>

Parameters:

e - see TimerEventListener.timerEventExpireEntry(Entry, Object)

task - see TimerEventListener.timerEventExpireEntry(Entry, Object)

timerEventProbationTerminated

public void timerEventProbationTerminated(Entry<K,V> e,
                                          Object task)

Specified by:

timerEventProbationTerminated in interface TimerEventListener<K,V>

Parameters:

e - see TimerEventListener.timerEventExpireEntry(Entry, Object)

task - see TimerEventListener.timerEventExpireEntry(Entry, Object)

getUserCache

public org.cache2k.Cache<K,V> getUserCache()

Description copied from interface: InternalCache

Cache used by user, eventually wrapped. We only need to know our "wrapped self" in case events are send, so only implemented by WiredCache.

Specified by:

getUserCache in interface InternalCache<K,V>