SOLR-16458: Migrate node properties API to JAX-RS

changelog/unreleased/SOLR-16458-migrate-node-properties-api.yml

@@ -0,0 +1,8 @@
+title: "A single node system property can be fetched at GET /api/node/properties/{propertyName} (v1 still uses ?name=). SolrJ now provides NodeApi.GetNodeProperties and NodeApi.GetNodeProperty."
+type: added
+authors:
+  - name: Prithvi S
+    nick: iprithv
+links:
+  - name: SOLR-16458
+    url: https://issues.apache.org/jira/browse/SOLR-16458

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

@@ -0,0 +1,44 @@
+/*
+ * 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.NodePropertiesResponse;
+
+/** V2 API definition for listing JRE system properties on a Solr node. */
+@Path("/node/properties")
+public interface NodePropertiesApi {
+
+  @GET
+  @Operation(
+      summary = "List system properties for the target Solr node.",
+      tags = {"node"})
+  NodePropertiesResponse getNodeProperties();
+
+  @GET
+  @Path("/{propertyName}")
+  @Operation(
+      summary = "Get a single system property for the target Solr node.",
+      tags = {"node"})
+  NodePropertiesResponse getNodeProperty(
+      @Parameter(description = "Name of the system property to return.") @PathParam("propertyName")
+          String propertyName);
+}

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

@@ -0,0 +1,34 @@
+/*
+ * 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;
+
+/**
+ * Response body for {@code GET /api/node/properties} and {@code GET
+ * /api/node/properties/{propertyName}}.
+ */
+public class NodePropertiesResponse extends SolrJerseyResponse {
+
+  public static final String SYSTEM_PROPERTIES = "system.properties";
+
+  @Schema(description = "JRE system properties for the Solr node. Secret values are redacted.")
+  @JsonProperty(SYSTEM_PROPERTIES)
+  public Map<String, String> systemProperties;
+}

solr/core/src/java/org/apache/solr/handler/admin/PropertiesRequestHandler.java

@@ -20,20 +20,22 @@
 
 import java.io.IOException;
 import java.util.Collection;
-import java.util.Enumeration;
-import org.apache.solr.api.AnnotatedApi;
+import java.util.List;
 import org.apache.solr.api.Api;
-import org.apache.solr.common.util.NamedList;
-import org.apache.solr.common.util.SimpleOrderedMap;
+import org.apache.solr.api.JerseyResource;
+import org.apache.solr.client.api.model.NodePropertiesResponse;
 import org.apache.solr.core.CoreContainer;
-import org.apache.solr.core.NodeConfig;
 import org.apache.solr.handler.RequestHandlerBase;
