org.elasticsearch.action.support.broadcast

Class TransportBroadcastAction<Request extends BroadcastRequest,Response extends BroadcastResponse,ShardRequest extends BroadcastShardRequest,ShardResponse extends BroadcastShardResponse>

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

Direct Known Subclasses:

TransportDfsOnlyAction, TransportExistsAction, TransportFieldStatsTransportAction, TransportPercolateAction, TransportSuggestAction, TransportValidateQueryAction

public abstract class TransportBroadcastAction<Request extends BroadcastRequest,Response extends BroadcastResponse,ShardRequest extends BroadcastShardRequest,ShardResponse extends BroadcastShardResponse>
extends HandledTransportAction<Request,Response>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TransportBroadcastAction.AsyncBroadcastAction

Field Summary

Fields

Modifier and Type	Field and Description
protected ClusterService	clusterService
protected TransportService	transportService

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

actionName, indexNameExpressionResolver, parseFieldMatcher, taskManager, threadPool

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransportBroadcastAction(Settings settings, String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Class<Request> request, Class<ShardRequest> shardRequest, String shardExecutor)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract ClusterBlockException	checkGlobalBlock(ClusterState state, Request request)
protected abstract ClusterBlockException	checkRequestBlock(ClusterState state, Request request, String[] concreteIndices)
protected void	doExecute(Request request, ActionListener<Response> listener)
protected void	doExecute(Task task, Request request, ActionListener<Response> listener)
protected abstract Response	newResponse(Request request, AtomicReferenceArray shardsResponses, ClusterState clusterState)
protected abstract ShardRequest	newShardRequest(int numShards, ShardRouting shard, Request request)
protected abstract ShardResponse	newShardResponse()
protected abstract ShardResponse	shardOperation(ShardRequest request)
protected ShardResponse	shardOperation(ShardRequest request, Task task)
protected abstract GroupShardsIterator	shards(ClusterState clusterState, Request request, String[] concreteIndices) Determines the shards 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

Field Detail

clusterService

protected final ClusterService clusterService

transportService

protected final TransportService transportService

Constructor Detail

TransportBroadcastAction

protected TransportBroadcastAction(Settings settings,
                        String actionName,
                        ThreadPool threadPool,
                        ClusterService clusterService,
                        TransportService transportService,
                        ActionFilters actionFilters,
                        IndexNameExpressionResolver indexNameExpressionResolver,
                        Class<Request> request,
                        Class<ShardRequest> shardRequest,
                        String shardExecutor)

Method Detail

doExecute

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

Overrides:

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

doExecute

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

Specified by:

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

newResponse

protected abstract Response newResponse(Request request,
                   AtomicReferenceArray shardsResponses,
                   ClusterState clusterState)

newShardRequest

protected abstract ShardRequest newShardRequest(int numShards,
                           ShardRouting shard,
                           Request request)

newShardResponse

protected abstract ShardResponse newShardResponse()

shardOperation

protected abstract ShardResponse shardOperation(ShardRequest request)

shardOperation

protected ShardResponse shardOperation(ShardRequest request,
                           Task task)

shards

protected abstract GroupShardsIterator shards(ClusterState clusterState,
                         Request request,
                         String[] concreteIndices)

Determines the shards this operation will be executed on. The operation is executed once per shard iterator, typically on the first shard in it. If the operation fails, it will be retried on the next shard in the iterator.

checkGlobalBlock

protected abstract ClusterBlockException checkGlobalBlock(ClusterState state,
                                     Request request)

checkRequestBlock

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