Added support for acknowledgements to update cluster settings api

As a side note, the internal reroute call is now part of the ack mechanism. That means that if the response contains acknowledged flag, the internal reroute that was eventually issued was acknowledged too. Also, even if the request is not acknowledged, the reroute is issued before returning, which means that there is no need to manually call reroute afterwards to make sure the new settings are immediately applied.

Closes elastic#3995

src/main/java/org/elasticsearch/action/admin/cluster/settings/ClusterUpdateSettingsRequest.java

@@ -20,8 +20,9 @@
 package org.elasticsearch.action.admin.cluster.settings;
 
 import org.elasticsearch.ElasticSearchGenerationException;
+import org.elasticsearch.Version;
 import org.elasticsearch.action.ActionRequestValidationException;
-import org.elasticsearch.action.support.master.MasterNodeOperationRequest;
+import org.elasticsearch.action.support.master.AcknowledgedRequest;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.settings.ImmutableSettings;
@@ -39,8 +40,9 @@
 import static org.elasticsearch.common.settings.ImmutableSettings.writeSettingsToStream;
 
 /**
+ * Request for an update cluster settings action
  */
-public class ClusterUpdateSettingsRequest extends MasterNodeOperationRequest<ClusterUpdateSettingsRequest> {
+public class ClusterUpdateSettingsRequest extends AcknowledgedRequest<ClusterUpdateSettingsRequest> {
 
     private Settings transientSettings = EMPTY_SETTINGS;
     private Settings persistentSettings = EMPTY_SETTINGS;
@@ -65,21 +67,34 @@ Settings persistentSettings() {
         return persistentSettings;
     }
 
+    /**
+     * Sets the transient settings to be updated. They will not survive a full cluster restart
+     */
     public ClusterUpdateSettingsRequest transientSettings(Settings settings) {
         this.transientSettings = settings;
         return this;
     }
 
+    /**
+     * Sets the transient settings to be updated. They will not survive a full cluster restart
+     */
     public ClusterUpdateSettingsRequest transientSettings(Settings.Builder settings) {
         this.transientSettings = settings.build();
         return this;
     }
 
+    /**
+     * Sets the source containing the transient settings to be updated. They will not survive a full cluster restart
+     */
     public ClusterUpdateSettingsRequest transientSettings(String source) {
         this.transientSettings = ImmutableSettings.settingsBuilder().loadFromSource(source).build();
         return this;
     }
 
+    /**
+     * Sets the transient settings to be updated. They will not survive a full cluster restart
+     */
+    @SuppressWarnings("unchecked")
     public ClusterUpdateSettingsRequest transientSettings(Map source) {
         try {
             XContentBuilder builder = XContentFactory.contentBuilder(XContentType.JSON);
@@ -91,21 +106,34 @@ public ClusterUpdateSettingsRequest transientSettings(Map source) {
         return this;
     }
 
+    /**
+     * Sets the persistent settings to be updated. They will get applied cross restarts
+     */
     public ClusterUpdateSettingsRequest persistentSettings(Settings settings) {
         this.persistentSettings = settings;
         return this;
     }
 
+    /**
+     * Sets the persistent settings to be updated. They will get applied cross restarts
+     */
     public ClusterUpdateSettingsRequest persistentSettings(Settings.Builder settings) {
         this.persistentSettings = settings.build();
         return this;
     }
 
+    /**
+     * Sets the source containing the persistent settings to be updated. They will get applied cross restarts
+     */
     public ClusterUpdateSettingsRequest persistentSettings(String source) {
         this.persistentSettings = ImmutableSettings.settingsBuilder().loadFromSource(source).build();
         return this;
     }
 
+    /**
+     * Sets the persistent settings to be updated. They will get applied cross restarts
+     */
+    @SuppressWarnings("unchecked")
     public ClusterUpdateSettingsRequest persistentSettings(Map source) {
         try {
             XContentBuilder builder = XContentFactory.contentBuilder(XContentType.JSON);
@@ -117,18 +145,19 @@ public ClusterUpdateSettingsRequest persistentSettings(Map source) {
         return this;
     }
 
-
     @Override
     public void readFrom(StreamInput in) throws IOException {
         super.readFrom(in);
         transientSettings = readSettingsFromStream(in);
         persistentSettings = readSettingsFromStream(in);
+        readTimeout(in, Version.V_0_90_6);
     }
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
         super.writeTo(out);
         writeSettingsToStream(transientSettings, out);
         writeSettingsToStream(persistentSettings, out);
+        writeTimeout(out, Version.V_0_90_6);
     }
 }

src/main/java/org/elasticsearch/action/admin/cluster/settings/ClusterUpdateSettingsRequestBuilder.java

@@ -20,56 +20,81 @@
 package org.elasticsearch.action.admin.cluster.settings;
 
 import org.elasticsearch.action.ActionListener;
-import org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder;
+import org.elasticsearch.action.support.master.AcknowledgedRequestBuilder;
 import org.elasticsearch.client.ClusterAdminClient;
 import org.elasticsearch.client.internal.InternalClusterAdminClient;
 import org.elasticsearch.common.settings.Settings;
 
 import java.util.Map;
 
 /**
+ * Builder for a cluster update settings request
  */
-public class ClusterUpdateSettingsRequestBuilder extends MasterNodeOperationRequestBuilder<ClusterUpdateSettingsRequest, ClusterUpdateSettingsResponse, ClusterUpdateSettingsRequestBuilder> {
+public class ClusterUpdateSettingsRequestBuilder extends AcknowledgedRequestBuilder<ClusterUpdateSettingsRequest, ClusterUpdateSettingsResponse, ClusterUpdateSettingsRequestBuilder> {
 
     public ClusterUpdateSettingsRequestBuilder(ClusterAdminClient clusterClient) {
         super((InternalClusterAdminClient) clusterClient, new ClusterUpdateSettingsRequest());
     }
 
+    /**
+     * Sets the transient settings to be updated. They will not survive a full cluster restart
+     */
     public ClusterUpdateSettingsRequestBuilder setTransientSettings(Settings settings) {
         request.transientSettings(settings);
         return this;
     }
 
+    /**
+     * Sets the transient settings to be updated. They will not survive a full cluster restart
+     */
     public ClusterUpdateSettingsRequestBuilder setTransientSettings(Settings.Builder settings) {
         request.transientSettings(settings);
         return this;
     }
 
+    /**
+     * Sets the source containing the transient settings to be updated. They will not survive a full cluster restart
+     */
     public ClusterUpdateSettingsRequestBuilder setTransientSettings(String settings) {
         request.transientSettings(settings);
         return this;
     }
 
+    /**
+     * Sets the transient settings to be updated. They will not survive a full cluster restart
+     */
     public ClusterUpdateSettingsRequestBuilder setTransientSettings(Map settings) {
         request.transientSettings(settings);
         return this;
     }
 
+    /**
+     * Sets the persistent settings to be updated. They will get applied cross restarts
+     */
     public ClusterUpdateSettingsRequestBuilder setPersistentSettings(Settings settings) {
         request.persistentSettings(settings);
         return this;
     }
 
+    /**
+     * Sets the persistent settings to be updated. They will get applied cross restarts
+     */
     public ClusterUpdateSettingsRequestBuilder setPersistentSettings(Settings.Builder settings) {
         request.persistentSettings(settings);
         return this;
     }
 
+    /**
+     * Sets the source containing the persistent settings to be updated. They will get applied cross restarts
+     */
     public ClusterUpdateSettingsRequestBuilder setPersistentSettings(String settings) {
         request.persistentSettings(settings);
         return this;
     }
 
+    /**
+     * Sets the persistent settings to be updated. They will get applied cross restarts
+     */
     public ClusterUpdateSettingsRequestBuilder setPersistentSettings(Map settings) {
         request.persistentSettings(settings);
         return this;

src/main/java/org/elasticsearch/action/admin/cluster/settings/ClusterUpdateSettingsResponse.java

@@ -19,18 +19,19 @@
 
 package org.elasticsearch.action.admin.cluster.settings;
 
-import java.io.IOException;
-
-import org.elasticsearch.action.ActionResponse;
+import org.elasticsearch.Version;
+import org.elasticsearch.action.support.master.AcknowledgedResponse;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.settings.ImmutableSettings;
 import org.elasticsearch.common.settings.Settings;
 
+import java.io.IOException;
+
 /**
  * A response for a cluster update settings action.
  */
-public class ClusterUpdateSettingsResponse extends ActionResponse {
+public class ClusterUpdateSettingsResponse extends AcknowledgedResponse {
 
     Settings transientSettings;
     Settings persistentSettings;
@@ -40,7 +41,8 @@ public class ClusterUpdateSettingsResponse extends ActionResponse {
         this.transientSettings = ImmutableSettings.EMPTY;
     }
 
-    ClusterUpdateSettingsResponse(Settings transientSettings, Settings persistentSettings) {
+    ClusterUpdateSettingsResponse(boolean acknowledged, Settings transientSettings, Settings persistentSettings) {
+        super(acknowledged);
         this.persistentSettings = persistentSettings;
         this.transientSettings = transientSettings;
     }
@@ -50,6 +52,7 @@ public void readFrom(StreamInput in) throws IOException {
         super.readFrom(in);
         transientSettings = ImmutableSettings.readSettingsFromStream(in);
         persistentSettings = ImmutableSettings.readSettingsFromStream(in);
+        readAcknowledged(in, Version.V_0_90_6);
     }
 
     public Settings getTransientSettings() {
@@ -65,5 +68,6 @@ public void writeTo(StreamOutput out) throws IOException {
         super.writeTo(out);
         ImmutableSettings.writeSettingsToStream(transientSettings, out);
         ImmutableSettings.writeSettingsToStream(persistentSettings, out);
+        writeAcknowledged(out, Version.V_0_90_6);
     }
 }