-import org.apache.solr.handler.admin.api.NodePropertiesAPI;
+import org.apache.solr.handler.admin.api.GetNodeProperties;
+import org.apache.solr.handler.api.V2ApiUtils;
 import org.apache.solr.request.SolrQueryRequest;
 import org.apache.solr.response.SolrQueryResponse;
 import org.apache.solr.security.AuthorizationContext;
 
 /**
+ * v1 implementation of {@code GET /admin/info/properties}. Business logic lives in {@link
+ * GetNodeProperties}.
+ *
  * @since solr 1.2
  */
 public class PropertiesRequestHandler extends RequestHandlerBase {
@@ -51,21 +53,12 @@ public PropertiesRequestHandler(CoreContainer cc) {
 
   @Override
   public void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp) throws IOException {
-    NamedList<String> props = new SimpleOrderedMap<>();
-    String name = req.getParams().get(NAME);
-    NodeConfig nodeConfig = getCoreContainer(req).getNodeConfig();
-    if (name != null) {
-      String property = nodeConfig.getRedactedSysPropValue(name);
-      props.add(name, property);
-    } else {
-      Enumeration<?> enumeration = System.getProperties().propertyNames();
-      while (enumeration.hasMoreElements()) {
-        name = (String) enumeration.nextElement();
-        props.add(name, nodeConfig.getRedactedSysPropValue(name));
-      }
-    }
-    rsp.add("system.properties", props);
     rsp.setHttpCaching(false);
+    final GetNodeProperties api = new GetNodeProperties(getCoreContainer(req));
+    final NodePropertiesResponse response = new NodePropertiesResponse();
+    // v1 ?name= returns the key even if unset; the v2 path form 404s for unknown names.
+    response.systemProperties = api.collectProperties(req.getParams().get(NAME));
+    V2ApiUtils.squashIntoSolrResponseWithoutHeader(rsp, response);
   }
 
   //////////////////////// SolrInfoMBeans methods //////////////////////
@@ -82,7 +75,12 @@ public Category getCategory() {
 
   @Override
   public Collection<Api> getApis() {
-    return AnnotatedApi.getApis(new NodePropertiesAPI(this));
+    return List.of();
+  }
+
+  @Override
+  public Collection<Class<? extends JerseyResource>> getJerseyResources() {
+    return List.of(GetNodeProperties.class);
   }
 
   @Override

solr/core/src/java/org/apache/solr/handler/admin/api/GetNodeProperties.java

@@ -0,0 +1,92 @@
+/*
+ * 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.handler.admin.api;
+
+import jakarta.inject.Inject;
+import java.util.Enumeration;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import org.apache.solr.api.JerseyResource;
+import org.apache.solr.client.api.endpoint.NodePropertiesApi;
+import org.apache.solr.client.api.model.NodePropertiesResponse;
+import org.apache.solr.common.SolrException;
+import org.apache.solr.core.CoreContainer;
+import org.apache.solr.core.NodeConfig;
+import org.apache.solr.jersey.PermissionName;
+import org.apache.solr.security.PermissionNameProvider;
+
+/**
+ * V2 API for listing system properties on the receiving node.
+ *
+ * <p>GET /api/node/properties lists all properties. GET /api/node/properties/{propertyName} returns
+ * a single property. Both are analogous to v1 /admin/info/properties, which still uses a {@code
+ * name} query parameter for the single-property form.
+ *
+ * <p>The v1 {@link org.apache.solr.handler.admin.PropertiesRequestHandler} delegates to this class.
+ */
+public class GetNodeProperties extends JerseyResource implements NodePropertiesApi {
+
+  private final CoreContainer coreContainer;
+
+  @Inject
+  public GetNodeProperties(CoreContainer coreContainer) {
+    this.coreContainer = coreContainer;
+  }
+
+  @Override
+  @PermissionName(PermissionNameProvider.Name.CONFIG_READ_PERM)
+  public NodePropertiesResponse getNodeProperties() {
+    return buildResponse(null);
+  }
+
+  @Override
+  @PermissionName(PermissionNameProvider.Name.CONFIG_READ_PERM)
+  public NodePropertiesResponse getNodeProperty(String propertyName) {
+    final NodeConfig nodeConfig = coreContainer.getNodeConfig();
+    // Hidden names always return 200 + a redacted value, even if unset, so callers cannot
+    // probe whether a secret is configured.
+    if (!System.getProperties().containsKey(propertyName)
+        && !nodeConfig.isSysPropHidden(propertyName)) {
+      throw new SolrException(
+          SolrException.ErrorCode.NOT_FOUND,
+          "No system property named '" + propertyName + "' exists on this node.");
+    }
+    return buildResponse(propertyName);
+  }
+
+  private NodePropertiesResponse buildResponse(String name) {
+    final NodePropertiesResponse response = instantiateJerseyResponse(NodePropertiesResponse.class);
+    response.systemProperties = collectProperties(name);
+    return response;
+  }
+
+  /** Collect redacted system properties, optionally limited to a single named property. */
+  public Map<String, String> collectProperties(String name) {
+    final NodeConfig nodeConfig = coreContainer.getNodeConfig();
+    final Map<String, String> props = new LinkedHashMap<>();
+    if (name != null) {
+      props.put(name, nodeConfig.getRedactedSysPropValue(name));
+    } else {
+      Enumeration<?> enumeration = System.getProperties().propertyNames();
+      while (enumeration.hasMoreElements()) {
+        String propertyName = (String) enumeration.nextElement();
+        props.put(propertyName, nodeConfig.getRedactedSysPropValue(propertyName));
+      }
+    }
+    return props;
+  }
+}

solr/core/src/test/org/apache/solr/handler/admin/PropertiesRequestHandlerTest.java

@@ -16,11 +16,13 @@
  */
 package org.apache.solr.handler.admin;
 
+import java.util.Map;
 import org.apache.solr.SolrTestCaseJ4;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.SolrRequest;
 import org.apache.solr.client.solrj.embedded.EmbeddedSolrServer;
 import org.apache.solr.client.solrj.request.GenericSolrRequest;
+import org.apache.solr.common.params.ModifiableSolrParams;
 import org.apache.solr.common.util.NamedList;
 import org.apache.solr.core.NodeConfig;
 import org.junit.BeforeClass;
@@ -45,7 +47,7 @@ public void testRedaction() throws Exception {
           "some.Secret"
         }) {
       System.setProperty(propName, PASSWORD);
-      NamedList<Object> properties = readProperties();
+      Map<String, Object> properties = readProperties();
 
       assertEquals(
           "Failed to redact " + propName,
@@ -54,13 +56,41 @@ public void testRedaction() throws Exception {
     }
   }
 
+  @Test
+  public void testSingleProperty() throws Exception {
+    System.setProperty("GetNodeProperties.v1.visible", "hello");
+    try {
+      Map<String, Object> properties = readProperties("GetNodeProperties.v1.visible");
+      assertEquals(1, properties.size());
+      assertEquals("hello", properties.get("GetNodeProperties.v1.visible"));
+    } finally {
+      System.clearProperty("GetNodeProperties.v1.visible");
+    }
+  }
+
+  @Test
+  public void testMissingPropertyStillReturned() throws Exception {
+    Map<String, Object> properties = readProperties("GetNodeProperties.v1.doesNotExist");
+    assertEquals(1, properties.size());
+    assertTrue(properties.containsKey("GetNodeProperties.v1.doesNotExist"));
+    assertNull(properties.get("GetNodeProperties.v1.doesNotExist"));
+  }
+
+  private Map<String, Object> readProperties() throws Exception {
+    return readProperties(null);
+  }
+
   @SuppressWarnings({"unchecked"})
-  private NamedList<Object> readProperties() throws Exception {
+  private Map<String, Object> readProperties(String name) throws Exception {
     SolrClient client = new EmbeddedSolrServer(h.getCore());
-
+    ModifiableSolrParams params = new ModifiableSolrParams();
+    if (name != null) {
+      params.set("name", name);
+    }
     NamedList<Object> properties =
-        client.request(new GenericSolrRequest(SolrRequest.METHOD.GET, "/admin/info/properties"));
+        client.request(
+            new GenericSolrRequest(SolrRequest.METHOD.GET, "/admin/info/properties", params));
 
-    return (NamedList<Object>) properties.get("system.properties");
+    return (Map<String, Object>) properties.get("system.properties");
   }
 }