SOLR-18072: Refactor CollectionApiCommands to add expandable context (#4046)

Author: HoustonPutman

changelog/unreleased/solr-18072-refactor-admin-cmd-apis.yml

@@ -0,0 +1,11 @@
+# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+title: Refactor CollectionApiCommands to add easily expandable AdminCmdContext argument
+type: other # added, changed, fixed, deprecated, removed, dependency_update, security, other
+authors:
+  - name: Houston Putman
+    nick: HoustonPutman
+  - name: David Smiley
+  - name: Jason Gerlowski
+links:
+  - name: SOLR-18072
+    url: https://issues.apache.org/jira/browse/SOLR-18072

gradle/validation/validate-source-patterns.gradle

@@ -209,7 +209,7 @@ class ValidateSourcePatternsTask extends DefaultTask {
     }
 
     def checkMockitoAssume = {f, text ->
-      if (text.contains("mockito") && !text.contains("assumeWorkingMockito()")) {
+      if (text.contains("mockito") && !(text.contains("assumeWorkingMockito()") || text.contains("extends MockV2APITest"))) {
         reportViolation(f, 'File uses Mockito but has no assumeWorkingMockito() call')
       }
     }

solr/api/src/java/org/apache/solr/client/api/endpoint/AliasPropertyApis.java

@@ -24,6 +24,7 @@
 import jakarta.ws.rs.PUT;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.PathParam;
+import org.apache.solr.client.api.model.AsyncJerseyResponse;
 import org.apache.solr.client.api.model.GetAliasPropertyResponse;
 import org.apache.solr.client.api.model.GetAllAliasPropertiesResponse;
 import org.apache.solr.client.api.model.SolrJerseyResponse;
@@ -56,7 +57,7 @@ GetAliasPropertyResponse getAliasProperty(
   @Operation(
       summary = "Update properties for a collection alias.",
       tags = {"alias-properties"})
-  SolrJerseyResponse updateAliasProperties(
+  AsyncJerseyResponse updateAliasProperties(
       @Parameter(description = "Alias Name") @PathParam("aliasName") String aliasName,
       @RequestBody(description = "Properties that need to be updated", required = true)
           UpdateAliasPropertiesRequestBody requestBody)

solr/api/src/java/org/apache/solr/client/api/endpoint/BalanceReplicasApi.java

@@ -21,15 +21,15 @@
 import jakarta.ws.rs.POST;
 import jakarta.ws.rs.Path;
 import org.apache.solr.client.api.model.BalanceReplicasRequestBody;
-import org.apache.solr.client.api.model.SolrJerseyResponse;
+import org.apache.solr.client.api.model.SubResponseAccumulatingJerseyResponse;
 
 @Path("cluster/replicas/balance")
 public interface BalanceReplicasApi {
   @POST
   @Operation(
       summary = "Balance Replicas across the given set of Nodes.",
       tags = {"cluster"})
-  SolrJerseyResponse balanceReplicas(
+  SubResponseAccumulatingJerseyResponse balanceReplicas(
       @RequestBody(description = "Contains user provided parameters")
           BalanceReplicasRequestBody requestBody)
       throws Exception;

solr/api/src/java/org/apache/solr/client/api/endpoint/CreateAliasApi.java

@@ -19,14 +19,14 @@
 import io.swagger.v3.oas.annotations.Operation;
 import jakarta.ws.rs.POST;
 import jakarta.ws.rs.Path;
+import org.apache.solr.client.api.model.AsyncJerseyResponse;
 import org.apache.solr.client.api.model.CreateAliasRequestBody;
-import org.apache.solr.client.api.model.SolrJerseyResponse;
 
 @Path("/aliases")
 public interface CreateAliasApi {
   @POST
   @Operation(
       summary = "Create a traditional or 'routed' alias",
       tags = {"aliases"})
-  SolrJerseyResponse createAlias(CreateAliasRequestBody requestBody) throws Exception;
+  AsyncJerseyResponse createAlias(CreateAliasRequestBody requestBody) throws Exception;
 }

solr/api/src/java/org/apache/solr/client/api/endpoint/DeleteAliasApi.java

@@ -23,7 +23,7 @@
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.PathParam;
 import jakarta.ws.rs.QueryParam;
-import org.apache.solr.client.api.model.SolrJerseyResponse;
+import org.apache.solr.client.api.model.AsyncJerseyResponse;
 
 @Path("/aliases/{aliasName}")
 public interface DeleteAliasApi {
@@ -32,7 +32,7 @@ public interface DeleteAliasApi {
   @Operation(
       summary = "Deletes an alias by its name",
       tags = {"aliases"})
-  SolrJerseyResponse deleteAlias(
+  AsyncJerseyResponse deleteAlias(
       @Parameter(description = "The name of the alias to delete", required = true)
           @PathParam("aliasName")
           String aliasName,

solr/api/src/java/org/apache/solr/client/api/endpoint/DeleteNodeApi.java

@@ -24,7 +24,7 @@
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.PathParam;
 import org.apache.solr.client.api.model.DeleteNodeRequestBody;
-import org.apache.solr.client.api.model.SolrJerseyResponse;
+import org.apache.solr.client.api.model.SubResponseAccumulatingJerseyResponse;
 
 @Path("cluster/nodes/{nodeName}/clear/")
 public interface DeleteNodeApi {
@@ -33,7 +33,7 @@ public interface DeleteNodeApi {
   @Operation(
       summary = "Delete all replicas off of the specified SolrCloud node",
       tags = {"node"})
-  SolrJerseyResponse deleteNode(
+  SubResponseAccumulatingJerseyResponse deleteNode(
       @Parameter(
               description =
                   "The name of the node to be cleared.  Usually of the form 'host:1234_solr'.",

solr/api/src/java/org/apache/solr/client/api/endpoint/InstallShardDataApi.java

@@ -21,7 +21,7 @@
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.PathParam;
 import org.apache.solr.client.api.model.InstallShardDataRequestBody;
-import org.apache.solr.client.api.model.SolrJerseyResponse;
+import org.apache.solr.client.api.model.SubResponseAccumulatingJerseyResponse;
 
 /** V2 API definition allowing users to import offline-constructed index into a shard. */
 @Path("/collections/{collName}/shards/{shardName}/install")
@@ -30,7 +30,7 @@ public interface InstallShardDataApi {
   @Operation(
       summary = "Install offline index into an existing shard",
       tags = {"shards"})
-  SolrJerseyResponse installShardData(
+  SubResponseAccumulatingJerseyResponse installShardData(
       @PathParam("collName") String collName,
       @PathParam("shardName") String shardName,
       InstallShardDataRequestBody requestBody)

solr/api/src/java/org/apache/solr/client/api/endpoint/MigrateReplicasApi.java

@@ -21,7 +21,7 @@
 import jakarta.ws.rs.POST;
 import jakarta.ws.rs.Path;
 import org.apache.solr.client.api.model.MigrateReplicasRequestBody;
-import org.apache.solr.client.api.model.SolrJerseyResponse;
+import org.apache.solr.client.api.model.SubResponseAccumulatingJerseyResponse;
 
 /** V2 API definition for migrating replicas from a set of nodes to another set of nodes. */
 @Path("cluster/replicas/migrate")
@@ -30,7 +30,7 @@ public interface MigrateReplicasApi {
   @Operation(
       summary = "Migrate Replicas from a given set of nodes.",
       tags = {"cluster"})
-  SolrJerseyResponse migrateReplicas(
+  SubResponseAccumulatingJerseyResponse migrateReplicas(
       @RequestBody(description = "Contains user provided parameters", required = true)
           MigrateReplicasRequestBody requestBody)
       throws Exception;

solr/api/src/java/org/apache/solr/client/api/endpoint/ReplaceNodeApi.java

@@ -23,7 +23,7 @@
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.PathParam;
 import org.apache.solr.client.api.model.ReplaceNodeRequestBody;
-import org.apache.solr.client.api.model.SolrJerseyResponse;
+import org.apache.solr.client.api.model.SubResponseAccumulatingJerseyResponse;
 
 /**
  * V2 API definition for recreating replicas in one node (the source) on another node(s) (the
@@ -35,7 +35,7 @@ public interface ReplaceNodeApi {
   @Operation(
       summary = "'Replace' a specified node by moving all replicas elsewhere",
       tags = {"node"})
-  SolrJerseyResponse replaceNode(
+  SubResponseAccumulatingJerseyResponse replaceNode(
       @Parameter(description = "The name of the node to be replaced.", required = true)
           @PathParam("sourceNodeName")
           String sourceNodeName,