java.lang.Object

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

Direct Known Subclasses:: HandledTransportAction, TransportReplicationAction, TransportSingleShardAction

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

Field Summary

Fields
Modifier and Type	Field	Description
`java.lang.String`	`actionName`
`protected Transport.Connection`	`localConnection`
`protected org.apache.logging.log4j.Logger`	`logger`	Deprecated. declare your own logger.
`protected TaskManager`	`taskManager`

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`TransportAction(java.lang.String actionName, ActionFilters actionFilters, Transport.Connection localConnection, TaskManager taskManager)`

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.

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

Field Details
- actionName
  
  public final java.lang.String actionName
- taskManager
  
  protected final TaskManager taskManager
- localConnection
  
  protected final Transport.Connection localConnection
- logger
  
  @Deprecated protected org.apache.logging.log4j.Logger logger
  
  Deprecated.
  declare your own logger.
Constructor Details
- TransportAction
  
  protected TransportAction(java.lang.String actionName, ActionFilters actionFilters, Transport.Connection localConnection, TaskManager taskManager)
Method Details
- 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)