ClientBuilderImpl (Pulsar Client Java 2.2.1 API)

java.lang.Object
- org.apache.pulsar.client.impl.ClientBuilderImpl

All Implemented Interfaces:: Cloneable, ClientBuilder

public class ClientBuilderImpl
extends Object
implements ClientBuilder

Constructor Summary

Constructors
Constructor and Description

ClientBuilderImpl()

ClientBuilderImpl(ClientConfigurationData conf)

Constructors
Constructor and Description
`ClientBuilderImpl()`
`ClientBuilderImpl(ClientConfigurationData conf)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientBuilder`	`allowTlsInsecureConnection(boolean tlsAllowInsecureConnection)` 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 useTcpNoDelay)` Configure whether to use TCP no-delay flag on the connection, to disable Nagle algorithm.
`ClientBuilder`	`enableTls(boolean useTls)` Configure whether to use TLS encryption on the connection (default: true if serviceUrl starts with "pulsar+ssl://", false otherwise)
`ClientBuilder`	`enableTlsHostnameVerification(boolean enableTlsHostnameVerification)` It allows to validate hostname verification when client connects to broker over tls.
`ClientConfigurationData`	`getClientConfigurationData()`
`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 concurrentLookupRequests)` 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

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ClientBuilderImpl
```
public ClientBuilderImpl()
```
  - ClientBuilderImpl
```
public ClientBuilderImpl(ClientConfigurationData conf)
```
- Method Detail
  - build
```
public PulsarClient build()
                   throws PulsarClientException
```
    Specified by:
    
    build in interface ClientBuilder
    
    Returns:
    
    the new PulsarClient instance
    
    Throws:
    
    PulsarClientException
  - clone
```
public ClientBuilder clone()
```
    Description copied from interface: ClientBuilder
    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();
 
```
    Specified by:
    
    clone in interface ClientBuilder
    
    Overrides:
    
    clone in class Object
  - loadConf
```
public ClientBuilder loadConf(Map<String,Object> config)
```
    Description copied from interface: ClientBuilder
    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();
 
```
    Specified by:
    
    loadConf in interface ClientBuilder
    
    Parameters:
    
    config - configuration to load
    
    Returns:
    
    client builder instance
  - serviceUrl
```
public ClientBuilder serviceUrl(String serviceUrl)
```
    Description copied from interface: ClientBuilder
    
    Configure the service URL for the Pulsar service.
    This parameter is required
    
    Specified by:
    
    serviceUrl in interface ClientBuilder
    
    Returns:
  - serviceUrlProvider
```
public ClientBuilder serviceUrlProvider(ServiceUrlProvider serviceUrlProvider)
```
    Description copied from interface: ClientBuilder
    
    Configure the service URL provider for Pulsar service
    
    Specified by:
    
    serviceUrlProvider in interface ClientBuilder
    
    Returns:
  - authentication
```
public ClientBuilder authentication(Authentication authentication)
```
    Description copied from interface: ClientBuilder
    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();
 ....
 
 
```
    Specified by:
    
    authentication in interface ClientBuilder
    
    Parameters:
    
    authentication - an instance of the Authentication provider already constructed
  - authentication
```
public ClientBuilder authentication(String authPluginClassName,
                                    String authParamsString)
                             throws PulsarClientException.UnsupportedAuthenticationException
```
    Description copied from interface: ClientBuilder
    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();
 ....
 
 
```
    Specified by:
    
    authentication in interface ClientBuilder
    
    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
```
public ClientBuilder authentication(String authPluginClassName,
                                    Map<String,String> authParams)
                             throws PulsarClientException.UnsupportedAuthenticationException
```
    Description copied from interface: ClientBuilder
    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();
 ....
 
```
    Specified by:
    
    authentication in interface ClientBuilder
    
    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
```
public ClientBuilder operationTimeout(int operationTimeout,
                                      TimeUnit unit)
```
    Description copied from interface: ClientBuilder
    
    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
    
    Specified by:
    
    operationTimeout in interface ClientBuilder
    
    Parameters:
    
    operationTimeout - operation timeout
    
    unit - time unit for operationTimeout
  - ioThreads
```
public ClientBuilder ioThreads(int numIoThreads)
```
    Description copied from interface: ClientBuilder
    
    Set the number of threads to be used for handling connections to brokers (default: 1 thread)
    
    Specified by:
    
    ioThreads in interface ClientBuilder
  - listenerThreads
