You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by li...@apache.org on 2022/08/01 01:32:05 UTC
[pulsar] branch master updated: [fix][doc] fix incorrect tls config in java client doc (#16315)
This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new e1050e13f9e [fix][doc] fix incorrect tls config in java client doc (#16315)
e1050e13f9e is described below
commit e1050e13f9e7c88da3a2ebdebbca7c5bdd52c1a1
Author: Eric Shen <er...@outlook.com>
AuthorDate: Mon Aug 1 09:31:59 2022 +0800
[fix][doc] fix incorrect tls config in java client doc (#16315)
---
site2/docs/client-libraries-java.md | 6 ++----
.../version-2.1.0-incubating/client-libraries-java.md | 4 +---
.../version-2.1.1-incubating/client-libraries-java.md | 6 ++----
.../website/versioned_docs/version-2.10.0/client-libraries-java.md | 6 ++----
.../website/versioned_docs/version-2.10.1/client-libraries-java.md | 2 --
site2/website/versioned_docs/version-2.2.0/client-libraries-java.md | 6 ++----
site2/website/versioned_docs/version-2.2.1/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.3.0/client-libraries-java.md | 6 ++----
site2/website/versioned_docs/version-2.3.1/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.3.2/client-libraries-java.md | 6 ++----
site2/website/versioned_docs/version-2.4.0/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.4.1/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.4.2/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.5.0/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.5.1/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.5.2/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.6.0/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.6.1/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.6.2/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.6.3/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.6.4/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.7.0/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.7.1/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.7.2/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.7.3/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.7.4/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.8.0/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.8.1/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.8.2/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.8.3/client-libraries-java.md | 4 +---
site2/website/versioned_docs/version-2.9.0/client-libraries-java.md | 6 ++----
site2/website/versioned_docs/version-2.9.1/client-libraries-java.md | 6 ++----
site2/website/versioned_docs/version-2.9.2/client-libraries-java.md | 6 ++----
33 files changed, 41 insertions(+), 107 deletions(-)
diff --git a/site2/docs/client-libraries-java.md b/site2/docs/client-libraries-java.md
index c1cad8a7fe1..6e72d7fdae2 100644
--- a/site2/docs/client-libraries-java.md
+++ b/site2/docs/client-libraries-java.md
@@ -140,7 +140,7 @@ If you create a client, you can use the `loadConf` configuration. The following
`numIoThreads`| int| The number of threads used for handling connections to brokers | 1
`numListenerThreads`|int|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](/concepts-messaging.md#shared) subscription and multiple consumers for this subscription. This does not ensure [...]
`useTcpNoDelay`| boolean| Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
-`useTls` |boolean |Whether to use TLS encryption on the connection| false
+`enableTls` |boolean | Whether to use TLS encryption on the connection. Note that this parameter is **deprecated**. If you want to enable TLS, use `pulsar+ssl://` in `serviceUrl` instead. | false
`tlsTrustCertsFilePath` |string |Path to the trusted TLS certificate file|None
`tlsAllowInsecureConnection`|boolean|Whether the Pulsar client accepts untrusted TLS certificate from broker | false
`tlsHostnameVerificationEnable` |boolean | Whether to enable TLS hostname verification|false
@@ -1515,7 +1515,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication.md), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -1530,7 +1530,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -1562,7 +1561,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.1.0-incubating/client-libraries-java.md b/site2/website/versioned_docs/version-2.1.0-incubating/client-libraries-java.md
index 6e7151c866a..18961cd46cb 100644
--- a/site2/website/versioned_docs/version-2.1.0-incubating/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.1.0-incubating/client-libraries-java.md
@@ -475,7 +475,7 @@ Pulsar currently supports two authentication schemes: [TLS](security-tls-authent
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
Here's an example configuration:
@@ -490,7 +490,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -522,7 +521,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.1.1-incubating/client-libraries-java.md b/site2/website/versioned_docs/version-2.1.1-incubating/client-libraries-java.md
index 791c626c28b..b201e8573e8 100644
--- a/site2/website/versioned_docs/version-2.1.1-incubating/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.1.1-incubating/client-libraries-java.md
@@ -140,7 +140,7 @@ If you create a client, you can use the `loadConf` configuration. The following
`numIoThreads`| int| The number of threads used for handling connections to brokers | 1
`numListenerThreads`|int|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](https://pulsar.apache.org/docs/en/next/concepts-messaging/#shared) subscription and multiple consumers for thi [...]
`useTcpNoDelay`| boolean| Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
-`useTls` |boolean |Whether to use TLS encryption on the connection| false
+`enableTls` |boolean | Whether to use TLS encryption on the connection. Note that this parameter is **deprecated**. If you want to enable TLS, use `pulsar+ssl://` in `serviceUrl` instead. | false
`tlsTrustCertsFilePath` |string |Path to the trusted TLS certificate file|None
`tlsAllowInsecureConnection`|boolean|Whether the Pulsar client accepts untrusted TLS certificate from broker | false
`tlsHostnameVerificationEnable` |boolean | Whether to enable TLS hostname verification|false
@@ -1513,7 +1513,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -1528,7 +1528,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -1560,7 +1559,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.10.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.10.0/client-libraries-java.md
index 8be1962290e..030d9f6f9d5 100644
--- a/site2/website/versioned_docs/version-2.10.0/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.10.0/client-libraries-java.md
@@ -141,7 +141,7 @@ If you create a client, you can use the `loadConf` configuration. The following
`numIoThreads`| int| The number of threads used for handling connections to brokers | 1
`numListenerThreads`|int|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](concepts-messaging.md#shared) subscription and multiple consumers for this subscription. This does not ensure [...]
`useTcpNoDelay`| boolean| Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
-`useTls` |boolean |Whether to use TLS encryption on the connection| false
+`enableTls` |boolean | Whether to use TLS encryption on the connection. Note that this parameter is **deprecated**. If you want to enable TLS, use `pulsar+ssl://` in `serviceUrl` instead. | false
`tlsTrustCertsFilePath` |string |Path to the trusted TLS certificate file|None
`tlsAllowInsecureConnection`|boolean|Whether the Pulsar client accepts untrusted TLS certificate from broker | false
`tlsHostnameVerificationEnable` |boolean | Whether to enable TLS hostname verification|false
@@ -1453,7 +1453,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication.md), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -1468,7 +1468,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -1500,7 +1499,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.10.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.10.1/client-libraries-java.md
index 8be1962290e..efba798e6b2 100644
--- a/site2/website/versioned_docs/version-2.10.1/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.10.1/client-libraries-java.md
@@ -1468,7 +1468,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -1500,7 +1499,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.2.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.2.0/client-libraries-java.md
index 791c626c28b..b201e8573e8 100644
--- a/site2/website/versioned_docs/version-2.2.0/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.2.0/client-libraries-java.md
@@ -140,7 +140,7 @@ If you create a client, you can use the `loadConf` configuration. The following
`numIoThreads`| int| The number of threads used for handling connections to brokers | 1
`numListenerThreads`|int|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](https://pulsar.apache.org/docs/en/next/concepts-messaging/#shared) subscription and multiple consumers for thi [...]
`useTcpNoDelay`| boolean| Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
-`useTls` |boolean |Whether to use TLS encryption on the connection| false
+`enableTls` |boolean | Whether to use TLS encryption on the connection. Note that this parameter is **deprecated**. If you want to enable TLS, use `pulsar+ssl://` in `serviceUrl` instead. | false
`tlsTrustCertsFilePath` |string |Path to the trusted TLS certificate file|None
`tlsAllowInsecureConnection`|boolean|Whether the Pulsar client accepts untrusted TLS certificate from broker | false
`tlsHostnameVerificationEnable` |boolean | Whether to enable TLS hostname verification|false
@@ -1513,7 +1513,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -1528,7 +1528,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -1560,7 +1559,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.2.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.2.1/client-libraries-java.md
index eeba554ee19..c33b1a68be5 100644
--- a/site2/website/versioned_docs/version-2.2.1/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.2.1/client-libraries-java.md
@@ -474,7 +474,7 @@ Pulsar currently supports two authentication schemes: [TLS](security-tls-authent
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
Here's an example configuration:
@@ -489,7 +489,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -521,7 +520,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.3.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.3.0/client-libraries-java.md
index 791c626c28b..b201e8573e8 100644
--- a/site2/website/versioned_docs/version-2.3.0/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.3.0/client-libraries-java.md
@@ -140,7 +140,7 @@ If you create a client, you can use the `loadConf` configuration. The following
`numIoThreads`| int| The number of threads used for handling connections to brokers | 1
`numListenerThreads`|int|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](https://pulsar.apache.org/docs/en/next/concepts-messaging/#shared) subscription and multiple consumers for thi [...]
`useTcpNoDelay`| boolean| Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
-`useTls` |boolean |Whether to use TLS encryption on the connection| false
+`enableTls` |boolean | Whether to use TLS encryption on the connection. Note that this parameter is **deprecated**. If you want to enable TLS, use `pulsar+ssl://` in `serviceUrl` instead. | false
`tlsTrustCertsFilePath` |string |Path to the trusted TLS certificate file|None
`tlsAllowInsecureConnection`|boolean|Whether the Pulsar client accepts untrusted TLS certificate from broker | false
`tlsHostnameVerificationEnable` |boolean | Whether to enable TLS hostname verification|false
@@ -1513,7 +1513,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -1528,7 +1528,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -1560,7 +1559,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.3.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.3.1/client-libraries-java.md
index 5380d674333..ecf0eba3512 100644
--- a/site2/website/versioned_docs/version-2.3.1/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.3.1/client-libraries-java.md
@@ -481,7 +481,7 @@ Pulsar currently supports two authentication schemes: [TLS](security-tls-authent
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
Here's an example configuration:
@@ -496,7 +496,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -528,7 +527,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.3.2/client-libraries-java.md b/site2/website/versioned_docs/version-2.3.2/client-libraries-java.md
index 791c626c28b..b201e8573e8 100644
--- a/site2/website/versioned_docs/version-2.3.2/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.3.2/client-libraries-java.md
@@ -140,7 +140,7 @@ If you create a client, you can use the `loadConf` configuration. The following
`numIoThreads`| int| The number of threads used for handling connections to brokers | 1
`numListenerThreads`|int|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](https://pulsar.apache.org/docs/en/next/concepts-messaging/#shared) subscription and multiple consumers for thi [...]
`useTcpNoDelay`| boolean| Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
-`useTls` |boolean |Whether to use TLS encryption on the connection| false
+`enableTls` |boolean | Whether to use TLS encryption on the connection. Note that this parameter is **deprecated**. If you want to enable TLS, use `pulsar+ssl://` in `serviceUrl` instead. | false
`tlsTrustCertsFilePath` |string |Path to the trusted TLS certificate file|None
`tlsAllowInsecureConnection`|boolean|Whether the Pulsar client accepts untrusted TLS certificate from broker | false
`tlsHostnameVerificationEnable` |boolean | Whether to enable TLS hostname verification|false
@@ -1513,7 +1513,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -1528,7 +1528,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -1560,7 +1559,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.4.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.4.0/client-libraries-java.md
index bc970118a84..778129d9077 100644
--- a/site2/website/versioned_docs/version-2.4.0/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.4.0/client-libraries-java.md
@@ -703,7 +703,7 @@ Pulsar currently supports two authentication schemes: [TLS](security-tls-authent
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
Here's an example configuration:
@@ -718,7 +718,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -750,7 +749,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.4.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.4.1/client-libraries-java.md
index 095d0475f41..686bd1241df 100644
--- a/site2/website/versioned_docs/version-2.4.1/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.4.1/client-libraries-java.md
@@ -748,7 +748,7 @@ Pulsar currently supports two authentication schemes: [TLS](security-tls-authent
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
Here's an example configuration:
@@ -763,7 +763,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -795,7 +794,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.4.2/client-libraries-java.md b/site2/website/versioned_docs/version-2.4.2/client-libraries-java.md
index 095d0475f41..686bd1241df 100644
--- a/site2/website/versioned_docs/version-2.4.2/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.4.2/client-libraries-java.md
@@ -748,7 +748,7 @@ Pulsar currently supports two authentication schemes: [TLS](security-tls-authent
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
Here's an example configuration:
@@ -763,7 +763,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -795,7 +794,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.5.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.5.0/client-libraries-java.md
index 6f37d6ebbad..d5dc98fcb99 100644
--- a/site2/website/versioned_docs/version-2.5.0/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.5.0/client-libraries-java.md
@@ -875,7 +875,7 @@ Pulsar currently supports two authentication schemes: [TLS](security-tls-authent
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -890,7 +890,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -922,7 +921,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.5.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.5.1/client-libraries-java.md
index 801f9894dad..e1906188233 100644
--- a/site2/website/versioned_docs/version-2.5.1/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.5.1/client-libraries-java.md
@@ -877,7 +877,7 @@ Pulsar currently supports two authentication schemes: [TLS](security-tls-authent
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -892,7 +892,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -924,7 +923,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.5.2/client-libraries-java.md b/site2/website/versioned_docs/version-2.5.2/client-libraries-java.md
index 801f9894dad..e1906188233 100644
--- a/site2/website/versioned_docs/version-2.5.2/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.5.2/client-libraries-java.md
@@ -877,7 +877,7 @@ Pulsar currently supports two authentication schemes: [TLS](security-tls-authent
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -892,7 +892,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -924,7 +923,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.6.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.6.0/client-libraries-java.md
index b6ced396cd0..e53110f93c7 100644
--- a/site2/website/versioned_docs/version-2.6.0/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.6.0/client-libraries-java.md
@@ -919,7 +919,7 @@ Pulsar currently supports two authentication schemes: [TLS](security-tls-authent
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -934,7 +934,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -966,7 +965,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.6.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.6.1/client-libraries-java.md
index 2399c1ad3a3..98572b1e35b 100644
--- a/site2/website/versioned_docs/version-2.6.1/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.6.1/client-libraries-java.md
@@ -900,7 +900,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -915,7 +915,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -947,7 +946,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.6.2/client-libraries-java.md b/site2/website/versioned_docs/version-2.6.2/client-libraries-java.md
index 2399c1ad3a3..98572b1e35b 100644
--- a/site2/website/versioned_docs/version-2.6.2/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.6.2/client-libraries-java.md
@@ -900,7 +900,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -915,7 +915,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -947,7 +946,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.6.3/client-libraries-java.md b/site2/website/versioned_docs/version-2.6.3/client-libraries-java.md
index 2399c1ad3a3..98572b1e35b 100644
--- a/site2/website/versioned_docs/version-2.6.3/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.6.3/client-libraries-java.md
@@ -900,7 +900,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -915,7 +915,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -947,7 +946,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.6.4/client-libraries-java.md b/site2/website/versioned_docs/version-2.6.4/client-libraries-java.md
index b9ce639e5e6..a95ea3b2c7b 100644
--- a/site2/website/versioned_docs/version-2.6.4/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.6.4/client-libraries-java.md
@@ -901,7 +901,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -916,7 +916,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -948,7 +947,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.7.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.7.0/client-libraries-java.md
index 8bdec5bc562..bbe9473622f 100644
--- a/site2/website/versioned_docs/version-2.7.0/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.7.0/client-libraries-java.md
@@ -940,7 +940,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -955,7 +955,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -987,7 +986,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.7.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.7.1/client-libraries-java.md
index 8bdec5bc562..bbe9473622f 100644
--- a/site2/website/versioned_docs/version-2.7.1/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.7.1/client-libraries-java.md
@@ -940,7 +940,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -955,7 +955,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -987,7 +986,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.7.2/client-libraries-java.md b/site2/website/versioned_docs/version-2.7.2/client-libraries-java.md
index 8bdec5bc562..bbe9473622f 100644
--- a/site2/website/versioned_docs/version-2.7.2/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.7.2/client-libraries-java.md
@@ -940,7 +940,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -955,7 +955,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -987,7 +986,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.7.3/client-libraries-java.md b/site2/website/versioned_docs/version-2.7.3/client-libraries-java.md
index 8bdec5bc562..bbe9473622f 100644
--- a/site2/website/versioned_docs/version-2.7.3/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.7.3/client-libraries-java.md
@@ -940,7 +940,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -955,7 +955,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -987,7 +986,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.7.4/client-libraries-java.md b/site2/website/versioned_docs/version-2.7.4/client-libraries-java.md
index 8bdec5bc562..bbe9473622f 100644
--- a/site2/website/versioned_docs/version-2.7.4/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.7.4/client-libraries-java.md
@@ -940,7 +940,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -955,7 +955,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -987,7 +986,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.8.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.8.0/client-libraries-java.md
index cdc1794bab3..9c4e129e3e6 100644
--- a/site2/website/versioned_docs/version-2.8.0/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.8.0/client-libraries-java.md
@@ -946,7 +946,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -961,7 +961,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -993,7 +992,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.8.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.8.1/client-libraries-java.md
index b31b7a225f2..e57c83f7963 100644
--- a/site2/website/versioned_docs/version-2.8.1/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.8.1/client-libraries-java.md
@@ -949,7 +949,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -964,7 +964,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -996,7 +995,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.8.2/client-libraries-java.md b/site2/website/versioned_docs/version-2.8.2/client-libraries-java.md
index b31b7a225f2..e57c83f7963 100644
--- a/site2/website/versioned_docs/version-2.8.2/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.8.2/client-libraries-java.md
@@ -949,7 +949,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -964,7 +964,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -996,7 +995,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.8.3/client-libraries-java.md b/site2/website/versioned_docs/version-2.8.3/client-libraries-java.md
index b31b7a225f2..e57c83f7963 100644
--- a/site2/website/versioned_docs/version-2.8.3/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.8.3/client-libraries-java.md
@@ -949,7 +949,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -964,7 +964,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -996,7 +995,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.9.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.9.0/client-libraries-java.md
index 613e91f3fe5..e87c5e6c23c 100644
--- a/site2/website/versioned_docs/version-2.9.0/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.9.0/client-libraries-java.md
@@ -128,7 +128,7 @@ If you create a client, you can use the `loadConf` configuration. The following
`numIoThreads`| int| The number of threads used for handling connections to brokers | 1
`numListenerThreads`|int|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](https://pulsar.apache.org/docs/en/next/concepts-messaging/#shared) subscription and multiple consumers for thi [...]
`useTcpNoDelay`| boolean| Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
-`useTls` |boolean |Whether to use TLS encryption on the connection| false
+`enableTls` |boolean | Whether to use TLS encryption on the connection. Note that this parameter is **deprecated**. If you want to enable TLS, use `pulsar+ssl://` in `serviceUrl` instead. | false
`tlsTrustCertsFilePath` |string |Path to the trusted TLS certificate file|None
`tlsAllowInsecureConnection`|boolean|Whether the Pulsar client accepts untrusted TLS certificate from broker | false
`tlsHostnameVerificationEnable` |boolean | Whether to enable TLS hostname verification|false
@@ -949,7 +949,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -964,7 +964,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -996,7 +995,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.9.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.9.1/client-libraries-java.md
index 613e91f3fe5..e87c5e6c23c 100644
--- a/site2/website/versioned_docs/version-2.9.1/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.9.1/client-libraries-java.md
@@ -128,7 +128,7 @@ If you create a client, you can use the `loadConf` configuration. The following
`numIoThreads`| int| The number of threads used for handling connections to brokers | 1
`numListenerThreads`|int|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](https://pulsar.apache.org/docs/en/next/concepts-messaging/#shared) subscription and multiple consumers for thi [...]
`useTcpNoDelay`| boolean| Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
-`useTls` |boolean |Whether to use TLS encryption on the connection| false
+`enableTls` |boolean | Whether to use TLS encryption on the connection. Note that this parameter is **deprecated**. If you want to enable TLS, use `pulsar+ssl://` in `serviceUrl` instead. | false
`tlsTrustCertsFilePath` |string |Path to the trusted TLS certificate file|None
`tlsAllowInsecureConnection`|boolean|Whether the Pulsar client accepts untrusted TLS certificate from broker | false
`tlsHostnameVerificationEnable` |boolean | Whether to enable TLS hostname verification|false
@@ -949,7 +949,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -964,7 +964,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -996,7 +995,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();
diff --git a/site2/website/versioned_docs/version-2.9.2/client-libraries-java.md b/site2/website/versioned_docs/version-2.9.2/client-libraries-java.md
index 613e91f3fe5..e87c5e6c23c 100644
--- a/site2/website/versioned_docs/version-2.9.2/client-libraries-java.md
+++ b/site2/website/versioned_docs/version-2.9.2/client-libraries-java.md
@@ -128,7 +128,7 @@ If you create a client, you can use the `loadConf` configuration. The following
`numIoThreads`| int| The number of threads used for handling connections to brokers | 1
`numListenerThreads`|int|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](https://pulsar.apache.org/docs/en/next/concepts-messaging/#shared) subscription and multiple consumers for thi [...]
`useTcpNoDelay`| boolean| Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
-`useTls` |boolean |Whether to use TLS encryption on the connection| false
+`enableTls` |boolean | Whether to use TLS encryption on the connection. Note that this parameter is **deprecated**. If you want to enable TLS, use `pulsar+ssl://` in `serviceUrl` instead. | false
`tlsTrustCertsFilePath` |string |Path to the trusted TLS certificate file|None
`tlsAllowInsecureConnection`|boolean|Whether the Pulsar client accepts untrusted TLS certificate from broker | false
`tlsHostnameVerificationEnable` |boolean | Whether to enable TLS hostname verification|false
@@ -949,7 +949,7 @@ Pulsar currently supports three authentication schemes: [TLS](security-tls-authe
### TLS Authentication
-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), `enableTls` method is deprecated and you need to use "pulsar+ssl://" in serviceUrl to enable, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
The following is an example.
@@ -964,7 +964,6 @@ Authentication tlsAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(tlsAuth)
.build();
@@ -996,7 +995,6 @@ Authentication athenzAuth = AuthenticationFactory
PulsarClient client = PulsarClient.builder()
.serviceUrl("pulsar+ssl://my-broker.com:6651")
- .enableTls(true)
.tlsTrustCertsFilePath("/path/to/cacert.pem")
.authentication(athenzAuth)
.build();