SOLR-16390: v2 Cluster Property APIs.

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

@@ -0,0 +1,38 @@
+/*
+ * 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.api.endpoint;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import jakarta.ws.rs.DELETE;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import org.apache.solr.client.api.model.SolrJerseyResponse;
+
+/** V2 API definition for deleting a cluster property. */
+@Path("/cluster/properties/{propertyName}")
+public interface DeleteClusterPropertyApi {
+  @DELETE
+  @Operation(
+      summary = "Delete a cluster property in this Solr cluster",
+      tags = {"cluster-properties"})
+  SolrJerseyResponse deleteClusterProperty(
+      @Parameter(description = "The name of the property being deleted.", required = true)
+          @PathParam("propertyName")
+          String propertyName);
+}

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

@@ -0,0 +1,38 @@
+/*
+ * 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.api.endpoint;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import org.apache.solr.client.api.model.SolrJerseyResponse;
+
+/** V2 API definition for returning the value of a cluster property. */
+@Path("/cluster/properties/{propertyName}")
+public interface GetClusterPropertyApi {
+  @GET
+  @Operation(
+      summary = "Get a cluster property in this Solr cluster",
+      tags = {"cluster-properties"})
+  SolrJerseyResponse getClusterProperty(
+      @Parameter(description = "The name of the property being retrieved.", required = true)
+          @PathParam("propertyName")
+          String propertyName);
+}

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

@@ -0,0 +1,33 @@
+/*
+ * 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.api.endpoint;
+
+import io.swagger.v3.oas.annotations.Operation;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import org.apache.solr.client.api.model.ListClusterPropertiesResponse;
+
+/** V2 API definition for listing cluster properties. */
+@Path("/cluster/properties")
+public interface ListClusterPropertiesApi {
+  @GET
+  @Operation(
+      summary = "List all cluster properties in this Solr cluster",
+      tags = {"cluster-properties"})
+  ListClusterPropertiesResponse listClusterProperties();
+}

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

@@ -0,0 +1,43 @@
+/*
+ * 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.api.endpoint;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.parameters.RequestBody;
+import jakarta.ws.rs.PUT;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import org.apache.solr.client.api.model.SetClusterPropertyRequestBody;
+import org.apache.solr.client.api.model.SolrJerseyResponse;
+
+@Path("/cluster/properties/{propertyName}")
+public interface SetClusterPropertyApi {
+
+  @PUT
+  @Operation(
+      summary = "Set a cluster property in this Solr cluster",
+      tags = {"cluster-properties"})
+  SolrJerseyResponse createOrUpdateClusterProperty(
+      @Parameter(description = "The name of the property being set.", required = true)
+          @PathParam("propertyName")
+          String propertyName,
+      @RequestBody(description = "Value to set for the property", required = true)
+          SetClusterPropertyRequestBody requestBody)
+      throws Exception;
+}

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

@@ -0,0 +1,38 @@
+/*
+ * 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.api.endpoint;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.parameters.RequestBody;
+import jakarta.ws.rs.PUT;
+import jakarta.ws.rs.Path;
+import org.apache.solr.client.api.model.SetNestedClusterPropertyRequestBody;
+import org.apache.solr.client.api.model.SolrJerseyResponse;
+
+@Path("/cluster/properties")
+public interface SetNestedClusterPropertyApi {
+
+  @PUT
+  @Operation(
+      summary = "Set nested cluster properties in this Solr cluster",
+      tags = {"cluster-properties"})
+  SolrJerseyResponse createOrUpdateNestedClusterProperty(
+      @RequestBody(description = "Property/ies to be set", required = true)
+          SetNestedClusterPropertyRequestBody requestBody)
+      throws Exception;
+}

solr/api/src/java/org/apache/solr/client/api/model/ClusterPropertyDetails.java

@@ -0,0 +1,31 @@
+/*
+ * 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.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+public class ClusterPropertyDetails {
+  @JsonProperty("name")
+  @Schema(description = "The name of the cluster property.")
+  public String name;
+
+  @JsonProperty("value")
+  @Schema(description = "The value of the cluster property.")
+  public Object value;
+}

solr/api/src/java/org/apache/solr/client/api/model/GetClusterPropertyResponse.java

@@ -0,0 +1,27 @@
+/*
+ * 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.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+public class GetClusterPropertyResponse extends SolrJerseyResponse {
+  @JsonProperty("clusterProperty")
+  @Schema(description = "The requested cluster property.")
+  public ClusterPropertyDetails clusterProperty;
+}

solr/api/src/java/org/apache/solr/client/api/model/ListClusterPropertiesResponse.java

@@ -0,0 +1,28 @@
+/*
+ * 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.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.util.List;
+
+public class ListClusterPropertiesResponse extends SolrJerseyResponse {
+  @JsonProperty("clusterProperties")
+  @Schema(description = "The list of cluster properties.")
+  public List<String> clusterProperties;
+}

solr/api/src/java/org/apache/solr/client/api/model/SetClusterPropertyRequestBody.java

@@ -0,0 +1,27 @@
+/*
+ * 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.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+public class SetClusterPropertyRequestBody {
+  @Schema(description = "The value to assign to the property.")
+  @JsonProperty("value")
+  public String value;
+}

solr/api/src/java/org/apache/solr/client/api/model/SetNestedClusterPropertyRequestBody.java

@@ -0,0 +1,28 @@
+/*
+ * 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.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.util.Map;
+
+public class SetNestedClusterPropertyRequestBody {
+  @Schema(description = "Cluster properties and values to be updated.")
+  @JsonProperty(value = "properties", required = true)
+  public Map<String, Object> properties;
+}

solr/core/src/java/org/apache/solr/core/CoreContainer.java

@@ -126,6 +126,11 @@
 import org.apache.solr.handler.admin.ZookeeperInfoHandler;
 import org.apache.solr.handler.admin.ZookeeperReadAPI;
 import org.apache.solr.handler.admin.ZookeeperStatusHandler;
+import org.apache.solr.handler.admin.api.DeleteClusterProperty;
+import org.apache.solr.handler.admin.api.GetClusterProperty;
+import org.apache.solr.handler.admin.api.ListClusterProperties;
+import org.apache.solr.handler.admin.api.SetClusterProperty;
+import org.apache.solr.handler.admin.api.SetNestedClusterProperty;
 import org.apache.solr.handler.api.V2ApiUtils;
 import org.apache.solr.handler.component.ShardHandlerFactory;
 import org.apache.solr.handler.designer.SchemaDesignerAPI;
@@ -907,6 +912,11 @@ private void loadInternal() {
     ClusterAPI clusterAPI = new ClusterAPI(collectionsHandler, configSetsHandler);
     registerV2ApiIfEnabled(clusterAPI);
     registerV2ApiIfEnabled(clusterAPI.commands);
+    registerV2ApiIfEnabled(ListClusterProperties.class);
+    registerV2ApiIfEnabled(SetClusterProperty.class);
+    registerV2ApiIfEnabled(SetNestedClusterProperty.class);
+    registerV2ApiIfEnabled(GetClusterProperty.class);
+    registerV2ApiIfEnabled(DeleteClusterProperty.class);
 
     if (isZooKeeperAware()) {
       registerV2ApiIfEnabled(new SchemaDesignerAPI(this));