Class SharedBoundedLocalContainer<K,V>

java.lang.Object

org.infinispan.container.impl.AbstractInternalDataContainer<K,V>

org.infinispan.container.impl.DefaultDataContainer<K,V>

org.infinispan.container.impl.SharedBoundedLocalContainer<K,V>

Type Parameters:

K - The key type

V - The value type

All Implemented Interfaces:

Iterable<InternalCacheEntry<K,V>>, DataContainer<K,V>, EvictionListener<K,V>, InternalDataContainer<K,V>

public class SharedBoundedLocalContainer<K,V>
extends DefaultDataContainer<K,V>
implements EvictionListener<K,V>

A non-segmented shared container for use with simple/local caches. All entries are stored in the shared caffeine map, but indexed in the single entries map inherited from DefaultDataContainer.

This class avoids the DefaultSegmentedDataContainer array-based segment indexing which causes ArrayIndexOutOfBoundsException when callers pass segment sets larger than the container's single-segment array.

Write operations must be done while holding the lock for the corresponding key in the shared caffeine map, same as SharedBoundedContainer.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractInternalDataContainer

AbstractInternalDataContainer.EntryIterator

Nested classes/interfaces inherited from interface DataContainer

DataContainer.ComputeAction<K,V>

Field Summary

Fields inherited from class DefaultDataContainer

entries, evictionCache

Fields inherited from class AbstractInternalDataContainer

configuration, entryFactory, evictionManager, expirationManager, keyPartitioner, listeners, orderer, passivator, timeService

Constructor Summary

Constructors

Constructor	Description
SharedBoundedLocalContainer(PeekableTouchableCaffeineMap<K,V> caffeineMap)

Method Summary

Modifier and Type	Method	Description
long	capacity()	Returns the capacity of the underlying container.
void	cleanUp()	Method used to cleanup any pending data, such as evictions
void	clear()	Removes all entries in the container
void	clear(IntSet segments)	Removes entries from the container whose key maps to one of the provided segments
protected void	computeEntryRemoved(int segment, K key, InternalCacheEntry<K,V> value)	This method is invoked every time an entry is removed inside a compute block
protected void	computeEntryWritten(int segment, K key, InternalCacheEntry<K,V> value)	This method is invoked every time an entry is written inside a compute block
boolean	containsKey(Object k)	Tests whether an entry exists in the container
long	evictionSize()	Returns how large the eviction size is currently.
protected PeekableTouchableMap<K,V>	getMapForSegment(int segment)
protected int	getSegmentForKey(Object key)
void	onEntryChosenForEviction(boolean pre, K key, InternalCacheEntry<K,V> value)	Method invoked every time an entry is evicted from the cache along with its key.
InternalCacheEntry<K,V>	peek(Object k)	Retrieves a cache entry.
protected void	putEntryInMap(PeekableTouchableMap<K,V> map, int segment, K key, InternalCacheEntry<K,V> ice)
protected InternalCacheEntry<K,V>	removeEntryInMap(PeekableTouchableMap<K,V> map, int segment, Object key)
void	resize(long newSize)	Resizes the capacity of the underlying container.

Methods inherited from class DefaultDataContainer

addSegments, boundedDataContainer, boundedDataContainer, forEachSegment, iterator, iterator, iteratorIncludingExpired, iteratorIncludingExpired, publisher, removeSegments, sizeIncludingExpired, spliterator, spliterator, spliteratorIncludingExpired, spliteratorIncludingExpired, unBoundedDataContainer

Methods inherited from class AbstractInternalDataContainer

addRemovalListener, applyListener, compute, compute, containsKey, entryAdded, entryRemoved, entryUpdated, evict, evict, expiredIterationPredicate, filterExpiredEntries, get, get, handleEviction, hasExpirable, peek, put, put, remove, remove, removeRemovalListener, segmentRemoved, touch

Methods inherited from class Object

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

Methods inherited from interface DataContainer

size

Methods inherited from interface InternalDataContainer

forEach, publisher, size, sizeIncludingExpired

Methods inherited from interface Iterable

forEach

Constructor Details

SharedBoundedLocalContainer

public SharedBoundedLocalContainer(PeekableTouchableCaffeineMap<K,V> caffeineMap)

Method Details

getMapForSegment

protected PeekableTouchableMap<K,V> getMapForSegment(int segment)

Overrides:

getMapForSegment in class DefaultDataContainer<K,V>

getSegmentForKey

protected int getSegmentForKey(Object key)

Overrides:

getSegmentForKey in class DefaultDataContainer<K,V>

computeEntryRemoved

