[SOLR-17044] Improve API path specifying in SolrJ

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: SolrJ, v2 API
• Labels: pull-request-available
• Assignee: Jason Gerlowski
• Reporter: Jason Gerlowski
• Created: 19/Oct/23 13:03
• Updated: 04/Oct/24 18:44

Description

Currently, URL-driven SolrClients receive a URL that typically ends in "/solr". Requiring users to specify this context-root in their URLs has made sense historically, since all v1 paths start with "/solr". But this has become limiting as Solr's v2 APIs (which use the "/api" context root) become more mature.

SolrJ has some string manipulation in a few spots to try to accomodate this, but it's patchy and relatively brittle (relying on overly specific 'instanceof' checks, etc.). We should come up with a more reliable way to ensure that SolrClient's can make both v1 and v2 requests.

Here's one idea for how we could approach this:

1. Create a new SolrRequest method to specify the initial path segment (i.e. /solr vs /api) on a per-request basis. We could either do this directly (e.g. "getRootPath()"), or indirectly (e.g. "isV2()").
2. Modify SolrClients to consider both the new method and the existing "getPath" when sending requests.
3. Add logic to SolrJ to strip "/solr" from any provided base URLs, and document that SolrClient URLs no longer require the "/solr" context-root suffix.

Issue Links

• is blocked by: SOLR-17066 Deprecate and remove core URLs in HttpSolrClient and friends
• links to: GitHub Pull Request #2455
• links to: GitHub Pull Request #2456
• links to: GitHub Pull Request #2723