Module org.elasticsearch.server
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
,TransportDeleteDesiredNodesAction
,TransportGetFeatureUpgradeStatusAction
,TransportGetShardSnapshotAction
,TransportGetSnapshotsAction
,TransportMasterNodeReadAction
,TransportOpenIndexAction
,TransportPostFeatureUpgradeAction
,TransportResetFeatureStateAction
,TransportResizeAction
,TransportRestoreSnapshotAction
,TransportRolloverAction
,TransportSnapshotsStatusAction
,TransportSnapshottableFeaturesAction
,TransportUpdateDesiredNodesAction
,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
Modifier and TypeFieldDescriptionprotected final ClusterService
protected final String
protected final IndexNameExpressionResolver
protected final ThreadPool
protected final TransportService
Fields inherited from class org.elasticsearch.action.support.TransportAction
actionName, taskManager
-
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionprotected abstract ClusterBlockException
checkBlock
(Request request, ClusterState state) protected void
doExecute
(Task task, Request request, ActionListener<Response> listener) protected boolean
localExecute
(Request request) protected abstract void
masterOperation
(Task task, Request request, ClusterState state, ActionListener<Response> listener) modifiedKeys
(Request request) Override this method to return the keys of the cluster state or cluster entities that are modified by the Request object.Override this method if the master node action also has anReservedClusterStateHandler
interaction.Methods inherited from class org.elasticsearch.action.support.TransportAction
execute
-
Field Details
-
threadPool
-
transportService
-
clusterService
-
indexNameExpressionResolver
-
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(Task task, Request request, ClusterState state, ActionListener<Response> listener) throws Exception - Throws:
Exception
-
localExecute
-
checkBlock
-
reservedStateHandlerName
Override this method if the master node action also has anReservedClusterStateHandler
interaction.We need to check if certain settings or entities are allowed to be modified by the master node action, depending on if they are set as reserved in 'operator' mode (file based settings, modules, plugins).
- Returns:
- an Optional of the
ReservedClusterStateHandler
name
-
modifiedKeys
Override this method to return the keys of the cluster state or cluster entities that are modified by the Request object.This method is used by the reserved state handler logic (see
ReservedClusterStateHandler
) to verify if the keys don't conflict with an existing key set as reserved.- Parameters:
request
- the TransportMasterNode request- Returns:
- set of String keys intended to be modified/set/deleted by this request
-
doExecute
- Specified by:
doExecute
in classTransportAction<Request extends MasterNodeRequest<Request>,
Response extends ActionResponse>
-