Package org.infinispan.container.impl

Class BoundedSegmentedDataContainer<K,V>

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public class BoundedSegmentedDataContainer<K,V>
extends DefaultSegmentedDataContainer<K,V>

Bounded implementation of segmented data container. Bulk operations (iterator|spliterator) that are given segments use the segments maps directly to only read the given segments (non segment based just read from bounded container).

Note this implementation supports both temporary non owned segments and not (L1). This map only utilizes heap based (ie. ConcurrentHashMap) maps internally

Since:

9.3

Author:

wburns

Nested Class Summary

Nested classes/interfaces inherited from class org.infinispan.container.impl.AbstractInternalDataContainer

AbstractInternalDataContainer.EntryIterator

Nested classes/interfaces inherited from interface org.infinispan.container.DataContainer

DataContainer.ComputeAction<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final PeekableTouchableMap<K,V>	entries
protected final com.github.benmanes.caffeine.cache.Cache<K,InternalCacheEntry<K,V>>	evictionCache

Fields inherited from class org.infinispan.container.impl.DefaultSegmentedDataContainer

maps, mapSupplier, shouldStopSegments

Fields inherited from class org.infinispan.container.impl.AbstractInternalDataContainer

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

Constructor Summary

Constructors

Constructor	Description
BoundedSegmentedDataContainer(int numSegments, long thresholdSize, EntrySizeCalculator<? super K,? super InternalCacheEntry<K,V>> sizeCalculator)
BoundedSegmentedDataContainer(int numSegments, long thresholdSize, EvictionType thresholdPolicy)

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)
protected void	computeEntryRemoved(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)
protected void	computeEntryWritten(K key, InternalCacheEntry<K,V> value)	This method is invoked every time an entry is written inside a compute block
long	evictionSize()	Returns how large the eviction size is currently.
PeekableTouchableMap<K,V>	getMapForSegment(int segment)
Iterator<InternalCacheEntry<K,V>>	iteratorIncludingExpired()	Same as DataContainer.iterator() except that is also returns expired entries.
Iterator<InternalCacheEntry<K,V>>	iteratorIncludingExpired(IntSet segments)	Same as DataContainer.iteratorIncludingExpired() except that only entries that map to the provided segments are returned via the iterator.
InternalCacheEntry<K,V>	peek(Object k)	Retrieves a cache entry in the same way as DataContainer.get(Object)} except that it does not update or reorder any of the internal constructs.
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	removeSegments(IntSet segments)	Removes and un-associates the given segments.
void	resize(long newSize)	Resizes the capacity of the underlying container.
int	sizeIncludingExpired()
Spliterator<InternalCacheEntry<K,V>>	spliteratorIncludingExpired()	Same as DataContainer.spliterator() except that is also returns expired entries.
Spliterator<InternalCacheEntry<K,V>>	spliteratorIncludingExpired(IntSet segments)	Same as DataContainer.spliteratorIncludingExpired() except that only entries that map to the provided segments are returned via this spliterator.

Methods inherited from class org.infinispan.container.impl.DefaultSegmentedDataContainer

addSegments, forEach, forEachSegment, getSegmentForKey, iterator, iterator, publisher, publisher, sizeIncludingExpired, spliterator, spliterator, start, stop

Methods inherited from class org.infinispan.container.impl.AbstractInternalDataContainer

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.container.DataContainer

size

Methods inherited from interface org.infinispan.container.impl.InternalDataContainer

size

Methods inherited from interface java.lang.Iterable

forEach

Field Details

evictionCache

protected final com.github.benmanes.caffeine.cache.Cache<K,InternalCacheEntry<K,V>> evictionCache

entries

protected final PeekableTouchableMap<K,V> entries

Constructor Details

BoundedSegmentedDataContainer

public BoundedSegmentedDataContainer(int numSegments,
 long thresholdSize,
 EvictionType thresholdPolicy)

BoundedSegmentedDataContainer

public BoundedSegmentedDataContainer(int numSegments,
 long thresholdSize,
 EntrySizeCalculator<? super K,? super InternalCacheEntry<K,V>> sizeCalculator)

Method Details

computeEntryWritten

