andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Correct SslContextBuilder javadocs

Browse Source 
Motivation:

SslContextBuilder sill state the KeyManagerFactory and TrustManagerFactory are only supported when SslProvider.JDK is used. This is not correct anymore.

Modifications:

Fix javadocs.

Result:

Correct javadocs.
This commit is contained in:
Norman Maurer 2017-03-02 08:02:11 +01:00
parent 52aecabe43
commit 7e7e10fb1e
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
handler/src/main/java/io/netty/handler/ssl/SslContextBuilder.java
View File

@ -186,9 +186,7 @@ public final class SslContextBuilder {
} }
/** /**
* Trusted manager for verifying the remote endpoint's certificate. Using a {@link * Trusted manager for verifying the remote endpoint's certificate. {@code null} uses the system default.
* TrustManagerFactory} is only supported for {@link SslProvider#JDK}; for other providers,
* you must use {@link #trustManager(File)}. {@code null} uses the system default.
*/ */
public SslContextBuilder trustManager(TrustManagerFactory trustManagerFactory) { public SslContextBuilder trustManager(TrustManagerFactory trustManagerFactory) {
trustCertCollection = null; trustCertCollection = null;
@ -315,9 +313,11 @@ public final class SslContextBuilder {
/** /**
* Identifying manager for this host. {@code keyManagerFactory} may be {@code null} for * Identifying manager for this host. {@code keyManagerFactory} may be {@code null} for
* client contexts, which disables mutual authentication. Using a {@code KeyManagerFactory} * client contexts, which disables mutual authentication. Using a {@link KeyManagerFactory}
* is only supported for {@link SslProvider#JDK}; for other providers, you must use {@link * is only supported for {@link SslProvider#JDK} or {@link SslProvider#OPENSSL} / {@link SslProvider#OPENSSL_REFCNT}
* #keyManager(File, File)} or {@link #keyManager(File, File, String)}. * if the used openssl version is 1.0.1+. You can check if your openssl version supports using a
* {@link KeyManagerFactory} by calling {@link OpenSsl#supportsKeyManagerFactory()}. If this is not the case
* you must use {@link #keyManager(File, File)} or {@link #keyManager(File, File, String)}.
*/ */
public SslContextBuilder keyManager(KeyManagerFactory keyManagerFactory) { public SslContextBuilder keyManager(KeyManagerFactory keyManagerFactory) {
if (forServer) { if (forServer) {
@ -340,8 +340,8 @@ public final class SslContextBuilder {
/** /**
* The cipher suites to enable, in the order of preference. {@code cipherFilter} will be * The cipher suites to enable, in the order of preference. {@code cipherFilter} will be
* applied to the ciphers before use if provider is {@link SslProvider#JDK}. If {@code * applied to the ciphers before use. If {@code ciphers} is {@code null}, then the default
* ciphers} is {@code null}, then the default cipher suites will be used. * cipher suites will be used.
*/ */
public SslContextBuilder ciphers(Iterable<String> ciphers, CipherSuiteFilter cipherFilter) { public SslContextBuilder ciphers(Iterable<String> ciphers, CipherSuiteFilter cipherFilter) {
checkNotNull(cipherFilter, "cipherFilter"); checkNotNull(cipherFilter, "cipherFilter");