This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new e639c2ef974 Docs sync done from apache/pulsar(#cb30582)
e639c2ef974 is described below
commit e639c2ef974f7010f18cf3fb20d1b8a10620938c
Author: Pulsar Site Updater <[email protected]>
AuthorDate: Mon Aug 1 06:08:20 2022 +0000
Docs sync done from apache/pulsar(#cb30582)
---
site2/website-next/docs/client-libraries-java.md | 6 ++----
site2/website-next/docs/functions-cli.md | 4 ++--
site2/website-next/docs/functions-concepts.md | 13 +++++++++----
.../version-2.1.0-incubating/client-libraries-java.md | 4 +---
.../version-2.1.1-incubating/client-libraries-java.md | 6 ++----
.../versioned_docs/version-2.10.0/client-libraries-java.md | 6 ++----
.../versioned_docs/version-2.10.1/client-libraries-java.md | 2 --
.../versioned_docs/version-2.2.0/client-libraries-java.md | 6 ++----
.../versioned_docs/version-2.2.1/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.3.0/client-libraries-java.md | 6 ++----
.../versioned_docs/version-2.3.1/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.3.2/client-libraries-java.md | 6 ++----
.../versioned_docs/version-2.4.0/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.4.1/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.4.2/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.5.0/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.5.1/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.5.2/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.6.0/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.6.1/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.6.2/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.6.3/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.6.4/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.7.0/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.7.1/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.7.2/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.7.3/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.7.4/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.8.0/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.8.1/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.8.2/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.8.3/client-libraries-java.md | 4 +---
.../versioned_docs/version-2.9.0/client-libraries-java.md | 6 ++----
.../versioned_docs/version-2.9.1/client-libraries-java.md | 6 ++----
.../versioned_docs/version-2.9.2/client-libraries-java.md | 6 ++----
35 files changed, 52 insertions(+), 113 deletions(-)
diff --git a/site2/website-next/docs/client-libraries-java.md
b/site2/website-next/docs/client-libraries-java.md
index c1cad8a7fe1..6e72d7fdae2 100644
--- a/site2/website-next/docs/client-libraries-java.md
+++ b/site2/website-next/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-next/docs/functions-cli.md
b/site2/website-next/docs/functions-cli.md
index 316266ab069..c2c4f3ee9fa 100644
--- a/site2/website-next/docs/functions-cli.md
+++ b/site2/website-next/docs/functions-cli.md
@@ -38,7 +38,7 @@ You can configure a function by using a predefined YAML file.
The following tabl
| outputSchemaType | String | `-st`, `--schema-type`
| The built-in schema type or custom schema class name used for message
outputs. |
| outputSerdeClassName | String |
`--output-serde-classname` | The SerDe class used for message outputs. |
| logTopic | String | `--log-topic`
| The topic that the logs of a function are produced to. |
-| processingGuarantees | String | `--processing-guarantees` | The processing
guarantees (delivery semantics) applied to a function. Available values:
`ATLEAST_ONCE`, `ATMOST_ONCE`, `EFFECTIVELY_ONCE`.|
+| processingGuarantees | String | `--processing-guarantees` | The processing
guarantees (delivery semantics) applied to a function. Available values:
`ATLEAST_ONCE`, `ATMOST_ONCE`, `EFFECTIVELY_ONCE`, `MANUAL`.|
| retainOrdering | Boolean | `--retain-ordering`
| Whether functions consume and process messages in order or not. |
| retainKeyOrdering | Boolean | `--retain-key-ordering`
| Whether functions consume and process messages in key order or not. |
| batchBuilder | String | `--batch-builder` | Use
`producerConfig.batchBuilder` instead. <br />**Note**: `batchBuilder` will be
deprecated in code soon. |
@@ -46,7 +46,7 @@ You can configure a function by using a predefined YAML file.
The following tabl
| userConfig | Map`<String,Object>` | `--user-config`
| User-defined config key/values. |
| secrets | Map`<String,Object>` | `--secrets` | The mapping from
secretName to objects that encapsulate how the secret is fetched by the
underlying secrets provider. |
| runtime | String | N/A | The runtime of a
function. Available values: `java`,`python`, `go`. |
-| autoAck | Boolean | `--auto-ack` | Whether the framework
acknowledges messages automatically or not. |
+| autoAck | Boolean | `--auto-ack` | Whether the framework
acknowledges messages automatically or not. <br /><br />**Tip**: This
configuration will be deprecated. If the user specifies delivery semantics, the
framework will automatically ack messages. If you do not want the framework to
ack messages, set the **processingGuarantees** to `MANUAL`. |
| maxMessageRetries | Int | `--max-message-retries` | The number of
retries to process a message before giving up. |
| deadLetterTopic | String | `--dead-letter-topic` | The topic used
for storing messages that are not processed successfully. |
| subName | String | `--subs-name` | The name of
Pulsar source subscription used for input-topic consumers if required.|
diff --git a/site2/website-next/docs/functions-concepts.md
b/site2/website-next/docs/functions-concepts.md
index a758ce45f2c..cfbba46aaf2 100644
--- a/site2/website-next/docs/functions-concepts.md
+++ b/site2/website-next/docs/functions-concepts.md
@@ -71,13 +71,15 @@ The following table outlines the three types of function
runtime.
## Processing guarantees and subscription types
-Pulsar provides three different messaging delivery semantics that you can
apply to a function.
+Pulsar provides three different messaging delivery semantics that you can
apply to a function. Different delivery semantic implementations are determined
according to the **ack time node**.
| Delivery semantics | Description | Adopted subscription type |
|--------------------|-------------|---------------------------|
-| **At-most-once** delivery | Each message sent to a function is processed at
its best effort. There’s no guarantee that the message will be processed or
not. | Shared |
-| **At-least-once** delivery (default) | Each message sent to the function can
be processed more than once (in case of a processing failure or redelivery).<br
/><br />If you create a function without specifying the
`--processing-guarantees` flag, the function provides `at-least-once` delivery
guarantee. | Shared |
-| **Effectively-once** delivery | Each message sent to the function can be
processed more than once but it has only one output. Duplicated messages are
ignored.<br /><br />`Effectively once` is achieved on top of `at-least-once`
processing and guaranteed server-side deduplication. This means a state update
can happen twice, but the same state update is only applied once, the other
duplicated state update is discarded on the server-side. | Failover |
+| **At-most-once** delivery | Each message sent to a function is processed at
its best effort. There’s no guarantee that the message will be processed or
not. <br /><br /> When setting At-most-once, the `autoAck` configuration must
be equal to true, otherwise the startup will fail(`autoAck` configuration will
be deprecated in future releases). <br/><br/> **Ack time node**: Before
function processing. | Shared |
+| **At-least-once** delivery (default) | Each message sent to the function can
be processed more than once (in case of a processing failure or redelivery).<br
/><br />If you create a function without specifying the
`--processing-guarantees` flag, the function provides `at-least-once` delivery
guarantee. <br/><br/> **Ack time node**: After sending a message to output. |
Shared |
+| **Effectively-once** delivery | Each message sent to the function can be
processed more than once but it has only one output. Duplicated messages are
ignored.<br /><br />`Effectively once` is achieved on top of `at-least-once`
processing and guaranteed server-side deduplication. This means a state update
can happen twice, but the same state update is only applied once, the other
duplicated state update is discarded on the server-side. <br/><br/> **Ack time
node**: After sending a messa [...]
+| **Manual** delivery | Under this semantics, the user needs to call the
method `context.getCurrentRecord().ack()` inside the function to manually
perform the ack operation, and the framework will not help users to do any ack
operations. <br/><br/> **Ack time node**: User decides, in function method. |
Shared |
+
:::tip
@@ -167,6 +169,9 @@ Both processing time and event time are supported.
* Processing time is defined based on the wall time when the function
instance builds and processes a window. The judging of window completeness is
straightforward and you don’t have to worry about data arrival disorder.
* Event time is defined based on the timestamps that come with the event
record. It guarantees event time correctness but also offers more data
buffering and a limited completeness guarantee.
+Delivery Semantic Guarantees.
+ * Currently, window function does not support `MANUAL` and
`Effectively-once` delivery semantics.
+
:::
### Types of window
diff --git
a/site2/website-next/versioned_docs/version-2.1.0-incubating/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.1.0-incubating/client-libraries-java.md
index 6e7151c866a..18961cd46cb 100644
---
a/site2/website-next/versioned_docs/version-2.1.0-incubating/client-libraries-java.md
+++
b/site2/website-next/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-next/versioned_docs/version-2.1.1-incubating/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.1.1-incubating/client-libraries-java.md
index 791c626c28b..b201e8573e8 100644
---
a/site2/website-next/versioned_docs/version-2.1.1-incubating/client-libraries-java.md
+++
b/site2/website-next/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-next/versioned_docs/version-2.10.0/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.10.0/client-libraries-java.md
index 8be1962290e..030d9f6f9d5 100644
--- a/site2/website-next/versioned_docs/version-2.10.0/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.10.1/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.10.1/client-libraries-java.md
index 8be1962290e..efba798e6b2 100644
--- a/site2/website-next/versioned_docs/version-2.10.1/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.2.0/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.2.0/client-libraries-java.md
index 791c626c28b..b201e8573e8 100644
--- a/site2/website-next/versioned_docs/version-2.2.0/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.2.1/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.2.1/client-libraries-java.md
index eeba554ee19..c33b1a68be5 100644
--- a/site2/website-next/versioned_docs/version-2.2.1/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.3.0/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.3.0/client-libraries-java.md
index 791c626c28b..b201e8573e8 100644
--- a/site2/website-next/versioned_docs/version-2.3.0/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.3.1/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.3.1/client-libraries-java.md
index 5380d674333..ecf0eba3512 100644
--- a/site2/website-next/versioned_docs/version-2.3.1/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.3.2/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.3.2/client-libraries-java.md
index 791c626c28b..b201e8573e8 100644
--- a/site2/website-next/versioned_docs/version-2.3.2/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.4.0/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.4.0/client-libraries-java.md
index bc970118a84..778129d9077 100644
--- a/site2/website-next/versioned_docs/version-2.4.0/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.4.1/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.4.1/client-libraries-java.md
index 095d0475f41..686bd1241df 100644
--- a/site2/website-next/versioned_docs/version-2.4.1/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.4.2/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.4.2/client-libraries-java.md
index 095d0475f41..686bd1241df 100644
--- a/site2/website-next/versioned_docs/version-2.4.2/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.5.0/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.5.0/client-libraries-java.md
index 6f37d6ebbad..d5dc98fcb99 100644
--- a/site2/website-next/versioned_docs/version-2.5.0/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.5.1/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.5.1/client-libraries-java.md
index 801f9894dad..e1906188233 100644
--- a/site2/website-next/versioned_docs/version-2.5.1/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.5.2/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.5.2/client-libraries-java.md
index 801f9894dad..e1906188233 100644
--- a/site2/website-next/versioned_docs/version-2.5.2/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.6.0/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.6.0/client-libraries-java.md
index b6ced396cd0..e53110f93c7 100644
--- a/site2/website-next/versioned_docs/version-2.6.0/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.6.1/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.6.1/client-libraries-java.md
index 2399c1ad3a3..98572b1e35b 100644
--- a/site2/website-next/versioned_docs/version-2.6.1/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.6.2/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.6.2/client-libraries-java.md
index 2399c1ad3a3..98572b1e35b 100644
--- a/site2/website-next/versioned_docs/version-2.6.2/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.6.3/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.6.3/client-libraries-java.md
index 2399c1ad3a3..98572b1e35b 100644
--- a/site2/website-next/versioned_docs/version-2.6.3/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.6.4/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.6.4/client-libraries-java.md
index b9ce639e5e6..a95ea3b2c7b 100644
--- a/site2/website-next/versioned_docs/version-2.6.4/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.7.0/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.7.0/client-libraries-java.md
index 8bdec5bc562..bbe9473622f 100644
--- a/site2/website-next/versioned_docs/version-2.7.0/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.7.1/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.7.1/client-libraries-java.md
index 8bdec5bc562..bbe9473622f 100644
--- a/site2/website-next/versioned_docs/version-2.7.1/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.7.2/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.7.2/client-libraries-java.md
index 8bdec5bc562..bbe9473622f 100644
--- a/site2/website-next/versioned_docs/version-2.7.2/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.7.3/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.7.3/client-libraries-java.md
index 8bdec5bc562..bbe9473622f 100644
--- a/site2/website-next/versioned_docs/version-2.7.3/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.7.4/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.7.4/client-libraries-java.md
index 8bdec5bc562..bbe9473622f 100644
--- a/site2/website-next/versioned_docs/version-2.7.4/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.8.0/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.8.0/client-libraries-java.md
index cdc1794bab3..9c4e129e3e6 100644
--- a/site2/website-next/versioned_docs/version-2.8.0/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.8.1/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.8.1/client-libraries-java.md
index b31b7a225f2..e57c83f7963 100644
--- a/site2/website-next/versioned_docs/version-2.8.1/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.8.2/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.8.2/client-libraries-java.md
index b31b7a225f2..e57c83f7963 100644
--- a/site2/website-next/versioned_docs/version-2.8.2/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.8.3/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.8.3/client-libraries-java.md
index b31b7a225f2..e57c83f7963 100644
--- a/site2/website-next/versioned_docs/version-2.8.3/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.9.0/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.9.0/client-libraries-java.md
index 613e91f3fe5..e87c5e6c23c 100644
--- a/site2/website-next/versioned_docs/version-2.9.0/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.9.1/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.9.1/client-libraries-java.md
index 613e91f3fe5..e87c5e6c23c 100644
--- a/site2/website-next/versioned_docs/version-2.9.1/client-libraries-java.md
+++ b/site2/website-next/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-next/versioned_docs/version-2.9.2/client-libraries-java.md
b/site2/website-next/versioned_docs/version-2.9.2/client-libraries-java.md
index 613e91f3fe5..e87c5e6c23c 100644
--- a/site2/website-next/versioned_docs/version-2.9.2/client-libraries-java.md
+++ b/site2/website-next/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();
