org.elasticsearch.action.support.nodes

Class TransportNodesAction<NodesRequest extends BaseNodesRequest<NodesRequest>,NodesResponse extends BaseNodesResponse,NodeRequest extends BaseNodeRequest,NodeResponse extends BaseNodeResponse>

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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

org.elasticsearch.action.support.HandledTransportAction<NodesRequest,NodesResponse>

org.elasticsearch.action.support.nodes.TransportNodesAction<NodesRequest,NodesResponse,NodeRequest,NodeResponse>

Direct Known Subclasses:

TransportClusterStatsAction, TransportNodesHotThreadsAction, TransportNodesInfoAction, TransportNodesListGatewayMetaState, TransportNodesListGatewayStartedShards, TransportNodesListShardStoreMetaData, TransportNodesSnapshotsStatus, TransportNodesStatsAction

public abstract class TransportNodesAction<NodesRequest extends BaseNodesRequest<NodesRequest>,NodesResponse extends BaseNodesResponse,NodeRequest extends BaseNodeRequest,NodeResponse extends BaseNodeResponse>
extends HandledTransportAction<NodesRequest,NodesResponse>

Field Summary

Fields

Modifier and Type	Field and Description
protected ClusterService	clusterService
protected java.lang.Class<NodeResponse>	nodeResponseClass
protected TransportService	transportService

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

Modifier

Constructor and Description

protected

TransportNodesAction(Settings settings, java.lang.String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, java.util.function.Supplier<NodesRequest> request, java.util.function.Supplier<NodeRequest> nodeRequest, java.lang.String nodeExecutor, java.lang.Class<NodeResponse> nodeResponseClass)

Method Summary

Modifier and Type	Method and Description
protected void	doExecute(NodesRequest request, ActionListener<NodesResponse> listener)
protected void	doExecute(Task task, NodesRequest request, ActionListener<NodesResponse> listener)
protected abstract NodeRequest	newNodeRequest(java.lang.String nodeId, NodesRequest request)
protected abstract NodeResponse	newNodeResponse()
protected NodesResponse	newResponse(NodesRequest request, java.util.concurrent.atomic.AtomicReferenceArray nodesResponses) Map the responses into nodeResponseClass responses and FailedNodeExceptions.
protected abstract NodesResponse	newResponse(NodesRequest request, java.util.List<NodeResponse> responses, java.util.List<FailedNodeException> failures) Create a new NodesResponse (multi-node response).
protected abstract NodeResponse	nodeOperation(NodeRequest request)
protected NodeResponse	nodeOperation(NodeRequest request, Task task)
protected void	resolveRequest(NodesRequest request, ClusterState clusterState) resolve node ids to concrete nodes of the incoming request
protected boolean	transportCompress()

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

nodeResponseClass

protected final java.lang.Class<NodeResponse extends BaseNodeResponse> nodeResponseClass

Constructor Detail

TransportNodesAction

protected TransportNodesAction(Settings settings,
                               java.lang.String actionName,
                               ThreadPool threadPool,
                               ClusterService clusterService,
                               TransportService transportService,
                               ActionFilters actionFilters,
                               IndexNameExpressionResolver indexNameExpressionResolver,
                               java.util.function.Supplier<NodesRequest> request,
                               java.util.function.Supplier<NodeRequest> nodeRequest,
                               java.lang.String nodeExecutor,
                               java.lang.Class<NodeResponse> nodeResponseClass)

Method Detail

doExecute

protected final void doExecute(NodesRequest request,
                               ActionListener<NodesResponse> listener)

Specified by:

doExecute in class TransportAction<NodesRequest extends BaseNodesRequest<NodesRequest>,NodesResponse extends BaseNodesResponse>

doExecute

protected void doExecute(Task task,
                         NodesRequest request,
                         ActionListener<NodesResponse> listener)

Overrides:

doExecute in class TransportAction<NodesRequest extends BaseNodesRequest<NodesRequest>,NodesResponse extends BaseNodesResponse>

transportCompress

protected boolean transportCompress()

newResponse

protected NodesResponse newResponse(NodesRequest request,
                                    java.util.concurrent.atomic.AtomicReferenceArray nodesResponses)

Map the responses into nodeResponseClass responses and FailedNodeExceptions.

Parameters:

request - The associated request.

nodesResponses - All node-level responses

Returns:

Never null.

Throws:

java.lang.NullPointerException - if nodesResponses is null

See Also:

newResponse(BaseNodesRequest, List, List)

newResponse

protected abstract NodesResponse newResponse(NodesRequest request,
                                             java.util.List<NodeResponse> responses,
                                             java.util.List<FailedNodeException> failures)

Create a new NodesResponse (multi-node response).

Parameters:

request - The associated request.

responses - All successful node-level responses.

failures - All node-level failures.

Returns:

Never null.

Throws:

java.lang.NullPointerException - if any parameter is null.

newNodeRequest

protected abstract NodeRequest newNodeRequest(java.lang.String nodeId,
                                              NodesRequest request)

newNodeResponse

protected abstract NodeResponse newNodeResponse()

nodeOperation

protected abstract NodeResponse nodeOperation(NodeRequest request)

nodeOperation

protected NodeResponse nodeOperation(NodeRequest request,
                                     Task task)

resolveRequest

protected void resolveRequest(NodesRequest request,
                              ClusterState clusterState)

resolve node ids to concrete nodes of the incoming request