Package org.opensearch.action.support.nodes

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

java.lang.Object

org.opensearch.action.support.TransportAction<NodesRequest,NodesResponse>

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

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

Direct Known Subclasses:

TransportClusterStatsAction, TransportFindDanglingIndexAction, TransportGetAllPitsAction, TransportListDanglingIndicesAction, TransportNodesHotThreadsAction, TransportNodesInfoAction, TransportNodesListGatewayMetaState, TransportNodesListGatewayStartedShards, TransportNodesListGatewayStartedShardsBatch, TransportNodesListShardStoreMetadata, TransportNodesListShardStoreMetadataBatch, 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>

Base action class for transport nodes

Opensearch.internal:

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClusterService	clusterService
protected final Class<NodeResponse>	nodeResponseClass
protected final ThreadPool	threadPool
protected final String	transportNodeAction
protected final TransportService	transportService

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

actionName, logger, taskManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TransportNodesAction(String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, org.opensearch.core.common.io.stream.Writeable.Reader<NodesRequest> request, org.opensearch.core.common.io.stream.Writeable.Reader<NodeRequest> nodeRequest, String nodeExecutor, 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(String actionName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, org.opensearch.core.common.io.stream.Writeable.Reader<NodesRequest> request, org.opensearch.core.common.io.stream.Writeable.Reader<NodeRequest> nodeRequest, String nodeExecutor, String finalExecutor, Class<NodeResponse> nodeResponseClass)

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(Task task, NodesRequest request, org.opensearch.core.action.ActionListener<NodesResponse> listener)
protected String	getTransportNodeAction(DiscoveryNode node)	Get a backwards compatible transport action name
protected abstract NodeRequest	newNodeRequest(NodesRequest request)
protected abstract NodeResponse	newNodeResponse(org.opensearch.core.common.io.stream.StreamInput in)
protected NodesResponse	newResponse(NodesRequest request, AtomicReferenceArray<?> nodesResponses)	Map the responses into nodeResponseClass responses and FailedNodeExceptions.
protected abstract NodesResponse	newResponse(NodesRequest request, List<NodeResponse> responses, 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.opensearch.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 Class<NodeResponse extends BaseNodeResponse> nodeResponseClass

transportNodeAction

protected final String transportNodeAction

Constructor Details

TransportNodesAction

protected TransportNodesAction(String actionName,
 ThreadPool threadPool,
 ClusterService clusterService,
 TransportService transportService,
 ActionFilters actionFilters,
 org.opensearch.core.common.io.stream.Writeable.Reader<NodesRequest> request,
 org.opensearch.core.common.io.stream.Writeable.Reader<NodeRequest> nodeRequest,
 String nodeExecutor,
 String finalExecutor,
 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(String actionName,
 ThreadPool threadPool,
 ClusterService clusterService,
 TransportService transportService,
 ActionFilters actionFilters,
 org.opensearch.core.common.io.stream.Writeable.Reader<NodesRequest> request,
 org.opensearch.core.common.io.stream.Writeable.Reader<NodeRequest> nodeRequest,
 String nodeExecutor,
 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,
 org.opensearch.core.action.ActionListener<NodesResponse> listener)

Specified by:

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

newResponse

protected NodesResponse newResponse(NodesRequest request,
 AtomicReferenceArray<?> nodesResponses)

Map the responses into nodeResponseClass responses and FailedNodeExceptions.

Parameters:

request - The associated request.

nodesResponses - All node-level responses

Returns:

Never null.

Throws:

NullPointerException - if nodesResponses is null

See Also:

• newResponse(BaseNodesRequest, List, List)

newResponse

protected abstract NodesResponse newResponse(NodesRequest request,
 List<NodeResponse> responses,
 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:

NullPointerException - if any parameter is null.

newNodeRequest

protected abstract NodeRequest newNodeRequest(NodesRequest request)

newNodeResponse

protected abstract NodeResponse newNodeResponse(org.opensearch.core.common.io.stream.StreamInput in)
                                         throws IOException

Throws:

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 String getTransportNodeAction(DiscoveryNode node)

Get a backwards compatible transport action name