Module org.elasticsearch.server
Class TransportTasksAction<OperationTask extends Task,TasksRequest extends BaseTasksRequest<TasksRequest>,TasksResponse extends BaseTasksResponse,TaskResponse extends Writeable>
java.lang.Object
org.elasticsearch.action.support.TransportAction<Request,Response>
org.elasticsearch.action.support.HandledTransportAction<TasksRequest,TasksResponse>
org.elasticsearch.action.support.tasks.TransportTasksAction<OperationTask,TasksRequest,TasksResponse,TaskResponse>
- Direct Known Subclasses:
TransportCancelTasksAction
,TransportListTasksAction
public abstract class TransportTasksAction<OperationTask extends Task,TasksRequest extends BaseTasksRequest<TasksRequest>,TasksResponse extends BaseTasksResponse,TaskResponse extends Writeable>
extends HandledTransportAction<TasksRequest,TasksResponse>
The base class for transport actions that are interacting with currently running tasks.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final ClusterService
protected final Writeable.Reader<TasksRequest>
protected final Writeable.Reader<TaskResponse>
protected final Writeable.Reader<TasksResponse>
protected final String
protected final TransportService
Fields inherited from class org.elasticsearch.action.support.TransportAction
actionName, logger, taskManager
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
TransportTasksAction
(String actionName, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, Writeable.Reader<TasksRequest> requestReader, Writeable.Reader<TasksResponse> responsesReader, Writeable.Reader<TaskResponse> responseReader, Executor nodeExecutor) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
doExecute
(Task task, TasksRequest request, ActionListener<TasksResponse> listener) protected abstract TasksResponse
newResponse
(TasksRequest request, List<TaskResponse> tasks, List<TaskOperationFailure> taskOperationFailures, List<FailedNodeException> failedNodeExceptions) protected void
processTasks
(CancellableTask nodeTask, TasksRequest request, ActionListener<List<OperationTask>> nodeOperation) protected List<OperationTask>
processTasks
(TasksRequest request) protected String[]
resolveNodes
(TasksRequest request, DiscoveryNodes discoveryNodes) protected abstract void
taskOperation
(CancellableTask actionTask, TasksRequest request, OperationTask task, ActionListener<TaskResponse> listener) Perform the required operation on the task.Methods inherited from class org.elasticsearch.action.support.TransportAction
execute, localOnly
-
Field Details
-
clusterService
-
transportService
-
requestReader
-
responsesReader
-
responseReader
-
transportNodeAction
-
-
Constructor Details
-
TransportTasksAction
protected TransportTasksAction(String actionName, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, Writeable.Reader<TasksRequest> requestReader, Writeable.Reader<TasksResponse> responsesReader, Writeable.Reader<TaskResponse> responseReader, Executor nodeExecutor)
-
-
Method Details
-
doExecute
- Specified by:
doExecute
in classTransportAction<TasksRequest extends BaseTasksRequest<TasksRequest>,
TasksResponse extends BaseTasksResponse>
-
resolveNodes
-
processTasks
protected void processTasks(CancellableTask nodeTask, TasksRequest request, ActionListener<List<OperationTask>> nodeOperation) -
processTasks
-
newResponse
protected abstract TasksResponse newResponse(TasksRequest request, List<TaskResponse> tasks, List<TaskOperationFailure> taskOperationFailures, List<FailedNodeException> failedNodeExceptions) -
taskOperation
protected abstract void taskOperation(CancellableTask actionTask, TasksRequest request, OperationTask task, ActionListener<TaskResponse> listener) Perform the required operation on the task. It is OK start an asynchronous operation or to throw an exception but not both.- Parameters:
actionTask
- The related transport action task. Can be used to create a task ID to handle upstream transport cancellations.request
- the original transport requesttask
- the task on which the operation is taking placelistener
- the listener to signal.
-