org.infinispan.iteration.impl

Interface EntryRetriever<K,V>

All Known Implementing Classes:

DistributedEntryRetriever, LocalEntryRetriever

Deprecated.

Please use Collection.stream() method on either Cache.entrySet(), Cache.keySet() or Cache.values(). The CacheFilters can be used to bridge between filter/converters and proper stream types

public interface EntryRetriever<K,V>

Interface describing operations required to properly retrieve values for iteration.

Since:

7.0

Author:

wburns

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EntryRetriever.SegmentListener Deprecated. This interface describes the call back methods that are invoked when an iteration process completes segments and finally completes.

Method Summary

Modifier and Type	Method and Description
<C> void	receiveResponse(UUID identifier, Address origin, Set<Integer> completedSegments, Set<Integer> inDoubtSegments, Collection<CacheEntry<K,C>> entries, CacheException e) Deprecated. This method is invoked on the local node who started the iteration process for each batch of values.
<C> CloseableIterator<CacheEntry<K,C>>	retrieveEntries(KeyValueFilter<? super K,? super V> filter, Converter<? super K,? super V,? extends C> converter, Set<Flag> flags, EntryRetriever.SegmentListener listener) Deprecated. This is invoked locally on the node that requested the iteration process.
<C> void	startRetrievingValues(UUID identifier, Address origin, Set<Integer> segments, Set<K> keysToFilter, KeyValueFilter<? super K,? super V> filter, Converter<? super K,? super V,C> converter, Set<Flag> flagss) Deprecated. This method is intended to be ran remotely on a node who has segments that the values have been requested.

Method Detail

startRetrievingValues

<C> void startRetrievingValues(UUID identifier,
                               Address origin,
                               Set<Integer> segments,
                               Set<K> keysToFilter,
                               KeyValueFilter<? super K,? super V> filter,
                               Converter<? super K,? super V,C> converter,
                               Set<Flag> flagss)

Deprecated.

This method is intended to be ran remotely on a node who has segments that the values have been requested.

Type Parameters:

C - The resulting type of the Converter

Parameters:

identifier - The unique identifier of the iteration request

origin - The node that sent the iteration request

segments - The segments this node wants

keysToFilter - The keys to filter out (can be null)

filter - The filter to be applied to determine if a value should be used

converter - The converter to run on the values retrieved before returning

receiveResponse

<C> void receiveResponse(UUID identifier,
                         Address origin,
                         Set<Integer> completedSegments,
                         Set<Integer> inDoubtSegments,
                         Collection<CacheEntry<K,C>> entries,
                         CacheException e)

Deprecated.

This method is invoked on the local node who started the iteration process for each batch of values. When either completedSegments or inDoubtSegments is not empty (not both could be as well) then the iteration process on this node is complete.

Type Parameters:

C - The type of entries values sent back

Parameters:

identifier - The unique identifier of the iteration request

origin - The node where the response came from

completedSegments - Which segments have been completed

inDoubtSegments - Which segments are now in doubt due to a rehash

entries - The entries retrieved

e - If an exception handled while processing the data on the remote node

retrieveEntries

<C> CloseableIterator<CacheEntry<K,C>> retrieveEntries(KeyValueFilter<? super K,? super V> filter,
                                                       Converter<? super K,? super V,? extends C> converter,
                                                       Set<Flag> flags,
                                                       EntryRetriever.SegmentListener listener)

Deprecated.

This is invoked locally on the node that requested the iteration process. This method will return immediately with the iterator and will process the request asynchronously making more values available as they are received.

Type Parameters:

C - The type of the resulting values from the converter

Parameters:

filter - An optional filter that will be ran on each key/value to determine if it should be returned.

converter - An optional converter that will be ran on each key/value that will be returned to transform the value to a different value if desired

flags - An optional set of flags to modify behavior. For example Flag.CACHE_MODE_LOCAL will prevent the retriever from retrieving remote values and Flag.SKIP_CACHE_LOAD will prevent the retriever from getting values from the configured loader if present.

listener - An optional segment listener that can be used to tell the invoker when segments and the iteration process is completed

Returns:

An iterator that should be closed when done working it it, especially if not fully iterated over