Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.settings

Class TransportClusterUpdateSettingsAction

java.lang.Object

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

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

org.elasticsearch.action.support.master.TransportMasterNodeAction<ClusterUpdateSettingsRequest,ClusterUpdateSettingsResponse>

org.elasticsearch.action.admin.cluster.settings.TransportClusterUpdateSettingsAction

All Implemented Interfaces:

ActionWithReservedState<ClusterUpdateSettingsRequest>

public class TransportClusterUpdateSettingsAction
extends TransportMasterNodeAction<ClusterUpdateSettingsRequest,ClusterUpdateSettingsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransportClusterUpdateSettingsAction.ClusterUpdateSettingsTask

Field Summary

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
TransportClusterUpdateSettingsAction(TransportService transportService, ClusterService clusterService, ThreadPool threadPool, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver, ClusterSettings clusterSettings)

Method Summary

Modifier and Type	Method	Description
protected ClusterBlockException	checkBlock(ClusterUpdateSettingsRequest request, ClusterState state)	skip check block if: Only at least one of cluster.blocks.read_only or cluster.blocks.read_only_allow_delete is being cleared (set to null or false).
protected void	masterOperation(Task task, ClusterUpdateSettingsRequest request, ClusterState state, ActionListener<ClusterUpdateSettingsResponse> listener)
Set<String>	modifiedKeys(ClusterUpdateSettingsRequest 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

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

Constructor Details

TransportClusterUpdateSettingsAction

@Inject
public TransportClusterUpdateSettingsAction(TransportService transportService,
 ClusterService clusterService,
 ThreadPool threadPool,
 ActionFilters actionFilters,
 IndexNameExpressionResolver indexNameExpressionResolver,
 ClusterSettings clusterSettings)

Method Details

checkBlock

protected ClusterBlockException checkBlock(ClusterUpdateSettingsRequest request,
 ClusterState state)

skip check block if: Only at least one of cluster.blocks.read_only or cluster.blocks.read_only_allow_delete is being cleared (set to null or false). Or all of the following are true: 1. At least one of cluster.blocks.read_only or cluster.blocks.read_only_allow_delete is being cleared (set to null or false). 2. Neither cluster.blocks.read_only nor cluster.blocks.read_only_allow_delete is being set to true. 3. The only other settings in this update are archived ones being set to null.

Specified by:

checkBlock in class TransportMasterNodeAction<ClusterUpdateSettingsRequest,ClusterUpdateSettingsResponse>

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(ClusterUpdateSettingsRequest 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

masterOperation

protected void masterOperation(Task task,
 ClusterUpdateSettingsRequest request,
 ClusterState state,
 ActionListener<ClusterUpdateSettingsResponse> listener)

Specified by:

masterOperation in class TransportMasterNodeAction<ClusterUpdateSettingsRequest,ClusterUpdateSettingsResponse>