ClientBuilder (Pulsar Client

All Superinterfaces:

Cloneable
```
public interface ClientBuilder
extends Cloneable
```
Builder interface that is used to configure and construct a PulsarClient instance.

Since:

2.0.0

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`ClientBuilder`	`allowTlsInsecureConnection(boolean allowTlsInsecureConnection)` Configure whether the Pulsar client accept untrusted TLS certificate from broker (default: false).
`ClientBuilder`	`authentication(Authentication authentication)` Set the authentication provider to use in the Pulsar client instance.
`ClientBuilder`	`authentication(String authPluginClassName, Map<String,String> authParams)` Configure the authentication provider to use in the Pulsar client instance using a config map.
`ClientBuilder`	`authentication(String authPluginClassName, String authParamsString)` Configure the authentication provider to use in the Pulsar client instance.
`PulsarClient`	`build()` Construct the final `PulsarClient` instance.
`ClientBuilder`	`clock(Clock clock)` The clock used by the pulsar client.
`ClientBuilder`	`clone()` Create a copy of the current client builder.
`ClientBuilder`	`connectionsPerBroker(int connectionsPerBroker)` Sets the max number of connection that the client library will open to a single broker.
`ClientBuilder`	`connectionTimeout(int duration, TimeUnit unit)` Set the duration of time to wait for a connection to a broker to be established.
`ClientBuilder`	`enableTcpNoDelay(boolean enableTcpNoDelay)` Configure whether to use TCP no-delay flag on the connection, to disable Nagle algorithm.
`ClientBuilder`	`enableTls(boolean enableTls)` Deprecated. use "pulsar+ssl://" in serviceUrl to enable
`ClientBuilder`	`enableTlsHostnameVerification(boolean enableTlsHostnameVerification)` It allows to validate hostname verification when client connects to broker over tls.
`ClientBuilder`	`ioThreads(int numIoThreads)` Set the number of threads to be used for handling connections to brokers (default: 1 thread).
`ClientBuilder`	`keepAliveInterval(int keepAliveInterval, TimeUnit unit)` Set keep alive interval for each client-broker-connection.
`ClientBuilder`	`listenerThreads(int numListenerThreads)` Set the number of threads to be used for message listeners (default: 1 thread).
`ClientBuilder`	`loadConf(Map<String,Object> config)` Load the configuration from provided `config` map.
`ClientBuilder`	`maxBackoffInterval(long duration, TimeUnit unit)` Set the maximum duration of time for a backoff interval.
`ClientBuilder`	`maxConcurrentLookupRequests(int maxConcurrentLookupRequests)` Number of concurrent lookup-requests allowed to send on each broker-connection to prevent overload on broker.
`ClientBuilder`	`maxLookupRequests(int maxLookupRequests)` Number of max lookup-requests allowed on each broker-connection to prevent overload on broker.
`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`	`operationTimeout(int operationTimeout, TimeUnit unit)` Set the operation timeout (default: 30 seconds).
`ClientBuilder`	`serviceUrl(String serviceUrl)` Configure the service URL for the Pulsar service.
`ClientBuilder`	`serviceUrlProvider(ServiceUrlProvider serviceUrlProvider)` Configure the service URL provider for Pulsar service.
`ClientBuilder`	`startingBackoffInterval(long duration, TimeUnit unit)` Set the duration of time for a backoff interval.
`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`	`tlsTrustCertsFilePath(String tlsTrustCertsFilePath)` Set the path to the trusted TLS certificate file.

- Method Detail
  - build
```
PulsarClient build()
            throws PulsarClientException
```
    Construct the final PulsarClient instance.
    
    Returns:
    
    the new PulsarClient instance
    
    Throws:
    
    PulsarClientException
  - loadConf
```
ClientBuilder loadConf(Map<String,Object> config)
```
    Load the configuration from provided config map.
    Example:
```
 
 Map<String, Object> config = new HashMap<>();
 config.put("serviceUrl", "pulsar://localhost:6650");
 config.put("numIoThreads", 20);

 ClientBuilder builder = ...;
 builder = builder.loadConf(config);

 PulsarClient client = builder.build();
 
 
```
    Parameters:
    
    config - configuration to load
    
    Returns:
    
    the client builder instance
  - clone
```
ClientBuilder clone()
```
    Create a copy of the current client builder.
    Cloning the builder can be used to share an incomplete configuration and specialize it multiple times. For example:
```
 ClientBuilder builder = PulsarClient.builder()
               .ioThreads(8)
               .listenerThreads(4);

 PulsarClient client1 = builder.clone()
                  .serviceUrl("pulsar://localhost:6650").build();
 PulsarClient client2 = builder.clone()
                  .serviceUrl("pulsar://other-host:6650").build();
 
```
    Returns:
    
    a clone of the client builder instance
  - serviceUrl
```
ClientBuilder serviceUrl(String serviceUrl)
```
    Configure the service URL for the Pulsar service.
    This parameter is required.
    Examples:
    - pulsar://my-broker:6650 for regular endpoint
    - pulsar+ssl://my-broker:6651 for TLS encrypted endpoint
    Parameters:
    
    serviceUrl - the URL of the Pulsar service that the client should connect to
    
    Returns:
    
    the client builder instance
  - serviceUrlProvider
```
ClientBuilder serviceUrlProvider(ServiceUrlProvider serviceUrlProvider)
```
    Configure the service URL provider for Pulsar service.
    Instead of specifying a static service URL string (with serviceUrl(String)), an application can pass a ServiceUrlProvider instance that dynamically provide a service URL.
    
    Parameters:
    
    serviceUrlProvider - the provider instance
    
    Returns:
    
    the client builder instance
  - authentication
```
ClientBuilder authentication(Authentication authentication)
```
    Set the authentication provider to use in the Pulsar client instance.
    Example:
```
 PulsarClient client = PulsarClient.builder()
         .serviceUrl("pulsar+ssl://broker.example.com:6651/")
         .authentication(
               AuthenticationFactory.TLS("/my/cert/file", "/my/key/file")
         .build();
 
```
    For token based authentication, this will look like:
```
 AuthenticationFactory
      .token("eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY")
 
```
    Parameters:
    
    authentication - an instance of the Authentication provider already constructed
    
    Returns:
    
    the client builder instance
  - authentication
```
ClientBuilder authentication(String authPluginClassName,
                             String authParamsString)
                      throws PulsarClientException.UnsupportedAuthenticationException
```
    Configure the authentication provider to use in the Pulsar client instance.
    Example:
```
 
 PulsarClient client = PulsarClient.builder()
          .serviceUrl("pulsar+ssl://broker.example.com:6651/)
          .authentication(
              "org.apache.pulsar.client.impl.auth.AuthenticationTls",
              "tlsCertFile:/my/cert/file,tlsKeyFile:/my/key/file")
          .build();
 
 
```
    Parameters:
    
    authPluginClassName - name of the Authentication-Plugin you want to use
    
    authParamsString - string which represents parameters for the Authentication-Plugin, e.g., "key1:val1,key2:val2"
    
    Returns:
    
    the client builder instance
    
    Throws:
    
    PulsarClientException.UnsupportedAuthenticationException - failed to instantiate specified Authentication-Plugin
  - authentication
```
ClientBuilder authentication(String authPluginClassName,
                             Map<String,String> authParams)
                      throws PulsarClientException.UnsupportedAuthenticationException
```
    Configure the authentication provider to use in the Pulsar client instance using a config map.
    Example:
```
 Map<String, String> conf = new TreeMap<>();
 conf.put("tlsCertFile", "/my/cert/file");
 conf.put("tlsKeyFile", "/my/key/file");

 PulsarClient client = PulsarClient.builder()
          .serviceUrl("pulsar+ssl://broker.example.com:6651/)
          .authentication(
              "org.apache.pulsar.client.impl.auth.AuthenticationTls", conf)
          .build();
 
```
    Parameters:
    
    authPluginClassName - name of the Authentication-Plugin you want to use
    
    authParams - map which represents parameters for the Authentication-Plugin
    
    Returns:
    
    the client builder instance
    
    Throws:
    
    PulsarClientException.UnsupportedAuthenticationException - failed to instantiate specified Authentication-Plugin
  - operationTimeout
```
ClientBuilder operationTimeout(int operationTimeout,
                               TimeUnit unit)
```
    Set the operation timeout (default: 30 seconds).
    Producer-create, subscribe and unsubscribe operations will be retried until this interval, after which the operation will be marked as failed
    
    Parameters:
    
    operationTimeout - operation timeout
    
    unit - time unit for operationTimeout
    
    Returns:
    
    the client builder instance
  - ioThreads
```
ClientBuilder ioThreads(int numIoThreads)
```
    Set the number of threads to be used for handling connections to brokers (default: 1 thread).
    
    Parameters:
    
    numIoThreads - the number of IO threads
    
    Returns:
    
    the client builder instance
  - listenerThreads
```
ClientBuilder listenerThreads(int numListenerThreads)
```
    Set the number of threads to be used for message listeners (default: 1 thread).
    The listener thread pool is shared across all the consumers and readers that are using a "listener" model to get messages. For a given consumer, the listener will be always invoked from the same thread, to ensure ordering.
    
    Parameters:
    
    numListenerThreads - the number of listener threads
    
    Returns:
    
    the client builder instance
  - connectionsPerBroker
```
ClientBuilder connectionsPerBroker(int connectionsPerBroker)
```
    Sets the max number of connection that the client library will open to a single broker.
    By default, the connection pool will use a single connection for all the producers and consumers. Increasing this parameter may improve throughput when using many producers over a high latency connection.
    
    Parameters:
    
    connectionsPerBroker - max number of connections per broker (needs to be greater than 0)
    
    Returns:
    
    the client builder instance
  - enableTcpNoDelay
```
ClientBuilder enableTcpNoDelay(boolean enableTcpNoDelay)
```
    Configure whether to use TCP no-delay flag on the connection, to disable Nagle algorithm.
    No-delay features make sure packets are sent out on the network as soon as possible, and it's critical to achieve low latency publishes. On the other hand, sending out a huge number of small packets might limit the overall throughput, so if latency is not a concern, it's advisable to set the useTcpNoDelay flag to false.
    Default value is true.
    
    Parameters:
    
    enableTcpNoDelay - whether to enable TCP no-delay feature
    
    Returns:
    
    the client builder instance
  - enableTls
```
@Deprecated
ClientBuilder enableTls(boolean enableTls)
```
    Deprecated. use "pulsar+ssl://" in serviceUrl to enable
    
    Configure whether to use TLS encryption on the connection (default: true if serviceUrl starts with "pulsar+ssl://", false otherwise).
    
    Parameters:
    
    enableTls -
    
    Returns:
    
    the client builder instance
  - tlsTrustCertsFilePath
```
ClientBuilder tlsTrustCertsFilePath(String tlsTrustCertsFilePath)
```
    Set the path to the trusted TLS certificate file.
    
    Parameters:
    
    tlsTrustCertsFilePath -
    
    Returns:
    
    the client builder instance
  - allowTlsInsecureConnection
```
ClientBuilder allowTlsInsecureConnection(boolean allowTlsInsecureConnection)
```
    Configure whether the Pulsar client accept untrusted TLS certificate from broker (default: false).
    
    Parameters:
    
    allowTlsInsecureConnection - whether to accept a untrusted TLS certificate
    
    Returns:
    
    the client builder instance
  - enableTlsHostnameVerification
```
ClientBuilder enableTlsHostnameVerification(boolean enableTlsHostnameVerification)
```
    It allows to validate hostname verification when client connects to broker over tls. It validates incoming x509 certificate and matches provided hostname(CN/SAN) with expected broker's host name. It follows RFC 2818, 3.1. Server Identity hostname verification.
    
    Parameters:
    
    enableTlsHostnameVerification - whether to enable TLS hostname verification
    
    Returns:
    
    the client builder instance
    
    See Also:
    
    RFC 818
  - statsInterval
```
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.
    
    Parameters:
    
    statsInterval - the interval between each stat info
    
    unit - time unit for statsInterval
    
    Returns:
    
    the client builder instance
  - maxConcurrentLookupRequests
```
ClientBuilder maxConcurrentLookupRequests(int maxConcurrentLookupRequests)
```
    Number of concurrent lookup-requests allowed to send on each broker-connection to prevent overload on broker. (default: 5000) It should be configured with higher value only in case of it requires to produce/subscribe on thousands of topic using created PulsarClient.
    
    Parameters:
    
    maxConcurrentLookupRequests -
    
    Returns:
    
    the client builder instance
  - maxLookupRequests
```
ClientBuilder maxLookupRequests(int maxLookupRequests)
```
    Number of max lookup-requests allowed on each broker-connection to prevent overload on broker. (default: 50000) It should be bigger than maxConcurrentLookupRequests. Requests that inside maxConcurrentLookupRequests already send to broker, and requests beyond maxConcurrentLookupRequests and under maxLookupRequests will wait in each client cnx.
    
    Parameters:
    
    maxLookupRequests -
    
    Returns:
    
    the client builder instance
  - maxNumberOfRejectedRequestPerConnection
```
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).
    
    Parameters:
    
    maxNumberOfRejectedRequestPerConnection -
    
    Returns:
    
    the client builder instance
  - keepAliveInterval
