Module org.elasticsearch.server

Package org.elasticsearch.action.support.broadcast.node

Class TransportBroadcastByNodeAction<Request extends BroadcastRequest<Request>,Response extends BaseBroadcastResponse,ShardOperationResult extends Writeable,NodeContext>

java.lang.Object

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

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

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

Type Parameters:

Request - the underlying client request

Response - the response to the client request

ShardOperationResult - per-shard operation results

NodeContext - an (optional) node context created by createNodeContext() on each node and passed to each call to shardOperation(Request, org.elasticsearch.cluster.routing.ShardRouting, org.elasticsearch.tasks.Task, NodeContext, org.elasticsearch.action.ActionListener<ShardOperationResult>)

Direct Known Subclasses:

TransportClearIndicesCacheAction, TransportFieldUsageAction, TransportForceMergeAction, TransportIndicesSegmentsAction, TransportIndicesStatsAction, TransportRecoveryAction, TransportReloadAnalyzersAction

public abstract class TransportBroadcastByNodeAction<Request extends BroadcastRequest<Request>,Response extends BaseBroadcastResponse,ShardOperationResult extends Writeable,NodeContext>
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	Description
static final class	TransportBroadcastByNodeAction.EmptyResult	Can be used for implementations of shardOperation(Request, org.elasticsearch.cluster.routing.ShardRouting, org.elasticsearch.tasks.Task, NodeContext, org.elasticsearch.action.ActionListener<ShardOperationResult>) for which there is no shard-level return value.
class	TransportBroadcastByNodeAction.NodeResponse
static interface	TransportBroadcastByNodeAction.ResponseFactory<Response,ShardOperationResult>

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClusterService	clusterService
protected final IndexNameExpressionResolver	indexNameExpressionResolver
protected final TransportService	transportService

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

actionName, taskManager

Constructor Summary

Constructors

Constructor	Description
TransportBroadcastByNodeAction(String actionName, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Writeable.Reader<Request> request, Executor executor)
TransportBroadcastByNodeAction(String actionName, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Writeable.Reader<Request> request, Executor executor, boolean canTripCircuitBreaker)

Method Summary

Modifier and Type	Method	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, String[] concreteIndices)	Executes a global request-level check before polling the cluster state.
protected NodeContext	createNodeContext()
protected void	doExecute(Task task, Request request, ActionListener<Response> listener)
protected abstract TransportBroadcastByNodeAction.ResponseFactory<Response,ShardOperationResult>	getResponseFactory(Request request, ClusterState clusterState)	Create a response factory based on the requst and the cluster state captured at the time the request was handled.
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 String[]	resolveConcreteIndexNames(ClusterState clusterState, Request request)	Resolves a list of concrete index names.
protected abstract void	shardOperation(Request request, ShardRouting shardRouting, Task task, NodeContext nodeContext, ActionListener<ShardOperationResult> listener)	Executes the shard-level operation.
protected abstract ShardsIterator	shards(ClusterState clusterState, Request request, String[] concreteIndices)	Determines the shards on which this operation will be executed on.

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

execute, executeDirect, localOnly

Methods inherited from class java.lang.Object

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

Field Details

clusterService

protected final ClusterService clusterService

transportService

protected final TransportService transportService

indexNameExpressionResolver

protected final IndexNameExpressionResolver indexNameExpressionResolver

Constructor Details

TransportBroadcastByNodeAction

public TransportBroadcastByNodeAction(String actionName,
 ClusterService clusterService,
 TransportService transportService,
 ActionFilters actionFilters,
 IndexNameExpressionResolver indexNameExpressionResolver,
 Writeable.Reader<Request> request,
 Executor executor)

TransportBroadcastByNodeAction

public TransportBroadcastByNodeAction(String actionName,
 ClusterService clusterService,
 TransportService transportService,
 ActionFilters actionFilters,
 IndexNameExpressionResolver indexNameExpressionResolver,
 Writeable.Reader<Request> request,
 Executor executor,
 boolean canTripCircuitBreaker)

Method Details

readShardResult

protected abstract ShardOperationResult readShardResult(StreamInput in)
                                                 throws IOException

Deserialize a shard-level result from an input stream

Parameters:

in - input stream

Returns:

a deserialized shard-level result

Throws:

IOException

getResponseFactory

protected abstract TransportBroadcastByNodeAction.ResponseFactory<Response,ShardOperationResult> getResponseFactory(Request request,
 ClusterState clusterState)

Create a response factory based on the requst and the cluster state captured at the time the request was handled. Implementations must avoid capturing the full cluster state if possible.

readRequestFrom

protected abstract Request readRequestFrom(StreamInput in)
                                    throws IOException

Deserialize a request from an input stream

Parameters:

in - input stream

Returns:

a de-serialized request

Throws:

IOException

shardOperation

protected abstract void shardOperation(Request request,
 ShardRouting shardRouting,
 Task task,
 @Nullable
 NodeContext nodeContext,
 ActionListener<ShardOperationResult> listener)

Executes the shard-level operation. This method is called once per shard serially on the receiving node. This method should not throw an exception, but pass the exception to the listener instead.

Parameters:

request - the node-level request

shardRouting - the shard on which to execute the operation

task - the task for this node-level request

nodeContext - the context created by {createNodeContext()}

listener - the listener to notify with the result of the shard-level operation

createNodeContext

@Nullable
protected NodeContext createNodeContext()

Returns:

an (optional) node-level context for this operation, passed to each call to shardOperation(Request, org.elasticsearch.cluster.routing.ShardRouting, org.elasticsearch.tasks.Task, NodeContext, org.elasticsearch.action.ActionListener<ShardOperationResult>).

shards

protected abstract ShardsIterator shards(ClusterState clusterState,
 Request request,
 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,
 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

resolveConcreteIndexNames

protected String[] resolveConcreteIndexNames(ClusterState clusterState,
 Request request)

Resolves a list of concrete index names. Override this if index names should be resolved differently than normal.

Parameters:

clusterState - the cluster state

request - the underlying request

Returns:

a list of concrete index names that this action should operate on

doExecute

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

Specified by:

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