gnodet commented on code in PR #1907:
URL: https://github.com/apache/maven-resolver/pull/1907#discussion_r3373282409
##########
maven-resolver-util/src/main/java/org/eclipse/aether/util/repository/AuthenticationBuilder.java:
##########
@@ -146,6 +147,22 @@ public AuthenticationBuilder
addHostnameVerifier(HostnameVerifier verifier) {
return this;
}
+ /**
+ * Adds an SSL context for SSL/TLS connections. <strong>Note:</strong>
This method assumes that all possible
+ * instances of the SSL context's runtime type exhibit the exact same
behavior, i.e. the behavior of the SSL
+ * context depends solely on the runtime type and not on any
configuration. For SSL contexts that do not fit
+ * this assumption, use {@link #addCustom(Authentication)} with a suitable
implementation instead.
+ *
+ * @param sslContext the SSL context, may be {@code null}
+ * @return this builder for chaining, never {@code null}
Review Comment:
Minor Javadoc suggestion: consider adding a `@see` cross-reference to
`AuthenticationContext.SSL_CONTEXT` for discoverability, similar to how the
constant's own Javadoc references `javax.net.ssl.SSLContext`:
```suggestion
* Adds an SSL context for SSL/TLS connections. <strong>Note:</strong>
This method assumes that all possible
* instances of the SSL context's runtime type exhibit the exact same
behavior, i.e. the behavior of the SSL
* context depends solely on the runtime type and not on any
configuration. For SSL contexts that do not fit
* this assumption, use {@link #addCustom(Authentication)} with a
suitable implementation instead.
*
* @param sslContext the SSL context, may be {@code null}
* @return this builder for chaining, never {@code null}
* @see AuthenticationContext#SSL_CONTEXT
*/
```
This is purely optional — it helps users navigating the API discover the
constant key and the Javadoc on it that describes the expected type.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
