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:

Closeable, AutoCloseable, org.cache2k.AdvancedKeyValueSource<K,V>, org.cache2k.Cache<K,V>, CanCheckIntegrity, HeapCacheListener<K,V>, InternalCache<K,V>, StorageAdapter.Parent, org.cache2k.KeyValueSource<K,V>, org.cache2k.KeyValueStore<K,V>

Direct Known Subclasses:

IntWiredCache, LongWiredCache

public class WiredCache<K,V>
extends BaseCache<K,V>
implements StorageAdapter.Parent, HeapCacheListener<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

Nested Class Summary

Nested classes/interfaces inherited from interface org.cache2k.core.HeapCacheListener

HeapCacheListener.NoOperation<K,V>

Field Summary

Fields inherited from interface org.cache2k.core.HeapCacheListener

NO_OPERATION

Constructor Summary

Constructors

Constructor and Description
WiredCache()

Method Summary

Modifier and Type	Method and 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, Callable<V> callable)
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)
void	expireAt(K key, long _millis)
void	expireOrScheduleFinalExpireEvent(Entry<K,V> e)
V	get(K key)
Map<K,V>	getAll(Iterable<? extends K> keys) We need to deal with possible null values and exceptions.
org.cache2k.CacheManager	getCacheManager()
InternalClock	getClock() Time reference for the cache.
CommonMetrics	getCommonMetrics()
org.cache2k.CacheEntry<K,V>	getEntry(K key)
String	getEntryState(K key)
HeapCache	getHeapCache() For testing
InternalCacheInfo	getInfo() Generate cache statistics.
org.cache2k.configuration.CacheType	getKeyType()
InternalCacheInfo	getLatestInfo() Generate fresh statistics.
Log	getLog() used from the cache manager
String	getName()
StorageAdapter	getStorage()
int	getTotalEntryCount() This method is used for ConcurrentMapWrapper.size()
org.cache2k.configuration.CacheType	getValueType()
void	init()
<R> R	invoke(K key, org.cache2k.processor.EntryProcessor<K,V,R> entryProcessor)
boolean	isClosed()
boolean	isNullValuePermitted()
Iterator<org.cache2k.CacheEntry<K,V>>	iterator()
void	loadAll(Iterable<? extends K> _keys, org.cache2k.CacheOperationCompletionListener l)
void	lockAndRunForPurge(K key, PurgeableStorage.PurgeAction _action) Insert a cache entry for the given key and run action under the entry lock.
void	logAndCountInternalException(String s, Throwable t)
void	onEvictionFromHeap(Entry<K,V> e) Nothing done here.
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	prefetch(K key)
void	prefetchAll(Iterable<? extends K> _keys, org.cache2k.CacheOperationCompletionListener l)
void	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
boolean	putIfAbsent(K key, V value)
void	reloadAll(Iterable<? extends K> _keys, org.cache2k.CacheOperationCompletionListener l)
void	remove(K key)
boolean	removeIfEquals(K key, V value)
boolean	replace(K key, V _newValue)
boolean	replaceIfEquals(K key, V _oldValue, V _newValue)
void	resetStorage(StorageAdapter _from, StorageAdapter to) Change the storage implementation to another one or null for a disconnect
org.cache2k.CacheEntry<K,V>	returnCacheEntry(ExaminationEntry<K,V> e)
void	timerEventExpireEntry(Entry<K,V> e)
void	timerEventProbationTerminated(Entry<K,V> e)
void	timerEventRefresh(Entry<K,V> e)

Methods inherited from class org.cache2k.core.BaseCache

asMap, clearAndClose, closeCustomization, createCustomization, entries, execute, execute, execute, invokeAll, keys, nameQualifier, removeAll, removeAll, requestInterface, toString

Methods inherited from class java.lang.Object

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

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 InternalClock 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()

Specified by:

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

getKeyType

public org.cache2k.configuration.CacheType getKeyType()

Specified by:

getKeyType in interface InternalCache<K,V>

getValueType

public org.cache2k.configuration.CacheType getValueType()

Specified by:

getValueType in interface InternalCache<K,V>

getCacheManager

public org.cache2k.CacheManager getCacheManager()

Specified by:

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

computeIfAbsent

public V computeIfAbsent(K key,
                         Callable<V> callable)

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>

prefetch

public void prefetch(K key)

Specified by:

prefetch in interface org.cache2k.AdvancedKeyValueSource<K,V>

Specified by:

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

prefetchAll

public void prefetchAll(Iterable<? extends K> _keys,
                        org.cache2k.CacheOperationCompletionListener l)

Specified by:

prefetchAll in interface org.cache2k.AdvancedKeyValueSource<K,V>

Specified by:

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

Specified by:

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

putAll

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

Specified by:

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

Specified by:

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

remove

public void remove(K key)

Specified by:

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

Specified by:

remove in interface org.cache2k.KeyValueStore<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 void loadAll(Iterable<? extends K> _keys,
                    org.cache2k.CacheOperationCompletionListener l)

Specified by:

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

reloadAll

public void reloadAll(Iterable<? extends K> _keys,
                      org.cache2k.CacheOperationCompletionListener l)

Specified by:

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

expireAt

public void expireAt(K key,
                     long _millis)

Specified by:

expireAt in interface org.cache2k.Cache<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> 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:

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

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 int 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> entryProcessor)

Specified by:

invoke in interface org.cache2k.Cache<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>

getLatestInfo

public InternalCacheInfo getLatestInfo()

Description copied from interface: InternalCache

Generate fresh statistics. This version is used by internal 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:

getLatestInfo in interface InternalCache<K,V>

getInfo

public InternalCacheInfo getInfo()

Description copied from interface: InternalCache

Generate cache statistics. Some of the statistic values involve scanning portions of the cache content. To prevent system stress e.g. monitoring there is a the compute intensive parts will only be repeated if some time is passed.

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: CanCheckIntegrity

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 CanCheckIntegrity

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 Closeable

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>

resetStorage

public void resetStorage(StorageAdapter _from,
                         StorageAdapter to)

Description copied from interface: StorageAdapter.Parent

Change the storage implementation to another one or null for a disconnect

Specified by:

resetStorage in interface StorageAdapter.Parent

getStorage

public StorageAdapter getStorage()

Specified by:

getStorage in interface InternalCache<K,V>

Overrides:

getStorage in class BaseCache<K,V>

lockAndRunForPurge

public void lockAndRunForPurge(K key,
                               PurgeableStorage.PurgeAction _action)

Insert a cache entry for the given key and run action under the entry lock. If the cache entry has fresh data, we do not run the action. Called from storage. The entry referenced by the key is expired and will be purged.

onEvictionFromHeap

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

Nothing done here. Will notify the storage about eviction in some future version.

Specified by:

onEvictionFromHeap in interface HeapCacheListener<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)

Specified by:

timerEventExpireEntry in interface InternalCache<K,V>

expireOrScheduleFinalExpireEvent

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

Specified by:

expireOrScheduleFinalExpireEvent in interface InternalCache<K,V>

See Also:

HeapCache.expireOrScheduleFinalExpireEvent(Entry)

timerEventRefresh

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

Specified by:

timerEventRefresh in interface InternalCache<K,V>

timerEventProbationTerminated

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

Specified by:

timerEventProbationTerminated in interface InternalCache<K,V>