java.lang.Object

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, TransportFindDanglingIndexAction, TransportListDanglingIndicesAction, TransportNodesHotThreadsAction, TransportNodesInfoAction, TransportNodesListGatewayMetaState, TransportNodesListGatewayStartedShards, TransportNodesListShardStoreMetadata, TransportNodesReloadSecureSettingsAction, TransportNodesSnapshotsStatus, TransportNodesStatsAction, TransportNodesUsageAction

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	Description
`protected ClusterService`	`clusterService`
`protected java.lang.Class<NodeResponse>`	`nodeResponseClass`
`protected ThreadPool`	`threadPool`
`protected java.lang.String`	`transportNodeAction`
`protected TransportService`	`transportService`

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

actionName, logger, taskManager

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`TransportNodesAction(java.lang.String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, Writeable.Reader<NodesRequest> request, Writeable.Reader<NodeRequest> nodeRequest, java.lang.String nodeExecutor, java.lang.Class<NodeResponse> nodeResponseClass)`	Same as `TransportNodesAction(String, ThreadPool, ClusterService, TransportService, ActionFilters, Writeable.Reader, Writeable.Reader, String, String, Class)` but executes final response collection on the transport thread except for when the final node response is received from the local node, in which case `nodeExecutor` is used.
`protected`	`TransportNodesAction(java.lang.String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, Writeable.Reader<NodesRequest> request, Writeable.Reader<NodeRequest> nodeRequest, java.lang.String nodeExecutor, java.lang.String finalExecutor, java.lang.Class<NodeResponse> nodeResponseClass)`

Method Summary

Modifier and Type	Method	Description
`protected void`	`doExecute(Task task, NodesRequest request, ActionListener<NodesResponse> listener)`
`protected java.lang.String`	`getTransportNodeAction(DiscoveryNode node)`	Get a backwards compatible transport action name
`protected abstract NodeRequest`	`newNodeRequest(NodesRequest request)`
`protected abstract NodeResponse`	`newNodeResponse(StreamInput in)`
`protected NodesResponse`	`newResponse(NodesRequest request, java.util.concurrent.atomic.AtomicReferenceArray<?> nodesResponses)`	Map the responses into `nodeResponseClass` responses and `FailedNodeException`s.
`protected abstract NodesResponse`	`newResponse(NodesRequest request, java.util.List<NodeResponse> responses, java.util.List<FailedNodeException> failures)`	Create a new `TransportNodesAction` (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

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
- threadPool
  
  protected final ThreadPool threadPool
- clusterService
  
  protected final ClusterService clusterService
- transportService
  
  protected final TransportService transportService
- nodeResponseClass
  
  protected final java.lang.Class<NodeResponse extends BaseNodeResponse> nodeResponseClass
- transportNodeAction
  
  protected final java.lang.String transportNodeAction
Constructor Details
- TransportNodesAction
  
  protected TransportNodesAction(java.lang.String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, Writeable.Reader<NodesRequest> request, Writeable.Reader<NodeRequest> nodeRequest, java.lang.String nodeExecutor, java.lang.String finalExecutor, java.lang.Class<NodeResponse> nodeResponseClass)
  
  Parameters:
  
  actionName - action name
  
  threadPool - thread-pool
  
  clusterService - cluster service
  
  transportService - transport service
  
  actionFilters - action filters
  
  request - node request writer
  
  nodeRequest - node request reader
  
  nodeExecutor - executor to execute node action on
  
  finalExecutor - executor to execute final collection of all responses on
  
  nodeResponseClass - class of the node responses
- TransportNodesAction
  
  protected TransportNodesAction(java.lang.String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, Writeable.Reader<NodesRequest> request, Writeable.Reader<NodeRequest> nodeRequest, java.lang.String nodeExecutor, java.lang.Class<NodeResponse> nodeResponseClass)
  
  Same as TransportNodesAction(String, ThreadPool, ClusterService, TransportService, ActionFilters, Writeable.Reader, Writeable.Reader, String, String, Class) but executes final response collection on the transport thread except for when the final node response is received from the local node, in which case nodeExecutor is used. This constructor should only be used for actions for which the creation of the final response is fast enough to be safely executed on a transport thread.
Method Details
- doExecute
  
  protected void doExecute(Task task, NodesRequest request, ActionListener<NodesResponse> listener)
  
  Specified by:
  
  doExecute in class TransportAction<NodesRequest extends BaseNodesRequest<NodesRequest>,NodesResponse extends BaseNodesResponse>
- 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 TransportNodesAction (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(NodesRequest request)
- newNodeResponse
  
  protected abstract NodeResponse newNodeResponse(StreamInput in) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
- 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
- getTransportNodeAction
  
  protected java.lang.String getTransportNodeAction(DiscoveryNode node)
  
  Get a backwards compatible transport action name

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details

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