org.infinispan.persistence.spi

Interface AdvancedCacheLoader<K,V>

All Superinterfaces:

CacheLoader<K,V>, Lifecycle

All Known Subinterfaces:

AdvancedLoadWriteStore<K,V>, SegmentedAdvancedLoadWriteStore<K,V>

All Known Implementing Classes:

JdbcStringBasedStore, JpaStore, RemoteStore, RestStore, RocksDBStore, SingleFileStore, SoftIndexFileStore

@ThreadSafe
public interface AdvancedCacheLoader<K,V>
extends CacheLoader<K,V>

A specialised extension of the CacheLoader interface that allows processing parallel iteration over the existing entries.

Since:

6.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AdvancedCacheLoader.CacheLoaderTask<K,V> Deprecated. since 9.3 The process method is deprecated and thus this class shouldn't be in use any more
static interface	AdvancedCacheLoader.TaskContext Deprecated. since 9.3 The process method is no longer suggested and thus this class shouldn't be in use any more

Method Summary

Modifier and Type	Method and Description
default org.reactivestreams.Publisher<MarshallableEntry<K,V>>	entryPublisher(java.util.function.Predicate<? super K> filter, boolean fetchValue, boolean fetchMetadata) Publishes all entries from this store.
default void	process(KeyFilter<? super K> filter, AdvancedCacheLoader.CacheLoaderTask<K,V> task, java.util.concurrent.Executor executor, boolean fetchValue, boolean fetchMetadata) Deprecated. since 9.3 This is to be removed and replaced by publishEntries(Predicate, boolean, boolean)
default org.reactivestreams.Publisher<MarshalledEntry<K,V>>	publishEntries(java.util.function.Predicate<? super K> filter, boolean fetchValue, boolean fetchMetadata) Deprecated. since 10.0, please us entryPublisher(Predicate, boolean, boolean) instead.
default org.reactivestreams.Publisher<K>	publishKeys(java.util.function.Predicate<? super K> filter) Publishes all the keys from this store.
int	size() Returns the number of elements in the store.

Methods inherited from interface org.infinispan.persistence.spi.CacheLoader

contains, init, isAvailable, load, loadEntry

Methods inherited from interface org.infinispan.commons.api.Lifecycle

start, stop

Method Detail

process

@Deprecated
default void process(KeyFilter<? super K> filter,
                                 AdvancedCacheLoader.CacheLoaderTask<K,V> task,
                                 java.util.concurrent.Executor executor,
                                 boolean fetchValue,
                                 boolean fetchMetadata)

Deprecated. since 9.3 This is to be removed and replaced by publishEntries(Predicate, boolean, boolean)

Iterates in parallel over the entries in the storage using the threads from the executor pool. For each entry the CacheLoaderTask#processEntry(MarshalledEntry, TaskContext) is invoked. Before passing an entry to the callback task, the entry should be validated against the filter. Implementors should build an AdvancedCacheLoader.TaskContext instance (implementation) that is fed to the AdvancedCacheLoader.CacheLoaderTask on every invocation. The AdvancedCacheLoader.CacheLoaderTask might invoke AdvancedCacheLoader.TaskContext.stop() at any time, so implementors of this method should verify TaskContext's state for early termination of iteration. The method should only return once the iteration is complete or as soon as possible in the case TaskContext.stop() is invoked.

Parameters:

filter - to validate which entries should be feed into the task. Might be null.

task - callback to be invoked in parallel for each stored entry that passes the filter check

executor - an external thread pool to be used for parallel iteration

fetchValue - whether or not to fetch the value from the persistent store. E.g. if the iteration is intended only over the key set, no point fetching the values from the persistent store as well

fetchMetadata - whether or not to fetch the metadata from the persistent store. E.g. if the iteration is intended only ove the key set, then no pint fetching the metadata from the persistent store as well

Throws:

PersistenceException - in case of an error, e.g. communicating with the external storage

size

int size()

Returns the number of elements in the store.

Throws:

PersistenceException - in case of an error, e.g. communicating with the external storage

publishKeys

default org.reactivestreams.Publisher<K> publishKeys(java.util.function.Predicate<? super K> filter)

Publishes all the keys from this store. The given publisher can be used by as many Subscribers as desired. Keys are not retrieved until a given Subscriber requests them from the Subscription.

Stores will return only non expired keys

Parameters:

filter - a filter - null is treated as allowing all entries

Returns:

a publisher that will provide the keys from the store

publishEntries

@Deprecated
default org.reactivestreams.Publisher<MarshalledEntry<K,V>> publishEntries(java.util.function.Predicate<? super K> filter,
                                                                                       boolean fetchValue,
                                                                                       boolean fetchMetadata)

Deprecated. since 10.0, please us entryPublisher(Predicate, boolean, boolean) instead.

Publishes all entries from this store. The given publisher can be used by as many Subscribers as desired. Entries are not retrieved until a given Subscriber requests them from the Subscription.

If fetchMetadata is true this store must guarantee to not return any expired entries.

Parameters:

filter - a filter - null is treated as allowing all entries

fetchValue - whether or not to fetch the value from the persistent store. E.g. if the iteration is intended only over the key set, no point fetching the values from the persistent store as well

fetchMetadata - whether or not to fetch the metadata from the persistent store. E.g. if the iteration is intended only ove the key set, then no point fetching the metadata from the persistent store as well

Returns:

a publisher that will provide the entries from the store

entryPublisher

default org.reactivestreams.Publisher<MarshallableEntry<K,V>> entryPublisher(java.util.function.Predicate<? super K> filter,
                                                                             boolean fetchValue,
                                                                             boolean fetchMetadata)

Publishes all entries from this store. The given publisher can be used by as many Subscribers as desired. Entries are not retrieved until a given Subscriber requests them from the Subscription.

If fetchMetadata is true this store must guarantee to not return any expired entries.

Parameters:

filter - a filter - null is treated as allowing all entries

fetchValue - whether or not to fetch the value from the persistent store. E.g. if the iteration is intended only over the key set, no point fetching the values from the persistent store as well

fetchMetadata - whether or not to fetch the metadata from the persistent store. E.g. if the iteration is intended only ove the key set, then no point fetching the metadata from the persistent store as well

Returns:

a publisher that will provide the entries from the store