Package org.elasticsearch.action.support

Class TransportAction<Request extends ActionRequest,Response extends ActionResponse>

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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

Direct Known Subclasses:

HandledTransportAction, TransportReplicationAction, TransportSingleShardAction

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

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	actionName
protected TaskManager	taskManager

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

logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected abstract void	doExecute(Task task, Request request, ActionListener<Response> listener)
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
Task	execute(Request request, ActionListener<Response> listener)	Use this method when the transport action call should result in creation of a new task associated with the call.
Task	execute(Request request, TaskListener<Response> listener)	Execute the transport action on the local node, returning the Task used to track its execution and accepting a TaskListener which listens for the completion of the action.

Methods inherited from class java.lang.Object

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

Field Detail

actionName

protected final java.lang.String actionName

taskManager

protected final TaskManager taskManager

Constructor Detail

TransportAction

protected TransportAction(java.lang.String actionName,
                          ActionFilters actionFilters,
                          TaskManager taskManager)

Method Detail

execute

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

Use this method when the transport action call should result in creation of a new task associated with the call. This is a typical behavior.

execute

public final Task execute(Request request,
                          TaskListener<Response> listener)

Execute the transport action on the local node, returning the Task used to track its execution and accepting a TaskListener which listens for the completion of the action.

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)