Class CachePublisherImpl<K,V>

java.lang.Object
org.infinispan.cache.impl.CachePublisherImpl<K,V>
All Implemented Interfaces:
CachePublisher<K,V>
public class CachePublisherImpl<K,V> extends Object implements CachePublisher<K,V>

  • Constructor Details

    • CachePublisherImpl

      public CachePublisherImpl(CacheImpl<K,V> cache, long flags)

    • CachePublisherImpl

      public CachePublisherImpl(ClusterPublisherManager<K,V> clusterPublisherManager)

  • Method Details

    • parallelReduction

      public CachePublisher<K,V> parallelReduction()
      Description copied from interface: CachePublisher
      Configures reduction methods to operate in parallel across nodes. This only affects methods like CachePublisher.entryReduction(Function, Function) and CachePublisher.keyReduction(Function, Function). The CachePublisher.entryPublisher(Function) and CachePublisher.keyPublisher(SerializableFunction) are not affected by this setting. Defaults to sequential.

      Care should be taken when setting this as it may cause adverse performance in some use cases.

      Specified by:
      parallelReduction in interface CachePublisher<K,V>
      Returns:
      a publisher that will perform reduction methods in parallel

    • sequentialReduction

      public CachePublisher<K,V> sequentialReduction()
      Description copied from interface: CachePublisher
      Configures reduction methods to operate in sequential across nodes. This only affects methods like CachePublisher.entryReduction(Function, Function) and CachePublisher.keyReduction(Function, Function). The CachePublisher.entryPublisher(Function) and CachePublisher.keyPublisher(SerializableFunction) are not affected by this setting. Defaults to sequential.
      Specified by:
      sequentialReduction in interface CachePublisher<K,V>
      Returns:
      a publisher that will perform reduction methods in sequential

    • batchSize

      public CachePublisher<K,V> batchSize(int batchSize)
      Description copied from interface: CachePublisher
      Configures publisher methods chunk size when retrieving remote values. This only affects methods like CachePublisher.entryPublisher(Function) and CachePublisher.keyPublisher(Function). The CachePublisher.entryReduction(Function, Function) and CachePublisher.keyReduction(Function, Function) methods are unaffected. Defaults to the cache's configured StateTransferConfiguration.chunkSize().
      Specified by:
      batchSize in interface CachePublisher<K,V>
      Parameters:
      batchSize - the size of the batch to use when retrieving remote entries
      Returns:
      a publisher that will perform publish methods with the given batch size

    • withKeys

      public CachePublisher<K,V> withKeys(Set<? extends K> keys)
      Description copied from interface: CachePublisher
      Configures the publisher to only publish keys or values that map to the given keys in the provided Set. Defaults to "all" keys, which can be done by invoking CachePublisher.withAllKeys().

      Note that if this and CachePublisher.withSegments(IntSet) are both used, then a key is only returned if it is also maps to a provided segment.

      Specified by:
      withKeys in interface CachePublisher<K,V>
      Parameters:
      keys - set of keys that should only be used
      Returns:
      a publisher that will filter published values based on the given keys

    • withAllKeys

      public CachePublisher<K,V> withAllKeys()
      Description copied from interface: CachePublisher
      Configures a publisher to publish all keys or values, overriding if CachePublisher.withKeys(Set) was invoked.
      Specified by:
      withAllKeys in interface CachePublisher<K,V>
      Returns:
      a publisher that will return all keys or values.

    • withSegments

      public CachePublisher<K,V> withSegments(IntSet segments)
      Description copied from interface: CachePublisher
      Configures the publisher to only publish keys or values that map to a given segment in the provided IntSet. The IntSets is recommended to be used. Defaults to "all" segments.

      Note that if this and CachePublisher.withKeys(Set) are both used, then a key is only returned if it is also maps to a provided segment.

      Specified by:
      withSegments in interface CachePublisher<K,V>
      Parameters:
      segments - determines what entries should be evaluated by only using ones that map to the given segments
      Returns:
      a publisher that will filter published values based on the given segments

    • withAllSegments

      public CachePublisher<K,V> withAllSegments()
      Description copied from interface: CachePublisher
      Configures the publisher to publish value(s) irrespective of their mapped segment. Defaults to "all" segments.
      Specified by:
      withAllSegments in interface CachePublisher<K,V>
      Returns:
      a publisher that will publish all items irrespective of its segment

    • atMostOnce

      public CachePublisher<K,V> atMostOnce()
      Description copied from interface: CachePublisher
      Allows the caller to configure what level of consistency is required when retrieving data. At most is the weakest guarantee which ensures that data in a segment will be read once in a stable topology, but if there is a concurrent topology update a given segment or a portion of its data may not be returned.

      The default data consistency is CachePublisher.exactlyOnce().

      Specified by:
      atMostOnce in interface CachePublisher<K,V>

    • atLeastOnce

      public CachePublisher<K,V> atLeastOnce()
      Description copied from interface: CachePublisher
      Allows the caller to configure what level of consistency is required when retrieving data. At least ensures that data in a segment will be read once in a stable topology, but if there is a concurrent topology update a given segment or a portion of its data may be returned multiple times.

      The default data consistency is CachePublisher.exactlyOnce().

      Specified by:
      atLeastOnce in interface CachePublisher<K,V>
      Returns:
      a publisher that will provide at least once data semantics

    • exactlyOnce

      public CachePublisher<K,V> exactlyOnce()
      Description copied from interface: CachePublisher
      Allows the caller to configure what level of consistency is required when retrieving data. Exactly once ensures the highest level of guarantee so that even under a topology all data is returned once.

      Exactly once is the default data consistency level.

      Specified by:
      exactlyOnce in interface CachePublisher<K,V>
      Returns:
      a publisher that will provide exactly once data semantics

    • keyReduction

      public <R> CompletionStage<R> keyReduction(Function<? super org.reactivestreams.Publisher<K>, ? extends CompletionStage<R>> transformer, Function<? super org.reactivestreams.Publisher<R>, ? extends CompletionStage<R>> finalizer)
      Description copied from interface: CachePublisher
      Same as CachePublisher.entryReduction(Function, Function) except that the source publisher provided to the transformer is made up of keys only.
      Specified by:
      keyReduction in interface CachePublisher<K,V>
      Type Parameters:
      R - return value type
      Returns:
      CompletionStage that contains the resulting value when complete

    • keyReduction

      public <R> CompletionStage<R> keyReduction(SerializableFunction<? super org.reactivestreams.Publisher<K>, ? extends CompletionStage<R>> transformer, SerializableFunction<? super org.reactivestreams.Publisher<R>, ? extends CompletionStage<R>> finalizer)
      Description copied from interface: CachePublisher
      Same as CachePublisher.keyReduction(Function, Function) except that the Functions must also implement Serializable.

      The compiler will pick this overload for lambda parameters, making them Serializable.

      Specified by:
      keyReduction in interface CachePublisher<K,V>
      Type Parameters:
      R - return value type
      Returns:
      CompletionStage that contains the resulting value when complete

    • entryReduction

      public <R> CompletionStage<R> entryReduction(Function<? super org.reactivestreams.Publisher<CacheEntry<K,V>>, ? extends CompletionStage<R>> transformer, Function<? super org.reactivestreams.Publisher<R>, ? extends CompletionStage<R>> finalizer)
      Description copied from interface: CachePublisher
      Performs the given transformer and finalizer on data in the cache, resulting in a single value. Depending on the deliveryGuarantee the transformer may be invoked 1..numSegments times. It could be that the transformer is invoked for every segment and produces a result. All of these results are then fed into the finalizer to produce a final result. If publisher is parallel the finalizer will be invoked on each node to ensure there is only a single result per node.

      If the provided transformer internally uses a reduction with a default value, that value must be its identity value. This is the same as can be seen at Stream.reduce(Object, BinaryOperator). Then as long as the finalizer can handle the identity value it will be properly reduced.

      Specified by:
      entryReduction in interface CachePublisher<K,V>
      Type Parameters:
      R - return value type
      Parameters:
      transformer - reduces the given publisher of data eventually into a single value.
      finalizer - reduces all the single values produced by the transformer or this finalizer into one final value.
      Returns:
      CompletionStage that contains the resulting value when complete

    • entryReduction

      public <R> CompletionStage<R> entryReduction(SerializableFunction<? super org.reactivestreams.Publisher<CacheEntry<K,V>>, ? extends CompletionStage<R>> transformer, SerializableFunction<? super org.reactivestreams.Publisher<R>, ? extends CompletionStage<R>> finalizer)
      Description copied from interface: CachePublisher
      Same as CachePublisher.entryReduction(Function, Function) except that the Functions must also implement Serializable.

      The compiler will pick this overload for lambda parameters, making them Serializable.

      Specified by:
      entryReduction in interface CachePublisher<K,V>
      Type Parameters:
      R - return value type
      Parameters:
      transformer - reduces the given publisher of data eventually into a single value.
      finalizer - reduces all the single values produced by the transformer or this finalizer into one final value.
      Returns:
      CompletionStage that contains the resulting value when complete

    • keyPublisher

      public <R> SegmentPublisherSupplier<R> keyPublisher(Function<? super org.reactivestreams.Publisher<K>, ? extends org.reactivestreams.Publisher<R>> transformer)
      Description copied from interface: CachePublisher
      Same as CachePublisher.entryPublisher(Function) except that the source publisher provided to the transformer is made up of keys only.
      Specified by:
      keyPublisher in interface CachePublisher<K,V>
      Type Parameters:
      R - return value type
      Returns:
      Publisher that when subscribed to will return the results and notify of segment completion if necessary

    • keyPublisher

      public <R> SegmentPublisherSupplier<R> keyPublisher(SerializableFunction<? super org.reactivestreams.Publisher<K>, ? extends org.reactivestreams.Publisher<R>> transformer)
      Description copied from interface: CachePublisher
      Same as CachePublisher.keyPublisher(Function) except that the Function must also implement Serializable.

      The compiler will pick this overload for lambda parameters, making them Serializable.

      Specified by:
      keyPublisher in interface CachePublisher<K,V>
      Type Parameters:
      R - return value type
      Returns:
      Publisher that when subscribed to will return the results and notify of segment completion if necessary

    • entryPublisher

      public <R> SegmentPublisherSupplier<R> entryPublisher(Function<? super org.reactivestreams.Publisher<CacheEntry<K,V>>, ? extends org.reactivestreams.Publisher<R>> transformer)
      Description copied from interface: CachePublisher
      Performs the given transformer on data in the cache, resulting in multiple values. If a single value is desired, the user should use CachePublisher.entryReduction(Function, Function) instead as it can optimize some things. Depending on the deliveryGuarantee the transformer may be invoked 1..numSegments times per node. Results from a given node will retrieve values up to batchSize values until some are consumed.

      For example when using RxJava and using an intermediate operation such as Flowable.switchIfEmpty(Publisher) this can add elements if the given Publisher is empty, and it is very possible that a segment may not have entries and therefore may add the elements the switched Publisher returns multiple times.

      Methods that add elements to the returned Publisher are fine as long as they are tied to a specific entry, for example Flowable.flatMap(io.reactivex.rxjava3.functions.Function) which can reproduce the same elements when provided the same input entry from the cache.

      Specified by:
      entryPublisher in interface CachePublisher<K,V>
      Type Parameters:
      R - return value type
      Parameters:
      transformer - transform the given stream of data into something else (requires non null)
      Returns:
      Publisher that when subscribed to will return the results and notify of segment completion if necessary

    • entryPublisher

      public <R> SegmentPublisherSupplier<R> entryPublisher(SerializableFunction<? super org.reactivestreams.Publisher<CacheEntry<K,V>>, ? extends org.reactivestreams.Publisher<R>> transformer)
      Description copied from interface: CachePublisher
      Same as CachePublisher.entryPublisher(Function) except that the Function must also implement Serializable.

      The compiler will pick this overload for lambda parameters, making them Serializable.

      Specified by:
      entryPublisher in interface CachePublisher<K,V>
      Type Parameters:
      R - return value type
      Parameters:
      transformer - transform the given stream of data into something else (requires non null)
      Returns:
      Publisher that when subscribed to will return the results and notify of segment completion if necessary