ClientBuilder (Pulsar Client Java 2.2.0 API)

All Superinterfaces:

Cloneable

All Known Implementing Classes:

ClientBuilderImpl
```
public interface ClientBuilder
extends Cloneable
```
Builder interface that is used to 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)` Set the authentication provider to use in the Pulsar client instance.
`ClientBuilder`	`authentication(String authPluginClassName, String authParamsString)` Set the authentication provider to use in the Pulsar client instance.
`PulsarClient`	`build()`
`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`	`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 keepAliveIntervalSeconds, TimeUnit unit)` Set keep alive interval in seconds 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`	`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`	`statsInterval(long statsInterval, TimeUnit unit)` Set the interval between each stat info (default: 60 seconds) Stats will be activated with positive statsIntervalSeconds 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
```
    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:5550");
 config.put("numIoThreads", 20);

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

 PulsarClient client = builder.build();
 
```
    Parameters:
    
    config - configuration to load
    
    Returns:
    
    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(URL_1).build();
 PulsarClient client2 = builder.clone().serviceUrl(URL_2).build();
 
```
  - serviceUrl
```
ClientBuilder serviceUrl(String serviceUrl)
```
    Configure the service URL for the Pulsar service.
    This parameter is required
    
    Parameters:
    
    serviceUrl -
    
    Returns:
  - serviceUrlProvider
```
ClientBuilder serviceUrlProvider(ServiceUrlProvider serviceUrlProvider)
```
    Configure the service URL provider for Pulsar service
    
    Parameters:
    
    serviceUrlProvider -
    
    Returns:
  - authentication
```
ClientBuilder authentication(Authentication authentication)
```
    Set the authentication provider to use in the Pulsar client instance.
    Example:
```
 
 String AUTH_CLASS = "org.apache.pulsar.client.impl.auth.AuthenticationTls";

 Map conf = new TreeMap<>();
 conf.put("tlsCertFile", "/my/cert/file");
 conf.put("tlsKeyFile", "/my/key/file");

 Authentication auth = AuthenticationFactor.create(AUTH_CLASS, conf);

 PulsarClient client = PulsarClient.builder()
          .serviceUrl(SERVICE_URL)
          .authentication(auth)
          .build();
 ....
 
 
```
    Parameters:
    
    authentication - an instance of the Authentication provider already constructed
  - authentication
```
ClientBuilder authentication(String authPluginClassName,
                             String authParamsString)
                      throws PulsarClientException.UnsupportedAuthenticationException
```
    Set the authentication provider to use in the Pulsar client instance.
    Example:
```
 
 String AUTH_CLASS = "org.apache.pulsar.client.impl.auth.AuthenticationTls";
 String AUTH_PARAMS = "tlsCertFile:/my/cert/file,tlsKeyFile:/my/key/file";

 PulsarClient client = PulsarClient.builder()
          .serviceUrl(SERVICE_URL)
          .authentication(AUTH_CLASS, AUTH_PARAMS)
          .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"
    
    Throws:
    
    PulsarClientException.UnsupportedAuthenticationException - failed to instantiate specified Authentication-Plugin
  - authentication
```
ClientBuilder authentication(String authPluginClassName,
                             Map<String,String> authParams)
                      throws PulsarClientException.UnsupportedAuthenticationException
```
    Set the authentication provider to use in the Pulsar client instance.
    Example:
```
 
 String AUTH_CLASS = "org.apache.pulsar.client.impl.auth.AuthenticationTls";

 Map conf = new TreeMap<>();
 conf.put("tlsCertFile", "/my/cert/file");
 conf.put("tlsKeyFile", "/my/key/file");

 PulsarClient client = PulsarClient.builder()
          .serviceUrl(SERVICE_URL)
          .authentication(AUTH_CLASS, conf)
          .build();
 ....
 
```
    Parameters:
    
    authPluginClassName - name of the Authentication-Plugin you want to use
    
    authParams - map which represents parameters for the Authentication-Plugin
    
    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
  - ioThreads
```
ClientBuilder ioThreads(int numIoThreads)
```
    Set the number of threads to be used for handling connections to brokers (default: 1 thread)
    
    Parameters:
    
    numIoThreads -
  - listenerThreads
```
ClientBuilder listenerThreads(int numListenerThreads)
```
    Set the number of threads to be used for message listeners (default: 1 thread)
    
    Parameters:
    
    numListenerThreads -
  - 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)
  - 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 -
  - 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 -
  - tlsTrustCertsFilePath
```
ClientBuilder tlsTrustCertsFilePath(String tlsTrustCertsFilePath)
```
    Set the path to the trusted TLS certificate file
    
    Parameters:
    
    tlsTrustCertsFilePath -
  - allowTlsInsecureConnection
```
ClientBuilder allowTlsInsecureConnection(boolean allowTlsInsecureConnection)
```
    Configure whether the Pulsar client accept untrusted TLS certificate from broker (default: false)
    
    Parameters:
    
    allowTlsInsecureConnection -
  - 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 -
    
    See Also:
    
    rfc2818
  - statsInterval
```
ClientBuilder statsInterval(long statsInterval,
                            TimeUnit unit)
```
    Set the interval between each stat info (default: 60 seconds) Stats will be activated with positive statsIntervalSeconds It should be set to at least 1 second
    
    Parameters:
    
    statsIntervalSeconds - the interval between each stat info
    
    unit - time unit for statsInterval
  - 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 -
  - 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 -
  - 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 -
  - keepAliveInterval
```
ClientBuilder keepAliveInterval(int keepAliveIntervalSeconds,
                                TimeUnit unit)
```
    Set keep alive interval in seconds for each client-broker-connection. (default: 30).
    
    Parameters:
    
    keepAliveIntervalSeconds -
    
    unit - time unit for statsInterval

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