Package org.elasticsearch.action.support.master

Class TransportMasterNodeAction<Request extends MasterNodeRequest<Request>,Response extends ActionResponse>

java.lang.Object

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

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

org.elasticsearch.action.support.master.TransportMasterNodeAction<Request,Response>

Direct Known Subclasses:

AcknowledgedTransportMasterNodeAction, AutoCreateAction.TransportAction, CompletionPersistentTaskAction.TransportAction, RemovePersistentTaskAction.TransportAction, StartPersistentTaskAction.TransportAction, TransportAddIndexBlockAction, TransportAddVotingConfigExclusionsAction, TransportCleanupRepositoryAction, TransportClearVotingConfigExclusionsAction, TransportCloseIndexAction, TransportClusterAllocationExplainAction, TransportClusterRerouteAction, TransportClusterUpdateSettingsAction, TransportCreateIndexAction, TransportCreateSnapshotAction, TransportGetSnapshotsAction, TransportMasterNodeReadAction, TransportOpenIndexAction, TransportResetFeatureStateAction, TransportResizeAction, TransportRestoreSnapshotAction, TransportRolloverAction, TransportSnapshotsStatusAction, TransportSnapshottableFeaturesAction, TransportVerifyRepositoryAction, UpdatePersistentTaskStatusAction.TransportAction

public abstract class TransportMasterNodeAction<Request extends MasterNodeRequest<Request>,Response extends ActionResponse>
extends HandledTransportAction<Request,Response>

A base class for operations that needs to be performed on the master node.

Field Summary

Fields

Modifier and Type	Field	Description
protected ClusterService	clusterService
protected String	executor
protected IndexNameExpressionResolver	indexNameExpressionResolver
protected ThreadPool	threadPool
protected TransportService	transportService

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

actionName, localConnection, taskManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TransportMasterNodeAction(String actionName, boolean canTripCircuitBreaker, TransportService transportService, ClusterService clusterService, ThreadPool threadPool, ActionFilters actionFilters, Writeable.Reader<Request> request, IndexNameExpressionResolver indexNameExpressionResolver, Writeable.Reader<Response> response, String executor)
protected	TransportMasterNodeAction(String actionName, TransportService transportService, ClusterService clusterService, ThreadPool threadPool, ActionFilters actionFilters, Writeable.Reader<Request> request, IndexNameExpressionResolver indexNameExpressionResolver, Writeable.Reader<Response> response, String executor)

Method Summary

Modifier and Type	Method	Description
protected abstract ClusterBlockException	checkBlock(Request request, ClusterState state)
protected void	doExecute(Task task, Request request, ActionListener<Response> listener)
protected String	getMasterActionName(DiscoveryNode node)	Allows to conditionally return a different master node action name in the case an action gets renamed.
protected boolean	localExecute(Request request)
protected void	masterOperation(Task task, Request request, ClusterState state, ActionListener<Response> listener)	Override this operation if access to the task parameter is needed
protected abstract void	masterOperation(Request request, ClusterState state, ActionListener<Response> listener)

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

execute, execute, execute

Methods inherited from class java.lang.Object

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

Field Details

threadPool

protected final ThreadPool threadPool

transportService

protected final TransportService transportService

clusterService

protected final ClusterService clusterService

indexNameExpressionResolver

protected final IndexNameExpressionResolver indexNameExpressionResolver

executor

protected final String executor

Constructor Details

TransportMasterNodeAction

protected TransportMasterNodeAction(String actionName,
 TransportService transportService,
 ClusterService clusterService,
 ThreadPool threadPool,
 ActionFilters actionFilters,
 Writeable.Reader<Request> request,
 IndexNameExpressionResolver indexNameExpressionResolver,
 Writeable.Reader<Response> response,
 String executor)

TransportMasterNodeAction

protected TransportMasterNodeAction(String actionName,
 boolean canTripCircuitBreaker,
 TransportService transportService,
 ClusterService clusterService,
 ThreadPool threadPool,
 ActionFilters actionFilters,
 Writeable.Reader<Request> request,
 IndexNameExpressionResolver indexNameExpressionResolver,
 Writeable.Reader<Response> response,
 String executor)

Method Details

masterOperation

protected abstract void masterOperation(Request request,
 ClusterState state,
 ActionListener<Response> listener)
                                 throws Exception

Throws:

Exception

masterOperation

protected void masterOperation(Task task,
 Request request,
 ClusterState state,
 ActionListener<Response> listener)
                        throws Exception

Override this operation if access to the task parameter is needed

Throws:

Exception

localExecute

protected boolean localExecute(Request request)

checkBlock

protected abstract ClusterBlockException checkBlock(Request request,
 ClusterState state)

doExecute

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

Specified by:

doExecute in class TransportAction<Request extends MasterNodeRequest<Request>,Response extends ActionResponse>

getMasterActionName

protected String getMasterActionName(DiscoveryNode node)

Allows to conditionally return a different master node action name in the case an action gets renamed. This mainly for backwards compatibility should be used rarely