SOLR-14680: Deprecating org.apache.solr.cluster.api, includes NamedLi…

…st methods (#2856) NamedList: deprecated methods: forEachEntry, forEachKey, abortableForEachKey, abortableForEach, asMap (no-arg only), get(key, default) -- all come from the SimpleMap interface. Added getOrDefault. Deprecated the SimpleMap interface as well as the entirety of the SolrJ package org.apache.solr.cluster.api, which wasn't used except for SimpleMap. Includes some trivial refactorings to not call those deprecated methods. Includes internal changes to ConfigNode and friends so as to not use SimpleMap. (cherry picked from commit c80d415)
apache · Dec 10, 2024 · 364c0af · 364c0af
1 parent 5395ede
commit 364c0af
Show file tree

Hide file tree

Showing 39 changed files with 174 additions and 104 deletions.
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
@@ -173,6 +173,10 @@ led to the suppression of exceptions. (Andrey Bozhko)
 
 * SOLR-16781: "<lib/>" tags in solrconfig.xml are now quietly ignored by default unless explicitly enabled with the `SOLR_CONFIG_LIB_ENABLED=true` enviroment variable (or corresponding sysprop).  These tags are now considered deprecated and will be removed in Solr 10.
 
+* SOLR-14680: NamedList: deprecating methods: forEachEntry, forEachKey, abortableForEachKey, abortableForEach,
+ asMap (no-arg only), get(key, default).  Added getOrDefault.  Deprecated the SimpleMap interface as well as the
+ entirety of the SolrJ package org.apache.solr.cluster.api, which wasn't used except for SimpleMap.  (David Smiley)
+
 ==================  9.7.1 ==================
 Bug Fixes
 ---------------------

diff --git a/solr/core/src/java/org/apache/solr/cli/ApiTool.java b/solr/core/src/java/org/apache/solr/cli/ApiTool.java
@@ -108,7 +108,7 @@ protected String callGet(String url) throws Exception {
       NamedList<Object> response = solrClient.request(req);
       // pretty-print the response to stdout
       CharArr arr = new CharArr();
-      new JSONWriter(arr, 2).write(response.asMap());
+      new JSONWriter(arr, 2).write(response.asMap(10));
       return arr.toString();
     }
   }

diff --git a/solr/core/src/java/org/apache/solr/cli/CreateTool.java b/solr/core/src/java/org/apache/solr/cli/CreateTool.java
@@ -23,7 +23,6 @@
 import java.nio.file.Paths;
 import java.util.List;
 import java.util.Locale;
-import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.TimeUnit;
 import org.apache.commons.cli.CommandLine;
@@ -219,10 +218,9 @@ protected void createCore(CommandLine cli, SolrClient solrClient) throws Excepti
 
     String coreRootDirectory; // usually same as solr home, but not always
 
-    Map<String, Object> systemInfo =
-        solrClient
-            .request(new GenericSolrRequest(SolrRequest.METHOD.GET, CommonParams.SYSTEM_INFO_PATH))
-            .asMap();
+    NamedList<?> systemInfo =
+        solrClient.request(
+            new GenericSolrRequest(SolrRequest.METHOD.GET, CommonParams.SYSTEM_INFO_PATH));
 
     // convert raw JSON into user-friendly output
     coreRootDirectory = (String) systemInfo.get("core_root");
