org.elasticsearch.action.support.tasks

Class TransportTasksAction<OperationTask extends Task,TasksRequest extends BaseTasksRequest<TasksRequest>,TasksResponse extends BaseTasksResponse,TaskResponse extends Writeable<TaskResponse>>

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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<TaskResponse>>
extends HandledTransportAction<TasksRequest,TasksResponse>

The base class for transport actions that are interacting with currently running tasks.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClusterName	clusterName
protected ClusterService	clusterService
protected Callable<TasksRequest>	requestFactory
protected String	transportNodeAction
protected TransportService	transportService

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

actionName, indexNameExpressionResolver, parseFieldMatcher, taskManager, threadPool

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransportTasksAction(Settings settings, String actionName, ClusterName clusterName, ThreadPool threadPool, ClusterService clusterService, TransportService transportService, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Callable<TasksRequest> requestFactory, String nodeExecutor)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	accumulateExceptions()
protected void	doExecute(TasksRequest request, ActionListener<TasksResponse> listener)
protected void	doExecute(Task task, TasksRequest request, ActionListener<TasksResponse> listener)
protected String[]	filterNodeIds(DiscoveryNodes nodes, String[] nodesIds)
protected TasksResponse	newResponse(TasksRequest request, AtomicReferenceArray responses)
protected abstract TasksResponse	newResponse(TasksRequest request, List<TaskResponse> tasks, List<TaskOperationFailure> taskOperationFailures, List<FailedNodeException> failedNodeExceptions)
protected void	processTasks(TasksRequest request, Consumer<OperationTask> operation)
protected abstract TaskResponse	readTaskResponse(StreamInput in)
protected String[]	resolveNodes(TasksRequest request, ClusterState clusterState)
protected abstract TaskResponse	taskOperation(TasksRequest request, OperationTask task)
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

clusterName

protected final ClusterName clusterName

clusterService

protected final ClusterService clusterService

transportService

protected final TransportService transportService

requestFactory

protected final Callable<TasksRequest extends BaseTasksRequest<TasksRequest>> requestFactory

transportNodeAction

protected final String transportNodeAction

Constructor Detail

TransportTasksAction

protected TransportTasksAction(Settings settings,
                    String actionName,
                    ClusterName clusterName,
                    ThreadPool threadPool,
                    ClusterService clusterService,
                    TransportService transportService,
                    ActionFilters actionFilters,
                    IndexNameExpressionResolver indexNameExpressionResolver,
                    Callable<TasksRequest> requestFactory,
                    String nodeExecutor)

Method Detail

doExecute

protected final void doExecute(TasksRequest request,
             ActionListener<TasksResponse> listener)

Specified by:

doExecute in class TransportAction<TasksRequest extends BaseTasksRequest<TasksRequest>,TasksResponse extends BaseTasksResponse>

doExecute

protected void doExecute(Task task,
             TasksRequest request,
             ActionListener<TasksResponse> listener)

Overrides:

doExecute in class TransportAction<TasksRequest extends BaseTasksRequest<TasksRequest>,TasksResponse extends BaseTasksResponse>

filterNodeIds

protected String[] filterNodeIds(DiscoveryNodes nodes,
                     String[] nodesIds)

resolveNodes

protected String[] resolveNodes(TasksRequest request,
                    ClusterState clusterState)

processTasks

protected void processTasks(TasksRequest request,
                Consumer<OperationTask> operation)

newResponse

protected abstract TasksResponse newResponse(TasksRequest request,
                        List<TaskResponse> tasks,
                        List<TaskOperationFailure> taskOperationFailures,
                        List<FailedNodeException> failedNodeExceptions)

newResponse

protected TasksResponse newResponse(TasksRequest request,
                        AtomicReferenceArray responses)

readTaskResponse

protected abstract TaskResponse readTaskResponse(StreamInput in)
                                                                          throws IOException

Throws:

IOException

taskOperation

protected abstract TaskResponse taskOperation(TasksRequest request,
                         OperationTask task)

transportCompress

protected boolean transportCompress()

accumulateExceptions

protected abstract boolean accumulateExceptions()