org.elasticsearch.action.support.master

Class TransportMasterNodeAction<Request extends MasterNodeRequest,Response extends ActionResponse>

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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:

TransportCloseIndexAction, TransportClusterRerouteAction, TransportClusterUpdateSettingsAction, TransportCreateIndexAction, TransportCreateSnapshotAction, TransportDeleteIndexAction, TransportDeleteIndexTemplateAction, TransportDeleteRepositoryAction, TransportDeleteSnapshotAction, TransportDeleteWarmerAction, TransportGetSnapshotsAction, TransportIndicesAliasesAction, TransportMasterNodeReadAction, TransportOpenIndexAction, TransportPutIndexTemplateAction, TransportPutMappingAction, TransportPutRepositoryAction, TransportPutWarmerAction, TransportRestoreSnapshotAction, TransportSnapshotsStatusAction, TransportUpdateSettingsAction, TransportUpgradeSettingsAction, TransportVerifyRepositoryAction

public abstract class TransportMasterNodeAction<Request extends MasterNodeRequest,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 and Description
protected ClusterService	clusterService
protected TransportService	transportService

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

actionName, indexNameExpressionResolver, parseFieldMatcher, taskManager, threadPool

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransportMasterNodeAction(Settings settings, String actionName, TransportService transportService, ClusterService clusterService, ThreadPool threadPool, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, Class<Request> request)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract ClusterBlockException	checkBlock(Request request, ClusterState state)
protected void	doExecute(Request request, ActionListener<Response> listener)
protected void	doExecute(Task task, Request request, ActionListener<Response> listener)
protected abstract String	executor()
protected boolean	localExecute(Request request)
protected abstract void	masterOperation(Request request, ClusterState state, ActionListener<Response> listener)
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 Response	newResponse()

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

execute, execute, execute, execute

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

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

transportService

protected final TransportService transportService

clusterService

protected final ClusterService clusterService

Constructor Detail

TransportMasterNodeAction

protected TransportMasterNodeAction(Settings settings,
                         String actionName,
                         TransportService transportService,
                         ClusterService clusterService,
                         ThreadPool threadPool,
                         ActionFilters actionFilters,
                         IndexNameExpressionResolver indexNameExpressionResolver,
                         Class<Request> request)

Method Detail

executor

protected abstract String executor()

newResponse

protected abstract Response newResponse()

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 final void doExecute(Request request,
             ActionListener<Response> listener)

Specified by:

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

doExecute

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

Overrides:

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