@@ -375,7 +373,7 @@ protected void createCollection(CloudSolrClient cloudSolrClient, CommandLine cli
     if (verbose) {
       // pretty-print the response to stdout
       CharArr arr = new CharArr();
-      new JSONWriter(arr, 2).write(response.asMap());
+      new JSONWriter(arr, 2).write(response.asMap(10));
       echo(arr.toString());
     }
     String endMessage =

diff --git a/solr/core/src/java/org/apache/solr/cli/DeleteTool.java b/solr/core/src/java/org/apache/solr/cli/DeleteTool.java
@@ -296,7 +296,7 @@ protected void deleteCollection(CloudSolrClient cloudSolrClient, CommandLine cli
     if (response != null) {
       // pretty-print the response to stdout
       CharArr arr = new CharArr();
-      new JSONWriter(arr, 2).write(response.asMap());
+      new JSONWriter(arr, 2).write(response.asMap(10));
       echo(arr.toString());
       echo("\n");
     }

diff --git a/solr/core/src/java/org/apache/solr/cli/StatusTool.java b/solr/core/src/java/org/apache/solr/cli/StatusTool.java
@@ -365,13 +365,14 @@ protected Map<String, String> getCloudStatus(SolrClient solrClient, String zkHos
     Map<String, String> cloudStatus = new LinkedHashMap<>();
     cloudStatus.put("ZooKeeper", (zkHost != null) ? zkHost : "?");
 
+    // TODO add booleans to request just what we want; not everything
     NamedList<Object> json = solrClient.request(new CollectionAdminRequest.ClusterStatus());
 
     List<String> liveNodes = (List<String>) json.findRecursive("cluster", "live_nodes");
     cloudStatus.put("liveNodes", String.valueOf(liveNodes.size()));
 
-    Map<String, Object> collections =
-        ((NamedList<Object>) json.findRecursive("cluster", "collections")).asMap();
+    // TODO get this as a metric from the metrics API instead, or something else.
+    var collections = (NamedList<Object>) json.findRecursive("cluster", "collections");
     cloudStatus.put("collections", String.valueOf(collections.size()));
 
     return cloudStatus;

diff --git a/solr/core/src/java/org/apache/solr/core/OverlaidConfigNode.java b/solr/core/src/java/org/apache/solr/core/OverlaidConfigNode.java
@@ -19,9 +19,9 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.function.Function;
 import java.util.function.Predicate;
-import org.apache.solr.cluster.api.SimpleMap;
 import org.apache.solr.common.ConfigNode;
 
 /** A config node impl which has an overlay */
@@ -80,7 +80,7 @@ public String name() {
   }
 
   @Override
-  public SimpleMap<String> attributes() {
+  public Map<String, String> attributes() {
     return delegate.attributes();
   }
 

diff --git a/solr/core/src/java/org/apache/solr/core/PluginInfo.java b/solr/core/src/java/org/apache/solr/core/PluginInfo.java
@@ -118,7 +118,7 @@ public PluginInfo(ConfigNode node, String err, boolean requireName, boolean requ
     className = cName.className;
     pkgName = cName.pkg;
     initArgs = DOMUtil.childNodesToNamedList(node);
-    attributes = node.attributes().asMap();
+    attributes = node.attributes();
     children = loadSubPlugins(node);
     isFromSolrConfig = true;
   }

diff --git a/solr/core/src/java/org/apache/solr/core/SolrXmlConfig.java b/solr/core/src/java/org/apache/solr/core/SolrXmlConfig.java
@@ -31,6 +31,7 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Map.Entry;
 import java.util.Properties;
 import java.util.Set;
 import java.util.function.Consumer;
@@ -141,10 +142,10 @@ public static NodeConfig fromConfig(
     // since it is arranged as a separate section it is placed here
     Map<String, String> coreAdminHandlerActions =
         readNodeListAsNamedList(root.get("coreAdminHandlerActions"), "<coreAdminHandlerActions>")
-            .asMap()
+            .asShallowMap()
             .entrySet()
             .stream()
-            .collect(Collectors.toMap(item -> item.getKey(), item -> item.getValue().toString()));
+            .collect(Collectors.toMap(Entry::getKey, item -> item.getValue().toString()));
 
     UpdateShardHandlerConfig updateConfig;
     if (deprecatedUpdateConfig == null) {
@@ -752,7 +753,7 @@ private static MetricsConfig getMetricsConfig(ConfigNode metrics) {
     ConfigNode caching = metrics.get("solr/metrics/caching");
     if (caching != null) {
       Object threadsCachingIntervalSeconds =
-          DOMUtil.childNodesToNamedList(caching).get("threadsIntervalSeconds", null);
+          DOMUtil.childNodesToNamedList(caching).get("threadsIntervalSeconds");
       builder.setCacheConfig(
           new MetricsConfig.CacheConfig(
               threadsCachingIntervalSeconds == null

diff --git a/solr/core/src/java/org/apache/solr/schema/IndexSchema.java b/solr/core/src/java/org/apache/solr/schema/IndexSchema.java
@@ -526,7 +526,7 @@ protected void readSchema(ConfigSetService.ConfigResource is) {
         log.info("{}", sb);
       }
 
-      version = Float.parseFloat(rootNode.attributes().get("version", "1.0f"));
+      version = Float.parseFloat(rootNode.attributes().getOrDefault("version", "1.0f"));
 
       // load the Field Types
       final FieldTypePluginLoader typeLoader =

diff --git a/solr/core/src/java/org/apache/solr/search/CacheConfig.java b/solr/core/src/java/org/apache/solr/search/CacheConfig.java
@@ -87,7 +87,7 @@ public static Map<String, CacheConfig> getMultipleConfigs(
     for (ConfigNode node : nodes) {
       if (node.boolAttr("enabled", true)) {
         CacheConfig config =
-            getConfig(loader, solrConfig, node.name(), node.attributes().asMap(), configPath);
+            getConfig(loader, solrConfig, node.name(), node.attributes(), configPath);
         result.put(config.args.get(NAME), config);
       }
     }
@@ -98,7 +98,7 @@ public static CacheConfig getConfig(SolrConfig solrConfig, ConfigNode node, Stri
     if (!node.boolAttr("enabled", true) || !node.exists()) {
       return null;
     }
-    return getConfig(solrConfig, node.name(), node.attributes().asMap(), xpath);
+    return getConfig(solrConfig, node.name(), node.attributes(), xpath);
   }
 
   public static CacheConfig getConfig(

diff --git a/solr/core/src/java/org/apache/solr/update/UpdateLog.java b/solr/core/src/java/org/apache/solr/update/UpdateLog.java
@@ -391,7 +391,8 @@ public void init(PluginInfo info) {
     }
     int timeoutMs =
         objToInt(
-            info.initArgs.get("docLockTimeoutMs", info.initArgs.get("versionBucketLockTimeoutMs")),
+            info.initArgs.getOrDefault(
+                "docLockTimeoutMs", info.initArgs.get("versionBucketLockTimeoutMs")),
             EnvUtils.getPropertyAsLong("solr.update.docLockTimeoutMs", 0L).intValue());
     updateLocks = new UpdateLocks(timeoutMs);
 

diff --git a/solr/core/src/java/org/apache/solr/util/DOMConfigNode.java b/solr/core/src/java/org/apache/solr/util/DOMConfigNode.java
@@ -18,22 +18,19 @@
 package org.apache.solr.util;
 
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Function;
-import org.apache.solr.cluster.api.SimpleMap;
 import org.apache.solr.common.ConfigNode;
 import org.apache.solr.common.util.DOMUtil;
-import org.apache.solr.common.util.WrappedSimpleMap;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
 /** Read using DOM */
 public class DOMConfigNode implements ConfigNode {
 
   private final Node node;
-  SimpleMap<String> attrs;
+  Map<String, String> attrs;
 
   @Override
   public String name() {
@@ -50,10 +47,10 @@ public DOMConfigNode(Node node) {
   }
 
   @Override
-  public SimpleMap<String> attributes() {
+  public Map<String, String> attributes() {
     if (attrs != null) return attrs;
     Map<String, String> attrs = DOMUtil.toMap(node.getAttributes());
-    return this.attrs = attrs.size() == 0 ? EMPTY : new WrappedSimpleMap<>(attrs);
+    return this.attrs = attrs.isEmpty() ? Map.of() : attrs;
   }
 
   @Override
@@ -85,6 +82,4 @@ public void forEachChild(Function<ConfigNode, Boolean> fun) {
       if (Boolean.FALSE.equals(toContinue)) break;
     }
   }
-
-  private static final SimpleMap<String> EMPTY = new WrappedSimpleMap<>(Collections.emptyMap());
 }