Package org.opendaylight.controller.cluster.datastore.utils

Class RootScatterGather

java.lang.Object

org.opendaylight.controller.cluster.datastore.utils.RootScatterGather

public final class RootScatterGather
extends Object

Utility methods for dealing with datastore root ContainerNode with respect to module shards.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RootScatterGather.ShardContainer<T>

Method Summary

Modifier and Type	Method	Description
static @NonNull ContainerNode	castRootNode(NormalizedNode node)	Check whether a NormalizedNode represents a root container and return it cast to ContainerNode.
static @NonNull FluentFuture<Optional<NormalizedNode>>	gather(ActorUtils actorUtils, Stream<FluentFuture<Optional<NormalizedNode>>> readFutures)	Reconstruct root container from a set of constituents.
static <T> @NonNull Stream<RootScatterGather.ShardContainer<T>>	scatterAll(ContainerNode rootNode, Function<YangInstanceIdentifier.PathArgument,T> childToShard, Stream<T> allShards)
static <T> @NonNull Stream<RootScatterGather.ShardContainer<T>>	scatterTouched(ContainerNode rootNode, Function<YangInstanceIdentifier.PathArgument,T> childToShard)	Split root container into per-shard root containers.

Methods inherited from class java.lang.Object

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

Method Details

castRootNode

public static @NonNull ContainerNode castRootNode(NormalizedNode node)

Check whether a NormalizedNode represents a root container and return it cast to ContainerNode.

Parameters:

node - a normalized node

Returns:

node cast to ContainerNode

Throws:

NullPointerException - if node is null

IllegalArgumentException - if node is not a ContainerNode

gather

public static @NonNull FluentFuture<Optional<NormalizedNode>> gather(ActorUtils actorUtils,
 Stream<FluentFuture<Optional<NormalizedNode>>> readFutures)

Reconstruct root container from a set of constituents.

Parameters:

actorUtils - ActorUtils reference

readFutures - Consitutent read futures

Returns:

A composite future

scatterAll

public static <T>
@NonNull Stream<RootScatterGather.ShardContainer<T>> scatterAll(ContainerNode rootNode,
 Function<YangInstanceIdentifier.PathArgument,T> childToShard,
 Stream<T> allShards)

scatterTouched

public static <T>
@NonNull Stream<RootScatterGather.ShardContainer<T>> scatterTouched(ContainerNode rootNode,
 Function<YangInstanceIdentifier.PathArgument,T> childToShard)

Split root container into per-shard root containers.

Type Parameters:

T - Shard reference type

Parameters:

rootNode - Root container to be split up

childToShard - Mapping function from child YangInstanceIdentifier.PathArgument to shard reference

Returns:

Stream of RootScatterGather.ShardContainers, one for each touched shard