opensearch-project / opensearch-project/opensearch-java

`ClientTlsStrategyBuilder#setTlsDetailsFactory` is deprecated

Open
#1,613 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
165
Forks
250
Avg merge
1d 18h
Merged PRs (30d)
26

Description

ClientTlsStrategyBuilder#setTlsDetailsFactory is deprecated.
it is however still being used in various places here in the code:
https://github.com/opensearch-project/opensearch-java/blob/3bc5e7a90f27698f36183af668586c96860373be/java-client/src/main/java/org/opensearch/client/transport/httpclient5/ApacheHttpClient5TransportBuilder.java#L342-L347

as well as in the official client docs.

their deprecation list says:

Do not use. This method has no effect.

however, when you just remove this the tests fail. so it seems that the apache docs are wrong here. nevertheless an alternative should be found before they remove it completely (possibly requiring an issue upstream?).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in java-client/src/main/java/org/opensearch/client/transport/httpclient5/ApacheHttpClient5TransportBuilder.java around lines 342-347, then inspect the official Java client docs and the failing tests after removing setTlsDetailsFactory. Confirm how the Apache HttpClient API behaves, determine whether an upstream issue is needed, and finish with a supported alternative, passing tests, and updated documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, documentation, networking
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.