First round feedback on ClusterStatePublisher

Author: ywelsch

server/src/main/java/org/elasticsearch/discovery/ClusterStatePublisher.java renamed to server/src/main/java/org/elasticsearch/cluster/coordination/ClusterStatePublisher.java

@@ -16,39 +16,39 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.elasticsearch.discovery;
+package org.elasticsearch.cluster.coordination;
 
 import org.elasticsearch.action.ActionListener;
 import org.elasticsearch.cluster.ClusterChangedEvent;
 import org.elasticsearch.cluster.node.DiscoveryNode;
 import org.elasticsearch.common.Nullable;
 import org.elasticsearch.common.unit.TimeValue;
+import org.elasticsearch.discovery.FailedToCommitClusterStateException;
 
 public interface ClusterStatePublisher {
     /**
      * Publish all the changes to the cluster from the master (can be called just by the master). The publish
      * process should apply this state to the master as well!
      *
-     * The publishListener allows to wait for the publication to go through.
+     * The publishListener allows to wait for the publication to complete, which can be either successful completion, timing out or failing.
+     * The method is guaranteed to pass back a {@link FailedToCommitClusterStateException} to the publishListener if the change is not
+     * committed and should be rejected. Any other exception signals that something bad happened but the change is committed.
      *
      * The {@link AckListener} allows to keep track of the ack received from nodes, and verify whether
      * they updated their own cluster state or not.
-     *
-     * The method is guaranteed to throw a {@link FailedToCommitClusterStateException} if the change is not committed and should be
-     * rejected. Any other exception signals the something wrong happened but the change is committed.
      */
     void publish(ClusterChangedEvent clusterChangedEvent, ActionListener<Void> publishListener, AckListener ackListener);
 
     interface AckListener {
         /**
-         * Should be called when the discovery layer has committed the clusters state (i.e. even if this publication fails,
+         * Should be called when the cluster coordination layer has committed the cluster state (i.e. even if this publication fails,
          * it is guaranteed to appear in future publications).
          * @param commitTime the time it took to commit the cluster state
          */
         void onCommit(TimeValue commitTime);
 
         /**
-         * Should be called whenever the discovery layer receives confirmation from a node that it has successfully applied
+         * Should be called whenever the cluster coordination layer receives confirmation from a node that it has successfully applied
          * the cluster state. In case of failures, an exception should be provided as parameter.
          * @param node the node
          * @param e the optional exception

server/src/main/java/org/elasticsearch/cluster/service/MasterService.java

@@ -49,7 +49,7 @@
 import org.elasticsearch.common.util.concurrent.FutureUtils;
 import org.elasticsearch.common.util.concurrent.PrioritizedEsThreadPoolExecutor;
 import org.elasticsearch.common.util.concurrent.ThreadContext;
-import org.elasticsearch.discovery.ClusterStatePublisher;
+import org.elasticsearch.cluster.coordination.ClusterStatePublisher;
 import org.elasticsearch.discovery.Discovery;
 import org.elasticsearch.discovery.FailedToCommitClusterStateException;
 import org.elasticsearch.threadpool.ThreadPool;

server/src/main/java/org/elasticsearch/discovery/Discovery.java

@@ -19,6 +19,7 @@
 
 package org.elasticsearch.discovery;
 
+import org.elasticsearch.cluster.coordination.ClusterStatePublisher;
 import org.elasticsearch.common.component.LifecycleComponent;
 
 /**

server/src/main/java/org/elasticsearch/discovery/FailedToCommitClusterStateException.java

@@ -19,6 +19,7 @@
 package org.elasticsearch.discovery;
 
 import org.elasticsearch.ElasticsearchException;
+import org.elasticsearch.cluster.coordination.ClusterStatePublisher;
 import org.elasticsearch.common.io.stream.StreamInput;
 
 import java.io.IOException;

server/src/test/java/org/elasticsearch/cluster/service/MasterServiceTests.java

@@ -42,7 +42,7 @@
 import org.elasticsearch.common.unit.TimeValue;
 import org.elasticsearch.common.util.concurrent.BaseFuture;
 import org.elasticsearch.common.util.concurrent.ThreadContext;
-import org.elasticsearch.discovery.ClusterStatePublisher;
+import org.elasticsearch.cluster.coordination.ClusterStatePublisher;
 import org.elasticsearch.discovery.FailedToCommitClusterStateException;
 import org.elasticsearch.test.ESTestCase;
 import org.elasticsearch.test.MockLogAppender;