```
ClientBuilder keepAliveInterval(int keepAliveInterval,
                                TimeUnit unit)
```
    Set keep alive interval for each client-broker-connection. (default: 30 seconds).
    
    Parameters:
    
    keepAliveInterval -
    
    unit - the time unit in which the keepAliveInterval is defined
    
    Returns:
    
    the client builder instance
  - connectionTimeout
```
ClientBuilder connectionTimeout(int duration,
                                TimeUnit unit)
```
    Set the duration of time to wait for a connection to a broker to be established. If the duration passes without a response from the broker, the connection attempt is dropped.
    
    Parameters:
    
    duration - the duration to wait
    
    unit - the time unit in which the duration is defined
    
    Returns:
    
    the client builder instance
    
    Since:
    
    2.3.0
  - startingBackoffInterval
```
ClientBuilder startingBackoffInterval(long duration,
                                      TimeUnit unit)
```
    Set the duration of time for a backoff interval.
    
    Parameters:
    
    duration - the duration of the interval
    
    unit - the time unit in which the duration is defined
    
    Returns:
    
    the client builder instance
  - maxBackoffInterval
```
ClientBuilder maxBackoffInterval(long duration,
                                 TimeUnit unit)
```
    Set the maximum duration of time for a backoff interval.
    
    Parameters:
    
    duration - the duration of the interval
    
    unit - the time unit in which the duration is defined
    
    Returns:
    
    the client builder instance
  - clock
```
ClientBuilder clock(Clock clock)
```
    The clock used by the pulsar client.
    The clock is currently used by producer for setting publish timestamps. Clock.millis() is called to retrieve current timestamp as the publish timestamp when producers produce messages. The default clock is a system default zone clock. So the publish timestamp is same as calling System.currentTimeMillis().
    Warning: the clock is used for TTL enforcement and timestamp based seeks. so be aware of the impacts if you are going to use a different clock.
    
    Parameters:
    
    clock - the clock used by the pulsar client to retrieve time information
    
    Returns:
    
    the client builder instance

Interface ClientBuilder

Method Summary

Method Detail

build

loadConf

clone

serviceUrl

serviceUrlProvider

authentication

authentication

authentication

operationTimeout

ioThreads

listenerThreads

connectionsPerBroker

enableTcpNoDelay

enableTls

tlsTrustCertsFilePath

allowTlsInsecureConnection

enableTlsHostnameVerification

statsInterval

maxConcurrentLookupRequests

maxLookupRequests

maxNumberOfRejectedRequestPerConnection

keepAliveInterval

connectionTimeout

startingBackoffInterval

maxBackoffInterval

clock