org.elasticsearch.action.support.broadcast.node

Class TransportBroadcastByNodeAction<Request extends BroadcastRequest<Request>,Response extends BroadcastResponse,ShardOperationResult extends Streamable>

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.action.support.TransportAction<Request,Response>

org.elasticsearch.action.support.HandledTransportAction<Request,Response>

org.elasticsearch.action.support.broadcast.node.TransportBroadcastByNodeAction<Request,Response,ShardOperationResult>

Type Parameters:

Request - the underlying client request

Response - the response to the client request

ShardOperationResult - per-shard operation results

Direct Known Subclasses:

TransportClearIndicesCacheAction, TransportForceMergeAction, TransportIndicesSegmentsAction, TransportIndicesStatsAction, TransportRecoveryAction, TransportUpgradeAction, TransportUpgradeStatusAction

public abstract class TransportBroadcastByNodeAction<Request extends BroadcastRequest<Request>,Response extends BroadcastResponse,ShardOperationResult extends Streamable>
extends HandledTransportAction<Request,Response>

Abstraction for transporting aggregated shard-level operations in a single request (NodeRequest) per-node and executing the shard-level operations serially on the receiving node. Each shard-level operation can produce a result (ShardOperationResult), these per-node shard-level results are aggregated into a single result (BroadcastByNodeResponse) to the coordinating node. These per-node results are aggregated into a single result (Result) to the client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TransportBroadcastByNodeAction.AsyncAction
static class	TransportBroadcastByNodeAction.EmptyResult Can be used for implementations of shardOperation for which there is no shard-level return value.
class	TransportBroadcastByNodeAction.NodeRequest

Field Summary

Fields inherited from class org.elasticsearch.action.support.TransportAction

actionName, indexNameExpressionResolver, taskManager, threadPool

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
TransportBroadcastByNodeAction(Settings settings, java.lang.String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, java.util.function.Supplier<Request> request, java.lang.String executor)
TransportBroadcastByNodeAction(Settings settings, java.lang.String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, java.util.function.Supplier<Request> request, java.lang.String executor, boolean canTripCircuitBreaker)

Method Summary

Modifier and Type	Method and Description
protected abstract ClusterBlockException	checkGlobalBlock(ClusterState state, Request request) Executes a global block check before polling the cluster state.
protected abstract ClusterBlockException	checkRequestBlock(ClusterState state, Request request, java.lang.String[] concreteIndices) Executes a global request-level check before polling the cluster state.
protected void	doExecute(Request request, ActionListener<Response> listener)
protected void	doExecute(Task task, Request request, ActionListener<Response> listener)
protected abstract Response	newResponse(Request request, int totalShards, int successfulShards, int failedShards, java.util.List<ShardOperationResult> results, java.util.List<ShardOperationFailedException> shardFailures, ClusterState clusterState) Creates a new response to the underlying request.
protected abstract Request	readRequestFrom(StreamInput in) Deserialize a request from an input stream
protected abstract ShardOperationResult	readShardResult(StreamInput in) Deserialize a shard-level result from an input stream
protected abstract ShardOperationResult	shardOperation(Request request, ShardRouting shardRouting) Executes the shard-level operation.
protected abstract ShardsIterator	shards(ClusterState clusterState, Request request, java.lang.String[] concreteIndices) Determines the shards on which this operation will be executed on.

Methods inherited from class org.elasticsearch.action.support.TransportAction

execute, execute, execute, execute

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Constructor Detail

TransportBroadcastByNodeAction

public TransportBroadcastByNodeAction(Settings settings,
                                      java.lang.String actionName,
                                      ThreadPool threadPool,
                                      ClusterService clusterService,
                                      TransportService transportService,
                                      ActionFilters actionFilters,
                                      IndexNameExpressionResolver indexNameExpressionResolver,
                                      java.util.function.Supplier<Request> request,
                                      java.lang.String executor)

TransportBroadcastByNodeAction

public TransportBroadcastByNodeAction(Settings settings,
                                      java.lang.String actionName,
                                      ThreadPool threadPool,
                                      ClusterService clusterService,
                                      TransportService transportService,
                                      ActionFilters actionFilters,
                                      IndexNameExpressionResolver indexNameExpressionResolver,
                                      java.util.function.Supplier<Request> request,
                                      java.lang.String executor,
                                      boolean canTripCircuitBreaker)

Method Detail

readShardResult

protected abstract ShardOperationResult readShardResult(StreamInput in)
                                                 throws java.io.IOException

Deserialize a shard-level result from an input stream

Parameters:

in - input stream

Returns:

a deserialized shard-level result

Throws:

java.io.IOException

newResponse

protected abstract Response newResponse(Request request,
                                        int totalShards,
                                        int successfulShards,
                                        int failedShards,
                                        java.util.List<ShardOperationResult> results,
                                        java.util.List<ShardOperationFailedException> shardFailures,
                                        ClusterState clusterState)

Creates a new response to the underlying request.

Parameters:

request - the underlying request

totalShards - the total number of shards considered for execution of the operation

successfulShards - the total number of shards for which execution of the operation was successful

failedShards - the total number of shards for which execution of the operation failed

results - the per-node aggregated shard-level results

shardFailures - the exceptions corresponding to shard operationa failures

clusterState - the cluster state

Returns:

the response

readRequestFrom

protected abstract Request readRequestFrom(StreamInput in)
                                    throws java.io.IOException

Deserialize a request from an input stream

Parameters:

in - input stream

Returns:

a de-serialized request

Throws:

java.io.IOException

shardOperation

protected abstract ShardOperationResult shardOperation(Request request,
                                                       ShardRouting shardRouting)
                                                throws java.io.IOException

Executes the shard-level operation. This method is called once per shard serially on the receiving node.

Parameters:

request - the node-level request

shardRouting - the shard on which to execute the operation

Returns:

the result of the shard-level operation for the shard

Throws:

java.io.IOException

shards

protected abstract ShardsIterator shards(ClusterState clusterState,
                                         Request request,
                                         java.lang.String[] concreteIndices)

Determines the shards on which this operation will be executed on. The operation is executed once per shard.

Parameters:

clusterState - the cluster state

request - the underlying request

concreteIndices - the concrete indices on which to execute the operation

Returns:

the shards on which to execute the operation

checkGlobalBlock

protected abstract ClusterBlockException checkGlobalBlock(ClusterState state,
                                                          Request request)

Executes a global block check before polling the cluster state.

Parameters:

state - the cluster state

request - the underlying request

Returns:

a non-null exception if the operation is blocked

checkRequestBlock

protected abstract ClusterBlockException checkRequestBlock(ClusterState state,
                                                           Request request,
                                                           java.lang.String[] concreteIndices)

Executes a global request-level check before polling the cluster state.

Parameters:

state - the cluster state

request - the underlying request

concreteIndices - the concrete indices on which to execute the operation

Returns:

a non-null exception if the operation if blocked

doExecute

protected final void doExecute(Request request,
                               ActionListener<Response> listener)

Specified by:

doExecute in class TransportAction<Request extends BroadcastRequest<Request>,Response extends BroadcastResponse>

doExecute

protected void doExecute(Task task,
                         Request request,
                         ActionListener<Response> listener)

Overrides:

doExecute in class TransportAction<Request extends BroadcastRequest<Request>,Response extends BroadcastResponse>