Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.repositories.put

Class TransportPutRepositoryAction

java.lang.Object

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

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

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

org.elasticsearch.action.support.master.AcknowledgedTransportMasterNodeAction<PutRepositoryRequest>

org.elasticsearch.action.admin.cluster.repositories.put.TransportPutRepositoryAction

All Implemented Interfaces:

ActionWithReservedState<PutRepositoryRequest>

public class TransportPutRepositoryAction
extends AcknowledgedTransportMasterNodeAction<PutRepositoryRequest>

Transport action for register repository operation

Field Summary

Fields

Modifier and Type	Field	Description
static final ActionType<AcknowledgedResponse>	TYPE

Fields inherited from class org.elasticsearch.action.support.master.TransportMasterNodeAction

clusterService, executor, indexNameExpressionResolver, threadPool, transportService

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

actionName, taskManager

Constructor Summary

Constructors

Constructor	Description
TransportPutRepositoryAction(TransportService transportService, ClusterService clusterService, RepositoriesService repositoriesService, ThreadPool threadPool, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver)

Method Summary

Modifier and Type	Method	Description
protected ClusterBlockException	checkBlock(PutRepositoryRequest request, ClusterState state)
protected void	masterOperation(Task task, PutRepositoryRequest request, ClusterState state, ActionListener<AcknowledgedResponse> listener)
Set<String>	modifiedKeys(PutRepositoryRequest request)	Override this method to return the keys of the cluster state or cluster entities that are modified by the Request object.
Optional<String>	reservedStateHandlerName()	Override this method if the master node action also has an ReservedClusterStateHandler interaction.

Methods inherited from class org.elasticsearch.action.support.master.TransportMasterNodeAction

doExecute, localExecute

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

execute, localOnly

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.reservedstate.ActionWithReservedState

validateForReservedState

Field Details

TYPE

public static final ActionType<AcknowledgedResponse> TYPE

Constructor Details

TransportPutRepositoryAction

@Inject
public TransportPutRepositoryAction(TransportService transportService,
 ClusterService clusterService,
 RepositoriesService repositoriesService,
 ThreadPool threadPool,
 ActionFilters actionFilters,
 IndexNameExpressionResolver indexNameExpressionResolver)

Method Details

checkBlock

protected ClusterBlockException checkBlock(PutRepositoryRequest request,
 ClusterState state)

Specified by:

checkBlock in class TransportMasterNodeAction<PutRepositoryRequest,AcknowledgedResponse>

masterOperation

protected void masterOperation(Task task,
 PutRepositoryRequest request,
 ClusterState state,
 ActionListener<AcknowledgedResponse> listener)

Specified by:

masterOperation in class TransportMasterNodeAction<PutRepositoryRequest,AcknowledgedResponse>

reservedStateHandlerName

public Optional<String> reservedStateHandlerName()

Description copied from interface: ActionWithReservedState

Override this method if the master node action also has an ReservedClusterStateHandler 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

public Set<String> modifiedKeys(PutRepositoryRequest request)

Description copied from interface: ActionWithReservedState

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