Module org.elasticsearch.server

Package org.elasticsearch.action.support

Class TransportAction<Request extends ActionRequest,Response extends ActionResponse>

java.lang.Object

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

Direct Known Subclasses:

GetHealthAction.LocalAction, HandledTransportAction, TransportNodesAction, TransportReplicationAction, TransportSingleShardAction

public abstract class TransportAction<Request extends ActionRequest,Response extends ActionResponse>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final String	actionName
protected org.apache.logging.log4j.Logger	logger	Deprecated. declare your own logger.
protected final TaskManager	taskManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TransportAction(String actionName, ActionFilters actionFilters, TaskManager taskManager)

Method Summary

Modifier and Type	Method	Description
protected abstract void	doExecute(Task task, Request request, ActionListener<Response> listener)
final void	execute(Task task, Request request, ActionListener<Response> listener)	Use this method when the transport action should continue to run in the context of the current task
static <T> T	localOnly()	A method to use as a placeholder in implementations of TransportAction which only ever run on the local node, and therefore do not need to serialize or deserialize any messages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

actionName

public final String actionName

taskManager

protected final TaskManager taskManager

logger

@Deprecated
protected org.apache.logging.log4j.Logger logger

Deprecated.

declare your own logger.

Constructor Details

TransportAction

protected TransportAction(String actionName,
 ActionFilters actionFilters,
 TaskManager taskManager)

Method Details

execute

public final void execute(Task task,
 Request request,
 ActionListener<Response> listener)

Use this method when the transport action should continue to run in the context of the current task

doExecute

protected abstract void doExecute(Task task,
 Request request,
 ActionListener<Response> listener)

localOnly

public static <T> T localOnly()

A method to use as a placeholder in implementations of TransportAction which only ever run on the local node, and therefore do not need to serialize or deserialize any messages.