org.elasticsearch.action.support.replication

Class TransportBroadcastReplicationAction<Request extends BroadcastRequest<Request>,Response extends BroadcastResponse,ShardRequest extends ReplicationRequest<ShardRequest>,ShardResponse extends ReplicationResponse>

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.replication.TransportBroadcastReplicationAction<Request,Response,ShardRequest,ShardResponse>

Direct Known Subclasses:

TransportFlushAction, TransportRefreshAction

public abstract class TransportBroadcastReplicationAction<Request extends BroadcastRequest<Request>,Response extends BroadcastResponse,ShardRequest extends ReplicationRequest<ShardRequest>,ShardResponse extends ReplicationResponse>
extends HandledTransportAction<Request,Response>

Base class for requests that should be executed on all shards of an index or several indices. This action sends shard requests to all primary shards of the indices and they are then replicated like write requests

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
TransportBroadcastReplicationAction(java.lang.String name, java.util.function.Supplier<Request> request, Settings settings, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, TransportReplicationAction replicatedBroadcastShardAction)

Method Summary

Modifier and Type	Method and Description
protected void	doExecute(Request request, ActionListener<Response> listener)
protected void	doExecute(Task task, Request request, ActionListener<Response> listener)
protected abstract BroadcastResponse	newResponse(int successfulShards, int failedShards, int totalNumCopies, java.util.List<ShardOperationFailedException> shardFailures)
protected abstract ShardRequest	newShardRequest(Request request, ShardId shardId)
protected abstract ShardResponse	newShardResponse()
protected void	shardExecute(Task task, Request request, ShardId shardId, ActionListener<ShardResponse> shardActionListener)
protected java.util.List<ShardId>	shards(Request request, ClusterState clusterState)

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

TransportBroadcastReplicationAction

public TransportBroadcastReplicationAction(java.lang.String name,
                                           java.util.function.Supplier<Request> request,
                                           Settings settings,
                                           ThreadPool threadPool,
                                           ClusterService clusterService,
                                           TransportService transportService,
                                           ActionFilters actionFilters,
                                           IndexNameExpressionResolver indexNameExpressionResolver,
                                           TransportReplicationAction replicatedBroadcastShardAction)

Method Detail

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>

shardExecute

protected void shardExecute(Task task,
                            Request request,
                            ShardId shardId,
                            ActionListener<ShardResponse> shardActionListener)

shards

protected java.util.List<ShardId> shards(Request request,
                                         ClusterState clusterState)

Returns:

all shard ids the request should run on

newShardResponse

protected abstract ShardResponse newShardResponse()

newShardRequest

protected abstract ShardRequest newShardRequest(Request request,
                                                ShardId shardId)

newResponse

protected abstract BroadcastResponse newResponse(int successfulShards,
                                                 int failedShards,
                                                 int totalNumCopies,
                                                 java.util.List<ShardOperationFailedException> shardFailures)