protected void computeEntryWritten(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:

key - key passed to compute method

value - the new value

computeEntryWritten

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

computeEntryRemoved

protected void computeEntryRemoved(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:

key - key passed to compute method

value - the old value

computeEntryRemoved

protected void computeEntryRemoved(int segment,
 K key,
 InternalCacheEntry<K,V> 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>

getMapForSegment

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

Overrides:

getMapForSegment in class DefaultSegmentedDataContainer<K,V>

peek

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

Description copied from interface: DataContainer

Retrieves a cache entry in the same way as DataContainer.get(Object)} except that it 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.

This method should be used instead of DataContainer.get(Object)} when called while iterating through the data container using methods like DataContainer.iterator() to avoid changing the underlying collection's order.

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

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 DefaultSegmentedDataContainer<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 AbstractInternalDataContainer<K,V>

Parameters:

segments - segments of entries to remove

iteratorIncludingExpired

public Iterator<InternalCacheEntry<K,V>> iteratorIncludingExpired()

Description copied from interface: DataContainer

Same as DataContainer.iterator() except that is also returns expired entries.

Specified by:

iteratorIncludingExpired in interface DataContainer<K,V>

Overrides:

iteratorIncludingExpired in class DefaultSegmentedDataContainer<K,V>

Returns:

iterator that returns all entries including expired ones

iteratorIncludingExpired

public Iterator<InternalCacheEntry<K,V>> iteratorIncludingExpired(IntSet segments)

Description copied from interface: InternalDataContainer

Same as DataContainer.iteratorIncludingExpired() except that only entries that map to the provided segments are returned via the iterator. The iterator can return expired entries.

Specified by:

iteratorIncludingExpired in interface InternalDataContainer<K,V>

Overrides:

iteratorIncludingExpired in class DefaultSegmentedDataContainer<K,V>

Parameters:

segments - segments of entries to use

Returns:

iterator that returns all entries mapped to the given segments that could be expired

spliteratorIncludingExpired

public Spliterator<InternalCacheEntry<K,V>> spliteratorIncludingExpired()

Description copied from interface: DataContainer

Same as DataContainer.spliterator() except that is also returns expired entries.

Specified by:

spliteratorIncludingExpired in interface DataContainer<K,V>

Overrides:

spliteratorIncludingExpired in class DefaultSegmentedDataContainer<K,V>

Returns:

spliterator that returns all entries including expired ones

spliteratorIncludingExpired

public Spliterator<InternalCacheEntry<K,V>> spliteratorIncludingExpired(IntSet segments)

Description copied from interface: InternalDataContainer

Same as DataContainer.spliteratorIncludingExpired() except that only entries that map to the provided segments are returned via this spliterator. The spliterator will return expired entries as well.

Specified by:

spliteratorIncludingExpired in interface InternalDataContainer<K,V>

Overrides:

spliteratorIncludingExpired in class DefaultSegmentedDataContainer<K,V>

Parameters:

segments - segments of entries to use

Returns:

spliterator containing entries mapping to those segments that could be expired

sizeIncludingExpired

public int sizeIncludingExpired()

Specified by:

sizeIncludingExpired in interface DataContainer<K,V>

Overrides:

sizeIncludingExpired in class DefaultSegmentedDataContainer<K,V>

Returns:

count of the number of entries in the container including expired entries

removeSegments

public void removeSegments(IntSet segments)

Description copied from interface: InternalDataContainer

Removes and un-associates the given segments. This will notify any listeners registered via InternalDataContainer.addRemovalListener(Consumer) of entries that were removed due to no longer being associated with this container. There is no guarantee if the consumer is invoked once or multiple times for a given group of segments and could be in any order.

When this method is invoked an implementation is free to remove any entries that don't map to segments currently associated with this container. Note that entries that were removed due to their segments never being associated with this container do not notify listeners registered via InternalDataContainer.addRemovalListener(Consumer).

Specified by:

removeSegments in interface InternalDataContainer<K,V>

Overrides:

removeSegments in class DefaultSegmentedDataContainer<K,V>

Parameters:

segments - segments that should no longer be associated with this container

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.

Returns:

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.

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

Returns:

how large the counted eviction is

cleanUp

public void cleanUp()

Description copied from interface: InternalDataContainer

Method used to cleanup any pending data, such as evictions