Package org.elasticsearch.action.support.broadcast

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

java.lang.Object

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:

TransportAnalyzeIndexDiskUsageAction, TransportValidateQueryAction

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	TransportBroadcastAction.AsyncBroadcastAction

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, localConnection, logger, taskManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TransportBroadcastAction(String actionName, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Writeable.Reader<Request> request, Writeable.Reader<ShardRequest> shardRequest, String shardExecutor)

Method Summary

Modifier and Type	Method	Description
protected abstract ClusterBlockException	checkGlobalBlock(ClusterState state, Request request)
protected abstract ClusterBlockException	checkRequestBlock(ClusterState state, Request request, String[] concreteIndices)
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	readShardResponse(StreamInput in)
protected abstract ShardResponse	shardOperation(ShardRequest request, Task task)
protected abstract GroupShardsIterator<ShardIterator>	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

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

TransportBroadcastAction

protected TransportBroadcastAction(String actionName,
 ClusterService clusterService,
 TransportService transportService,
 ActionFilters actionFilters,
 IndexNameExpressionResolver indexNameExpressionResolver,
 Writeable.Reader<Request> request,
 Writeable.Reader<ShardRequest> shardRequest,
 String shardExecutor)

Method Details

doExecute

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

Specified by:

doExecute in class TransportAction<Request extends BroadcastRequest<Request>,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)

readShardResponse

protected abstract ShardResponse readShardResponse(StreamInput in)
                                            throws IOException

Throws:

IOException

shardOperation

protected abstract ShardResponse shardOperation(ShardRequest request,
 Task task)
                                         throws IOException

Throws:

IOException

shards

protected abstract GroupShardsIterator<ShardIterator> 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)