[GitHub] [lucene-solr] HoustonPutman commented on a change in pull request #1071: SOLR-14003: Refactor code to avoid reading state from Replica/Slic

[GitBox <gi...@apache.org>]

HoustonPutman commented on a change in pull request #1071: SOLR-14003: Refactor code to avoid reading state from Replica/Slic
URL: https://github.com/apache/lucene-solr/pull/1071#discussion_r357705214
 
 

 ##########
 File path: solr/solrj/src/java/org/apache/solr/client/solrj/cloud/ShardStateProvider.java
 ##########
 @@ -0,0 +1,56 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.solr.client.solrj.cloud;
+
+import org.apache.solr.common.cloud.Replica;
+import org.apache.solr.common.cloud.Slice;
+/**An implementation that fetches the state of each replica/slice and leaders of shards in a collection.
+ * The state is embedded with other topology information in state.json in the original SolrCLoud design.
+ * But, it is possible to have another implementation where the state and leader information can be stored and read
+ * from other places.
+ *
+ */
+public interface ShardStateProvider {
+
+  /**Get the state of  a given {@link Replica}
+   */
+  Replica.State getState(Replica replica);
+
+  /**Get the leader {@link Replica} of the shard
+   */
+  Replica getLeader(Slice slice);
+
+  /**Get the leader of the slice. Wait for one if there is no leader
+   * @param timeout how much time to wait for a leader to com eup. -1 means the default value will be used
+   * Throws an {@link InterruptedException} if interrupted in between
+   */
+  Replica getLeader(Slice slice, int timeout) throws InterruptedException;
+
+
+  Replica getLeader(String collection, String slice, int timeout) throws InterruptedException;
+
+
+  /**CHeck if the replica is active
+   *
+   */
+  boolean isActive(Replica replica);
 
 Review comment:
   I think that this needs additional documentation stating whether the method returns true if the node which the replica is on is live or not.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org