protected void computeEntryRemoved(int segment,
 K key,
 InternalCacheEntry<K,V> value)

Description copied from class: AbstractInternalDataContainer

This method is invoked every time an entry is removed inside a compute block

Overrides:

computeEntryRemoved in class AbstractInternalDataContainer<K,V>

Parameters:

segment - the segment for the key

key - key passed to compute method

value - the old value

computeEntryWritten

protected void computeEntryWritten(int segment,
 K key,
 InternalCacheEntry<K,V> value)

Description copied from class: AbstractInternalDataContainer

This method is invoked every time an entry is written inside a compute block

Overrides:

computeEntryWritten in class AbstractInternalDataContainer<K,V>

Parameters:

segment - the segment for the key

key - key passed to compute method

value - the new value

putEntryInMap

protected void putEntryInMap(PeekableTouchableMap<K,V> map,
 int segment,
 K key,
 InternalCacheEntry<K,V> ice)

Overrides:

putEntryInMap in class AbstractInternalDataContainer<K,V>

removeEntryInMap

protected InternalCacheEntry<K,V> removeEntryInMap(PeekableTouchableMap<K,V> map,
 int segment,
 Object key)

Overrides:

removeEntryInMap in class AbstractInternalDataContainer<K,V>

clear

public void clear()

Description copied from interface: DataContainer

Removes all entries in the container

Specified by:

clear in interface DataContainer<K,V>

Overrides:

clear in class DefaultDataContainer<K,V>

clear

public void clear(IntSet segments)

Description copied from interface: InternalDataContainer

Removes entries from the container whose key maps to one of the provided segments

Specified by:

clear in interface InternalDataContainer<K,V>

Overrides:

clear in class DefaultDataContainer<K,V>

Parameters:

segments - segments of entries to remove

peek

public InternalCacheEntry<K,V> peek(Object k)

Description copied from interface: DataContainer

Retrieves a cache entry. This method does not update or reorder any of the internal constructs. I.e., expiration does not happen, and in the case of the LRU container, the entry is not moved to the end of the chain.

Specified by:

peek in interface DataContainer<K,V>

Overrides:

peek in class AbstractInternalDataContainer<K,V>

Parameters:

k - key under which entry is stored

Returns:

entry, if it exists, or null if not

containsKey

public boolean containsKey(Object k)

Description copied from interface: DataContainer

Tests whether an entry exists in the container

Specified by:

containsKey in interface DataContainer<K,V>

Overrides:

containsKey in class AbstractInternalDataContainer<K,V>

Parameters:

k - key to test

Returns:

true if entry exists and has not expired; false otherwise

cleanUp

public void cleanUp()

Description copied from interface: InternalDataContainer

Method used to cleanup any pending data, such as evictions

Specified by:

cleanUp in interface InternalDataContainer<K,V>

Overrides:

cleanUp in class DefaultDataContainer<K,V>

capacity

public long capacity()

Description copied from interface: DataContainer

Returns the capacity of the underlying container. This is only supported if the container is bounded. An UnsupportedOperationException is thrown otherwise.

Specified by:

capacity in interface DataContainer<K,V>

Overrides:

capacity in class DefaultDataContainer<K,V>

Returns:

the capacity of a bounded container

resize

public void resize(long newSize)

Description copied from interface: DataContainer

Resizes the capacity of the underlying container. This is only supported if the container is bounded. An UnsupportedOperationException is thrown otherwise.

Specified by:

resize in interface DataContainer<K,V>

Overrides:

resize in class DefaultDataContainer<K,V>

Parameters:

newSize - the new size

evictionSize

public long evictionSize()

Description copied from interface: DataContainer

Returns how large the eviction size is currently. This is only supported if the container is bounded. An UnsupportedOperationException is thrown otherwise. This value will always be lower than the value returned from DataContainer.capacity()

Specified by:

evictionSize in interface DataContainer<K,V>

Overrides:

evictionSize in class DefaultDataContainer<K,V>

Returns:

how large the counted eviction is

onEntryChosenForEviction

public void onEntryChosenForEviction(boolean pre,
 K key,
 InternalCacheEntry<K,V> value)

Description copied from interface: EvictionListener

Method invoked every time an entry is evicted from the cache along with its key. Note that when the pre value is true the entry is still in the cache and the lock is held for this entry. When invoked with pre being false is after the fact without the lock held. If any exception is thrown during this invocation it is not deterministic if it will stop the operation and may only be logged.

Specified by:

onEntryChosenForEviction in interface EvictionListener<K,V>

Parameters:

pre - Whether this is just before the eviction completes or not.

key - The key tied the removed entry

value - The entry that is removed due to eviction