SOLR-18234: Reorganize org.apache.solr.cli into domain-based sub-packages

changelog/unreleased/SOLR-18234-solr-cli-reorganise.yml

@@ -0,0 +1,8 @@
+title: Reorganize org.apache.solr.cli into domain-based sub-packages
+type: other
+authors:
+  - name: Jalaz Kumar
+    nick: jaykay12
+links:
+  - name: SOLR-18234
+    url: https://issues.apache.org/jira/browse/SOLR-18234

solr/core/src/java/org/apache/solr/cli/CLIUtils.java

@@ -33,6 +33,7 @@
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Option;
 import org.apache.commons.exec.OS;
+import org.apache.solr.cli.tools.cluster.StatusTool;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.SolrServerException;
 import org.apache.solr.client.solrj.impl.CloudSolrClient;

solr/core/src/java/org/apache/solr/cli/ConnectionOptions.java

@@ -27,7 +27,7 @@
  * ensure the user provides at most one of {@code --solr-connection}, {@code --solr-url} or {@code
  * --zk-host}.
  */
-class ConnectionOptions {
+public class ConnectionOptions {
   @CommandLine.Option(
       names = {"-s", "--solr-connection"},
       description =
@@ -54,7 +54,7 @@ class ConnectionOptions {
    * The effective ZooKeeper connection string, taking {@code --solr-connection} into account, or
    * null if the user targeted Solr via a URL (or gave no target at all).
    */
-  String effectiveZkHost() throws IOException {
+  public String effectiveZkHost() throws IOException {
     if (solrConnection != null) {
       var connection = CloudSolrClient.CloudSolrClientConnection.parse(solrConnection);
       return connection.isZookeeper() ? solrConnection : null;
@@ -66,7 +66,7 @@ String effectiveZkHost() throws IOException {
    * The effective Solr URL, taking {@code --solr-connection} into account, or null if the user
    * targeted ZooKeeper (or gave no target at all).
    */
-  String effectiveSolrUrl() throws IOException {
+  public String effectiveSolrUrl() throws IOException {
     if (solrConnection != null) {
       var connection = CloudSolrClient.CloudSolrClientConnection.parse(solrConnection);
       return connection.isZookeeper() ? null : connection.quorumItems().get(0);

solr/core/src/java/org/apache/solr/cli/SolrCLI.java

@@ -42,6 +42,37 @@
 import org.apache.commons.cli.help.HelpFormatter;
 import org.apache.commons.cli.help.TableDefinition;
 import org.apache.commons.cli.help.TextHelpAppendable;
+import org.apache.solr.cli.tools.ApiTool;
+import org.apache.solr.cli.tools.AssertTool;
+import org.apache.solr.cli.tools.AuthTool;
+import org.apache.solr.cli.tools.ConfigTool;
+import org.apache.solr.cli.tools.CreateTool;
+import org.apache.solr.cli.tools.DeleteTool;
+import org.apache.solr.cli.tools.ExportTool;
+import org.apache.solr.cli.tools.PostLogsTool;
+import org.apache.solr.cli.tools.PostTool;
+import org.apache.solr.cli.tools.RunExampleTool;
+import org.apache.solr.cli.tools.StreamTool;
+import org.apache.solr.cli.tools.VersionTool;
+import org.apache.solr.cli.tools.cluster.ClusterTool;
+import org.apache.solr.cli.tools.cluster.HealthcheckTool;
+import org.apache.solr.cli.tools.cluster.StatusTool;
+import org.apache.solr.cli.tools.pkg.PackageTool;
+import org.apache.solr.cli.tools.snapshot.SnapshotCreateTool;
+import org.apache.solr.cli.tools.snapshot.SnapshotDeleteTool;
+import org.apache.solr.cli.tools.snapshot.SnapshotDescribeTool;
+import org.apache.solr.cli.tools.snapshot.SnapshotExportTool;
+import org.apache.solr.cli.tools.snapshot.SnapshotListTool;
+import org.apache.solr.cli.tools.zk.ConfigSetDownloadTool;
+import org.apache.solr.cli.tools.zk.ConfigSetUploadTool;
+import org.apache.solr.cli.tools.zk.UpdateACLTool;
+import org.apache.solr.cli.tools.zk.ZkCpTool;
+import org.apache.solr.cli.tools.zk.ZkLsTool;
+import org.apache.solr.cli.tools.zk.ZkMkrootTool;
+import org.apache.solr.cli.tools.zk.ZkMvTool;
+import org.apache.solr.cli.tools.zk.ZkRmTool;
+import org.apache.solr.cli.tools.zk.ZkTool;
+import org.apache.solr.cli.tools.zk.ZkToolHelp;
 import org.apache.solr.client.api.util.SolrVersion;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.request.ContentWriterUpdateRequest;

solr/core/src/java/org/apache/solr/cli/SolrProcessManager.java → solr/core/src/java/org/apache/solr/cli/process/SolrProcessManager.java

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.solr.cli;
+package org.apache.solr.cli.process;
 
 import static org.apache.solr.servlet.CoreContainerProvider.SOLR_INSTALL_DIR;
 

solr/core/src/java/org/apache/solr/cli/process/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * 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.
+ */
+
+/** Utilities for discovering and managing Solr OS processes. */
+package org.apache.solr.cli.process;

solr/core/src/java/org/apache/solr/cli/ApiTool.java → solr/core/src/java/org/apache/solr/cli/tools/ApiTool.java

@@ -15,12 +15,16 @@
  * limitations under the License.
  */
 
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import java.net.URI;
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
 import org.apache.solr.client.solrj.SolrRequest;
 import org.apache.solr.client.solrj.request.GenericSolrRequest;
 import org.apache.solr.client.solrj.response.InputStreamResponseParser;
@@ -77,7 +81,7 @@ void callApi(ApiParams params) throws Exception {
     echo(response);
   }
 
-  protected String callGet(String url, String credentials) throws Exception {
+  public String callGet(String url, String credentials) throws Exception {
     URI uri = new URI(url.replace("+", "%20"));
     String solrUrl = getSolrUrlFromUri(uri);
     String path = uri.getPath();

solr/core/src/java/org/apache/solr/cli/AssertTool.java → solr/core/src/java/org/apache/solr/cli/tools/AssertTool.java

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import java.io.IOException;
 import java.lang.invoke.MethodHandles;
@@ -28,6 +28,12 @@
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.OptionGroup;
 import org.apache.commons.cli.Options;
+import org.apache.solr.cli.CLIO;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
+import org.apache.solr.cli.tools.cluster.StatusTool;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.SolrServerException;
 import org.apache.solr.client.solrj.request.HealthCheckRequest;

solr/core/src/java/org/apache/solr/cli/AuthTool.java → solr/core/src/java/org/apache/solr/cli/tools/AuthTool.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -38,6 +38,13 @@
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
 import org.apache.lucene.util.Constants;
+import org.apache.solr.cli.CLIO;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.DefaultToolRuntime;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
+import org.apache.solr.cli.tools.zk.ZkConnectionOptions;
 import org.apache.solr.client.solrj.impl.SolrZkClientTimeout;
 import org.apache.solr.common.cloud.SolrZkClient;
 import org.apache.solr.common.util.EnvUtils;

solr/core/src/java/org/apache/solr/cli/ConfigTool.java → solr/core/src/java/org/apache/solr/cli/tools/ConfigTool.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import java.util.HashMap;
 import java.util.List;
@@ -24,6 +24,11 @@
 import org.apache.commons.cli.MissingArgumentException;
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.SolrCLI;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.common.util.NamedList;
 import org.noggit.CharArr;

solr/core/src/java/org/apache/solr/cli/CreateTool.java → solr/core/src/java/org/apache/solr/cli/tools/CreateTool.java

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import java.io.IOException;
 import java.nio.file.Files;
@@ -28,7 +28,16 @@
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
 import org.apache.commons.io.file.PathUtils;
+import org.apache.solr.cli.CLIO;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
 import org.apache.solr.cli.CommonCLIOptions.DefaultValues;
+import org.apache.solr.cli.ConnectionOptions;
+import org.apache.solr.cli.CredentialsOptions;
+import org.apache.solr.cli.DefaultToolRuntime;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
+import org.apache.solr.cli.tools.cluster.StatusTool;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.SolrServerException;
 import org.apache.solr.client.solrj.impl.CloudSolrClient;

solr/core/src/java/org/apache/solr/cli/DeleteTool.java → solr/core/src/java/org/apache/solr/cli/tools/DeleteTool.java

@@ -14,13 +14,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import java.util.Locale;
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.DeprecatedAttributes;
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
+import org.apache.solr.cli.CLIO;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.ConnectionOptions;
+import org.apache.solr.cli.CredentialsOptions;
+import org.apache.solr.cli.DefaultToolRuntime;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
 import org.apache.solr.client.solrj.RemoteSolrException;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.SolrServerException;

solr/core/src/java/org/apache/solr/cli/ExportTool.java → solr/core/src/java/org/apache/solr/cli/tools/ExportTool.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import static org.apache.solr.common.params.CommonParams.FL;
 import static org.apache.solr.common.params.CommonParams.JAVABIN;
@@ -54,6 +54,10 @@
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
 import org.apache.lucene.util.SuppressForbidden;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.SolrRequest;
 import org.apache.solr.client.solrj.SolrServerException;

solr/core/src/java/org/apache/solr/cli/PostLogsTool.java → solr/core/src/java/org/apache/solr/cli/tools/PostLogsTool.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import java.io.BufferedReader;
 import java.io.IOException;
@@ -36,6 +36,11 @@
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
+import org.apache.solr.cli.CLIO;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.jetty.HttpJettySolrClient;
 import org.apache.solr.client.solrj.request.UpdateRequest;

solr/core/src/java/org/apache/solr/cli/PostTool.java → solr/core/src/java/org/apache/solr/cli/tools/PostTool.java

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import static java.nio.charset.StandardCharsets.US_ASCII;
 import static java.nio.charset.StandardCharsets.UTF_8;
@@ -71,6 +71,11 @@
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
 import org.apache.commons.io.output.NullOutputStream;
+import org.apache.solr.cli.CLIO;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
 import org.apache.solr.client.api.util.SolrVersion;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.SolrServerException;

solr/core/src/java/org/apache/solr/cli/RunExampleTool.java → solr/core/src/java/org/apache/solr/cli/tools/RunExampleTool.java

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
@@ -43,6 +43,13 @@
 import org.apache.commons.exec.Executor;
 import org.apache.commons.exec.environment.EnvironmentUtils;
 import org.apache.commons.io.file.PathUtils;
+import org.apache.solr.cli.CLIO;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.SolrCLI;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
+import org.apache.solr.cli.tools.cluster.StatusTool;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.impl.CloudSolrClient;
 import org.apache.solr.common.SolrException;

solr/core/src/java/org/apache/solr/cli/StreamTool.java → solr/core/src/java/org/apache/solr/cli/tools/StreamTool.java

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import java.io.BufferedReader;
 import java.io.FileInputStream;
@@ -37,6 +37,11 @@
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
+import org.apache.solr.cli.CLIO;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
 import org.apache.solr.client.solrj.impl.CloudSolrClient;
 import org.apache.solr.client.solrj.io.SolrClientCache;
 import org.apache.solr.client.solrj.io.Tuple;

solr/core/src/java/org/apache/solr/cli/VersionTool.java → solr/core/src/java/org/apache/solr/cli/tools/VersionTool.java

@@ -15,10 +15,17 @@
  * limitations under the License.
  */
 
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools;
 
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Options;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.ConnectionOptions;
+import org.apache.solr.cli.CredentialsOptions;
+import org.apache.solr.cli.DefaultToolRuntime;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
 import org.apache.solr.client.api.util.SolrVersion;
 import org.apache.solr.client.solrj.request.SystemInfoRequest;
 import org.apache.solr.client.solrj.response.SystemInfoResponse;

solr/core/src/java/org/apache/solr/cli/ClusterTool.java → solr/core/src/java/org/apache/solr/cli/tools/cluster/ClusterTool.java

@@ -15,13 +15,17 @@
  * limitations under the License.
  */
 
-package org.apache.solr.cli;
+package org.apache.solr.cli.tools.cluster;
 
 import java.io.IOException;
 import java.util.concurrent.TimeUnit;
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
+import org.apache.solr.cli.CLIUtils;
+import org.apache.solr.cli.CommonCLIOptions;
+import org.apache.solr.cli.ToolBase;
+import org.apache.solr.cli.ToolRuntime;
 import org.apache.solr.client.solrj.impl.SolrZkClientTimeout;
 import org.apache.solr.cloud.ZkController;
 import org.apache.solr.common.cloud.ClusterProperties;