```
public ClientBuilder listenerThreads(int numListenerThreads)
```
    Description copied from interface: ClientBuilder
    
    Set the number of threads to be used for message listeners (default: 1 thread)
    
    Specified by:
    
    listenerThreads in interface ClientBuilder
  - connectionsPerBroker
```
public ClientBuilder connectionsPerBroker(int connectionsPerBroker)
```
    Description copied from interface: ClientBuilder
    
    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.
    
    Specified by:
    
    connectionsPerBroker in interface ClientBuilder
    
    Parameters:
    
    connectionsPerBroker - max number of connections per broker (needs to be greater than 0)
  - enableTcpNoDelay
```
public ClientBuilder enableTcpNoDelay(boolean useTcpNoDelay)
```
    Description copied from interface: ClientBuilder
    
    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
    
    Specified by:
    
    enableTcpNoDelay in interface ClientBuilder
  - enableTls
```
public ClientBuilder enableTls(boolean useTls)
```
    Description copied from interface: ClientBuilder
    
    Configure whether to use TLS encryption on the connection (default: true if serviceUrl starts with "pulsar+ssl://", false otherwise)
    
    Specified by:
    
    enableTls in interface ClientBuilder
  - enableTlsHostnameVerification
```
public ClientBuilder enableTlsHostnameVerification(boolean enableTlsHostnameVerification)
```
    Description copied from interface: ClientBuilder
    
    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.
    
    Specified by:
    
    enableTlsHostnameVerification in interface ClientBuilder
    
    See Also:
    
    rfc2818
  - tlsTrustCertsFilePath
```
public ClientBuilder tlsTrustCertsFilePath(String tlsTrustCertsFilePath)
```
    Description copied from interface: ClientBuilder
    
    Set the path to the trusted TLS certificate file
    
    Specified by:
    
    tlsTrustCertsFilePath in interface ClientBuilder
  - allowTlsInsecureConnection
```
public ClientBuilder allowTlsInsecureConnection(boolean tlsAllowInsecureConnection)
```
    Description copied from interface: ClientBuilder
    
    Configure whether the Pulsar client accept untrusted TLS certificate from broker (default: false)
    
    Specified by:
    
    allowTlsInsecureConnection in interface ClientBuilder
  - statsInterval
```
public ClientBuilder statsInterval(long statsInterval,
                                   TimeUnit unit)
```
    Description copied from interface: ClientBuilder
    
    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
    
    Specified by:
    
    statsInterval in interface ClientBuilder
    
    unit - time unit for statsInterval
  - maxConcurrentLookupRequests
```
public ClientBuilder maxConcurrentLookupRequests(int concurrentLookupRequests)
```
    Description copied from interface: ClientBuilder
    
    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
    
    Specified by:
    
    maxConcurrentLookupRequests in interface ClientBuilder
  - maxLookupRequests
```
public ClientBuilder maxLookupRequests(int maxLookupRequests)
```
    Description copied from interface: ClientBuilder
    
    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.
    
    Specified by:
    
    maxLookupRequests in interface ClientBuilder
  - maxNumberOfRejectedRequestPerConnection
```
public ClientBuilder maxNumberOfRejectedRequestPerConnection(int maxNumberOfRejectedRequestPerConnection)
```
    Description copied from interface: ClientBuilder
    
    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)
    
    Specified by:
    
    maxNumberOfRejectedRequestPerConnection in interface ClientBuilder
  - keepAliveInterval
```
public ClientBuilder keepAliveInterval(int keepAliveIntervalSeconds,
                                       TimeUnit unit)
```
    Description copied from interface: ClientBuilder
    
    Set keep alive interval in seconds for each client-broker-connection. (default: 30).
    
    Specified by:
    
    keepAliveInterval in interface ClientBuilder
    
    unit - time unit for statsInterval
  - getClientConfigurationData
```
public ClientConfigurationData getClientConfigurationData()
```

Class ClientBuilderImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientBuilderImpl

ClientBuilderImpl

Method Detail

build

clone

loadConf

serviceUrl

serviceUrlProvider

authentication

authentication

authentication

operationTimeout

ioThreads

listenerThreads

connectionsPerBroker

enableTcpNoDelay

enableTls

enableTlsHostnameVerification

tlsTrustCertsFilePath

allowTlsInsecureConnection

statsInterval

maxConcurrentLookupRequests

maxLookupRequests

maxNumberOfRejectedRequestPerConnection

keepAliveInterval

getClientConfigurationData