如何通过SolrJ修改solrconfig.xml？求AbstractSolrRequest实现示例

Hey there! I've got you covered when it comes to updating your solrconfig.xml via Java code using SolrJ. The key here is leveraging Solr's Config API—and SolrJ makes this easy either by using a built-in subclass of AbstractSolrRequest or creating your own custom request. Let's dive into the code:

Core Idea #

Solr's Config API lets you modify configuration via HTTP requests, and SolrJ's AbstractSolrRequest is the base class for all such request implementations. You can either use the ready-made GenericSolrRequest (a subclass) for quick tasks, or build a custom request class if you need more control.

Example 1: Using GenericSolrRequest (Quick & Simple) #

This is the easiest approach since you don't need to write a custom request class:

import org.apache.solr.client.solrj.SolrClient;
import org.apache.solr.client.solrj.impl.HttpSolrClient;
import org.apache.solr.client.solrj.request.GenericSolrRequest;
import org.apache.solr.client.solrj.response.SolrResponseBase;
import org.apache.solr.common.params.ModifiableSolrParams;
import org.apache.solr.common.util.ContentStreamBase;

import java.io.IOException;

public class SolrConfigUpdater {
    public static void main(String[] args) throws IOException {
        // Replace with your Solr core URL
        String solrCoreUrl = "http://localhost:8983/solr/your_core_name";
        
        try (SolrClient solrClient = new HttpSolrClient.Builder(solrCoreUrl).build()) {
            // Define your config change here (example: add a custom request handler)
            String configUpdatePayload = """
                    {
                      "add-requesthandler": {
                        "name": "/customSearch",
                        "class": "solr.SearchHandler",
                        "defaults": {
                          "echoParams": "explicit",
                          "rows": 15
                        }
                      }
                    }
                    """;

            // Create a POST request to the Config API endpoint
            GenericSolrRequest request = new GenericSolrRequest(
                    GenericSolrRequest.METHOD.POST,
                    "/config",
                    new ModifiableSolrParams()
            );

            // Attach the JSON payload to the request
            request.setContentStreams(java.util.Collections.singletonList(
                    new ContentStreamBase.StringStream(configUpdatePayload, "application/json")
            ));

            // Execute the request and get the response
            SolrResponseBase response = solrClient.request(request);
            System.out.println("Update Status Code: " + response.getStatus());
            System.out.println("Response Details: " + response.getResponse());
        }
    }
}

Example 2: Custom Request Class (Inheriting AbstractSolrRequest) #

If you need to encapsulate custom logic for config updates, create your own class extending AbstractSolrRequest:

import org.apache.solr.client.solrj.SolrClient;
import org.apache.solr.client.solrj.impl.HttpSolrClient;
import org.apache.solr.client.solrj.request.AbstractSolrRequest;
import org.apache.solr.client.solrj.response.SolrResponseBase;
import org.apache.solr.common.params.SolrParams;
import org.apache.solr.common.util.ContentStream;
import org.apache.solr.common.util.ContentStreamBase;

import java.io.IOException;
import java.util.Collections;
import java.util.List;

public class CustomConfigUpdateRequest extends AbstractSolrRequest {
    private final String configChangePayload;

    public CustomConfigUpdateRequest(String configChangePayload) {
        super(METHOD.POST); // We're using POST for config updates
        this.configChangePayload = configChangePayload;
    }

    @Override
    public String getPath() {
        return "/config"; // Fixed endpoint for Solr's Config API
    }

    @Override
    public SolrParams getParams() {
        return null; // No URL params needed here—payload has all the info
    }

    @Override
    public List<ContentStream> getContentStreams() {
        // Return the JSON payload as a content stream
        return Collections.singletonList(
                new ContentStreamBase.StringStream(configChangePayload, "application/json")
        );
    }

    // Test the custom request
    public static void main(String[] args) throws IOException {
        String solrCoreUrl = "http://localhost:8983/solr/your_core_name";
        
        try (SolrClient solrClient = new HttpSolrClient.Builder(solrCoreUrl).build()) {
            // Example: Update an existing request handler's default rows count
            String updatePayload = """
                    {
                      "set-requesthandler": {
                        "/customSearch": {
                          "defaults": {
                            "rows": 30
                          }
                        }
                      }
                    }
                    """;

            CustomConfigUpdateRequest updateRequest = new CustomConfigUpdateRequest(updatePayload);
            SolrResponseBase response = solrClient.request(updateRequest);
            System.out.println("Config Update Result: " + response.getResponse());
        }
    }
}

Important Notes #

• Supported Operations: The Config API can do more than just modify request handlers—you can update index settings, add query defaults, register listeners, and more. Check Solr's official docs for the full list of supported operations.
• Security Check: Make sure your Solr instance allows remote config edits by setting allowRemoteConfigEdit="true" in your solr.xml (this is disabled by default for security).
• Version Compatibility: These examples work with Solr 8.x and 9.x. If you're using an older version, you might need to adjust the API calls slightly.

内容的提问来源于stack exchange，提问作者Mrinalini Hanagodu