redis.clients.jedis.executors.aggregators

Class MultiNodeResultAggregator<T>

java.lang.Object

redis.clients.jedis.executors.aggregators.MultiNodeResultAggregator<T>

Type Parameters:

T - the type of the command result

@Internal
public final class MultiNodeResultAggregator<T>
extends java.lang.Object

Internal use only. Aggregates results from multiple node/shard executions based on response policy.

This class centralizes the logic for collecting results and errors from multi-node command execution (broadcast commands, multi-shard commands) and determining the final result based on the CommandFlagsRegistry.ResponsePolicy.

Key behavior differences by policy:

• ONE_SUCCEEDED: Returns success if at least one node succeeds, even if others fail. Only throws if ALL nodes fail.
• All other policies: Throws JedisBroadcastException if ANY node fails.

Constructor Summary

Constructors

Constructor and Description
MultiNodeResultAggregator(CommandFlagsRegistry.ResponsePolicy responsePolicy) Creates a new aggregator with the specified response policy.

Method Summary

Modifier and Type	Method and Description
void	addError(java.lang.Exception error) Records an error, extracting the node information from the exception if available.
void	addError(HostAndPort node, java.lang.Exception error) Records an error from a node.
void	addSuccess(HostAndPort node, T result) Records a successful result from a node.
void	addSuccess(T result) Records a successful result without node information.
CommandFlagsRegistry.ResponsePolicy	getResponsePolicy() Returns the response policy being used by this aggregator.
T	getResult() Returns the aggregated result based on the response policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiNodeResultAggregator

public MultiNodeResultAggregator(CommandFlagsRegistry.ResponsePolicy responsePolicy)

Creates a new aggregator with the specified response policy.

Parameters:

responsePolicy - the policy that determines how to aggregate results and handle errors

Method Detail

addSuccess

public void addSuccess(HostAndPort node,
                       T result)

Records a successful result from a node.

Parameters:

node - the node that returned the result

result - the result from the node

addSuccess

public void addSuccess(T result)

Records a successful result without node information.

Use this method when the node information is not readily available, such as in multi-shard commands where extracting the node would require additional computation.

Parameters:

result - the result from the operation

addError

public void addError(HostAndPort node,
                     java.lang.Exception error)

Records an error from a node.

Parameters:

node - the node that returned the error

error - the exception from the node

addError

public void addError(java.lang.Exception error)

Records an error, extracting the node information from the exception if available.

This method extracts node information from JedisClusterOperationException if present, otherwise uses a placeholder "unknown:0" node.

Parameters:

error - the exception from the failed operation

getResult

public T getResult()

Returns the aggregated result based on the response policy.

For ONE_SUCCEEDED policy: returns the aggregated result if at least one node succeeded, throws JedisBroadcastException only if all nodes failed.

For all other policies: throws JedisBroadcastException if any node failed, otherwise returns the aggregated result.

Returns:

the aggregated result

Throws:

JedisBroadcastException - if the policy criteria are not met

getResponsePolicy

public CommandFlagsRegistry.ResponsePolicy getResponsePolicy()

Returns the response policy being used by this aggregator.

Returns:

the response policy