Package | Description |
---|---|
org.apache.pulsar.client.api |
Pulsar Client API.
|
org.apache.pulsar.client.internal |
Helpers which provide useful functionality for the implementation of Pulsar Client API.
|
Modifier and Type | Method and Description |
---|---|
ClientBuilder |
ClientBuilder.allowTlsInsecureConnection(boolean allowTlsInsecureConnection)
Configure whether the Pulsar client accept untrusted TLS certificate from broker (default: false).
|
ClientBuilder |
ClientBuilder.authentication(Authentication authentication)
Set the authentication provider to use in the Pulsar client instance.
|
ClientBuilder |
ClientBuilder.authentication(String authPluginClassName,
Map<String,String> authParams)
Configure the authentication provider to use in the Pulsar client instance
using a config map.
|
ClientBuilder |
ClientBuilder.authentication(String authPluginClassName,
String authParamsString)
Configure the authentication provider to use in the Pulsar client instance.
|
static ClientBuilder |
PulsarClient.builder()
Get a new builder instance that can used to configure and build a
PulsarClient instance. |
ClientBuilder |
ClientBuilder.clock(Clock clock)
The clock used by the pulsar client.
|
ClientBuilder |
ClientBuilder.clone()
Create a copy of the current client builder.
|
ClientBuilder |
ClientBuilder.connectionsPerBroker(int connectionsPerBroker)
Sets the max number of connection that the client library will open to a single broker.
|
ClientBuilder |
ClientBuilder.connectionTimeout(int duration,
TimeUnit unit)
Set the duration of time to wait for a connection to a broker to be established.
|
ClientBuilder |
ClientBuilder.enableTcpNoDelay(boolean enableTcpNoDelay)
Configure whether to use TCP no-delay flag on the connection, to disable Nagle algorithm.
|
ClientBuilder |
ClientBuilder.enableTls(boolean enableTls)
Deprecated.
use "pulsar+ssl://" in serviceUrl to enable
|
ClientBuilder |
ClientBuilder.enableTlsHostnameVerification(boolean enableTlsHostnameVerification)
It allows to validate hostname verification when client connects to broker over tls.
|
ClientBuilder |
ClientBuilder.enableTransaction(boolean enableTransaction)
If enable transaction, start the transactionCoordinatorClient with pulsar client.
|
ClientBuilder |
ClientBuilder.ioThreads(int numIoThreads)
Set the number of threads to be used for handling connections to brokers (default: 1 thread).
|
ClientBuilder |
ClientBuilder.keepAliveInterval(int keepAliveInterval,
TimeUnit unit)
Set keep alive interval for each client-broker-connection.
|
ClientBuilder |
ClientBuilder.listenerName(String name)
Configure the listenerName that the broker will return the corresponding `advertisedListener`.
|
ClientBuilder |
ClientBuilder.listenerThreads(int numListenerThreads)
Set the number of threads to be used for message listeners (default: 1 thread).
|
ClientBuilder |
ClientBuilder.loadConf(Map<String,Object> config)
Load the configuration from provided config map.
|
ClientBuilder |
ClientBuilder.maxBackoffInterval(long duration,
TimeUnit unit)
Set the maximum duration of time for a backoff interval.
|
ClientBuilder |
ClientBuilder.maxConcurrentLookupRequests(int maxConcurrentLookupRequests)
Number of concurrent lookup-requests allowed to send on each broker-connection to prevent overload on broker.
|
ClientBuilder |
ClientBuilder.maxLookupRedirects(int maxLookupRedirects)
Set the maximum number of times a lookup-request to a broker will be redirected.
|
ClientBuilder |
ClientBuilder.maxLookupRequests(int maxLookupRequests)
Number of max lookup-requests allowed on each broker-connection to prevent overload on broker.
|
ClientBuilder |
ClientBuilder.maxNumberOfRejectedRequestPerConnection(int maxNumberOfRejectedRequestPerConnection)
Set max number of broker-rejected requests in a certain time-frame (30 seconds) after which current connection
will be closed and client creates a new connection that give chance to connect a different broker (default:
50).
|
ClientBuilder |
ClientBuilder.operationTimeout(int operationTimeout,
TimeUnit unit)
Set the operation timeout (default: 30 seconds).
|
ClientBuilder |
ClientBuilder.proxyServiceUrl(String proxyServiceUrl,
ProxyProtocol proxyProtocol)
Proxy-service url when client would like to connect to broker via proxy.
|
ClientBuilder |
ClientBuilder.serviceUrl(String serviceUrl)
Configure the service URL for the Pulsar service.
|
ClientBuilder |
ClientBuilder.serviceUrlProvider(ServiceUrlProvider serviceUrlProvider)
Configure the service URL provider for Pulsar service.
|
ClientBuilder |
ClientBuilder.sslProvider(String sslProvider)
The name of the security provider used for SSL connections.
|
ClientBuilder |
ClientBuilder.startingBackoffInterval(long duration,
TimeUnit unit)
Set the duration of time for a backoff interval.
|
ClientBuilder |
ClientBuilder.statsInterval(long statsInterval,
TimeUnit unit)
Set the interval between each stat info (default: 60 seconds) Stats will be activated with positive
statsInterval It should be set to at least 1 second.
|
ClientBuilder |
ClientBuilder.tlsCiphers(Set<String> tlsCiphers)
A list of cipher suites.
|
ClientBuilder |
ClientBuilder.tlsProtocols(Set<String> tlsProtocols)
The SSL protocol used to generate the SSLContext.
|
ClientBuilder |
ClientBuilder.tlsTrustCertsFilePath(String tlsTrustCertsFilePath)
Set the path to the trusted TLS certificate file.
|
ClientBuilder |
ClientBuilder.tlsTrustStorePassword(String tlsTrustStorePassword)
The store password for the key store file.
|
ClientBuilder |
ClientBuilder.tlsTrustStorePath(String tlsTrustStorePath)
The location of the trust store file.
|
ClientBuilder |
ClientBuilder.tlsTrustStoreType(String tlsTrustStoreType)
The file format of the trust store file.
|
ClientBuilder |
ClientBuilder.useKeyStoreTls(boolean useKeyStoreTls)
If Tls is enabled, whether use KeyStore type as tls configuration parameter.
|
Modifier and Type | Method and Description |
---|---|
static ClientBuilder |
DefaultImplementation.newClientBuilder() |
Copyright © 2017–2021 Apache Software Foundation. All rights reserved.