Package org.apache.pulsar.client.impl

Class ClientBuilderImpl

java.lang.Object

org.apache.pulsar.client.impl.ClientBuilderImpl

All Implemented Interfaces:

Serializable, Cloneable, ClientBuilder

public class ClientBuilderImpl
extends Object
implements ClientBuilder

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClientBuilderImpl()
ClientBuilderImpl(ClientConfigurationData conf)

Method Summary

Modifier and Type	Method	Description
ClientBuilder	allowTlsInsecureConnection(boolean tlsAllowInsecureConnection)
ClientBuilder	authentication(String authPluginClassName, String authParamsString)
ClientBuilder	authentication(String authPluginClassName, Map<String,String> authParams)
ClientBuilder	authentication(Authentication authentication)
PulsarClient	build()
ClientBuilder	clock(Clock clock)
ClientBuilder	clone()
ClientBuilder	connectionMaxIdleSeconds(int connectionMaxIdleSeconds)
ClientBuilder	connectionsPerBroker(int connectionsPerBroker)
ClientBuilder	connectionTimeout(int duration, TimeUnit unit)
ClientBuilder	description(String description)	Set the description.
ClientBuilder	dnsLookupBind(String address, int port)
ClientBuilder	enableBusyWait(boolean enableBusyWait)
ClientBuilder	enableTcpNoDelay(boolean useTcpNoDelay)
ClientBuilder	enableTls(boolean useTls)
ClientBuilder	enableTlsHostnameVerification(boolean enableTlsHostnameVerification)
ClientBuilder	enableTransaction(boolean enableTransaction)
ClientConfigurationData	getClientConfigurationData()
ClientBuilder	ioThreads(int numIoThreads)
ClientBuilder	keepAliveInterval(int keepAliveInterval, TimeUnit unit)
ClientBuilder	listenerName(String listenerName)
ClientBuilder	listenerThreads(int numListenerThreads)
ClientBuilder	loadConf(Map<String,Object> config)
ClientBuilder	lookupTimeout(int lookupTimeout, TimeUnit unit)
ClientBuilder	maxBackoffInterval(long duration, TimeUnit unit)
ClientBuilder	maxConcurrentLookupRequests(int concurrentLookupRequests)
ClientBuilder	maxLookupRedirects(int maxLookupRedirects)
ClientBuilder	maxLookupRequests(int maxLookupRequests)
ClientBuilder	maxNumberOfRejectedRequestPerConnection(int maxNumberOfRejectedRequestPerConnection)
ClientBuilder	memoryLimit(long memoryLimit, SizeUnit unit)
ClientBuilder	operationTimeout(int operationTimeout, TimeUnit unit)
ClientBuilder	proxyServiceUrl(String proxyServiceUrl, ProxyProtocol proxyProtocol)
ClientBuilder	serviceUrl(String serviceUrl)
ClientBuilder	serviceUrlProvider(ServiceUrlProvider serviceUrlProvider)
ClientBuilder	socks5ProxyAddress(InetSocketAddress socks5ProxyAddress)
ClientBuilder	socks5ProxyPassword(String socks5ProxyPassword)
ClientBuilder	socks5ProxyUsername(String socks5ProxyUsername)
ClientBuilder	sslProvider(String sslProvider)
ClientBuilder	startingBackoffInterval(long duration, TimeUnit unit)
ClientBuilder	statsInterval(long statsInterval, TimeUnit unit)
ClientBuilder	tlsCertificateFilePath(String tlsCertificateFilePath)
ClientBuilder	tlsCiphers(Set<String> tlsCiphers)
ClientBuilder	tlsKeyFilePath(String tlsKeyFilePath)
ClientBuilder	tlsKeyStorePassword(String tlsKeyStorePassword)
ClientBuilder	tlsKeyStorePath(String tlsTrustStorePath)
ClientBuilder	tlsKeyStoreType(String tlsKeyStoreType)
ClientBuilder	tlsProtocols(Set<String> tlsProtocols)
ClientBuilder	tlsTrustCertsFilePath(String tlsTrustCertsFilePath)
ClientBuilder	tlsTrustStorePassword(String tlsTrustStorePassword)
ClientBuilder	tlsTrustStorePath(String tlsTrustStorePath)
ClientBuilder	tlsTrustStoreType(String tlsTrustStoreType)
ClientBuilder	useKeyStoreTls(boolean useKeyStoreTls)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClientBuilderImpl

public ClientBuilderImpl()

ClientBuilderImpl

public ClientBuilderImpl(ClientConfigurationData conf)

Method Details

build

public PulsarClient build()
                   throws PulsarClientException

Specified by:

build in interface ClientBuilder

Throws:

PulsarClientException

clone

public ClientBuilder clone()

Specified by:

clone in interface ClientBuilder

Overrides:

clone in class Object

loadConf

public ClientBuilder loadConf(Map<String,Object> config)

Specified by:

loadConf in interface ClientBuilder

serviceUrl

public ClientBuilder serviceUrl(String serviceUrl)

Specified by:

serviceUrl in interface ClientBuilder

serviceUrlProvider

public ClientBuilder serviceUrlProvider(ServiceUrlProvider serviceUrlProvider)

Specified by:

serviceUrlProvider in interface ClientBuilder

listenerName

public ClientBuilder listenerName(String listenerName)

Specified by:

listenerName in interface ClientBuilder

connectionMaxIdleSeconds

public ClientBuilder connectionMaxIdleSeconds(int connectionMaxIdleSeconds)

Specified by:

connectionMaxIdleSeconds in interface ClientBuilder

authentication

public ClientBuilder authentication(Authentication authentication)

Specified by:

authentication in interface ClientBuilder

authentication

public ClientBuilder authentication(String authPluginClassName,
 String authParamsString)
                             throws PulsarClientException.UnsupportedAuthenticationException

Specified by:

authentication in interface ClientBuilder

Throws:

PulsarClientException.UnsupportedAuthenticationException

authentication

public ClientBuilder authentication(String authPluginClassName,
 Map<String,String> authParams)
                             throws PulsarClientException.UnsupportedAuthenticationException

Specified by:

authentication in interface ClientBuilder

Throws:

PulsarClientException.UnsupportedAuthenticationException

operationTimeout

public ClientBuilder operationTimeout(int operationTimeout,
 TimeUnit unit)

Specified by:

operationTimeout in interface ClientBuilder

lookupTimeout

public ClientBuilder lookupTimeout(int lookupTimeout,
 TimeUnit unit)

Specified by:

lookupTimeout in interface ClientBuilder

ioThreads

public ClientBuilder ioThreads(int numIoThreads)

Specified by:

ioThreads in interface ClientBuilder

listenerThreads

public ClientBuilder listenerThreads(int numListenerThreads)

Specified by:

listenerThreads in interface ClientBuilder

connectionsPerBroker

public ClientBuilder connectionsPerBroker(int connectionsPerBroker)

Specified by:

connectionsPerBroker in interface ClientBuilder

enableTcpNoDelay

public ClientBuilder enableTcpNoDelay(boolean useTcpNoDelay)

Specified by:

enableTcpNoDelay in interface ClientBuilder

enableTls

public ClientBuilder enableTls(boolean useTls)

Specified by:

enableTls in interface ClientBuilder

tlsKeyFilePath

public ClientBuilder tlsKeyFilePath(String tlsKeyFilePath)

Specified by:

tlsKeyFilePath in interface ClientBuilder

tlsCertificateFilePath

public ClientBuilder tlsCertificateFilePath(String tlsCertificateFilePath)

Specified by:

tlsCertificateFilePath in interface ClientBuilder

enableTlsHostnameVerification

public ClientBuilder enableTlsHostnameVerification(boolean enableTlsHostnameVerification)

Specified by:

enableTlsHostnameVerification in interface ClientBuilder

tlsTrustCertsFilePath

public ClientBuilder tlsTrustCertsFilePath(String tlsTrustCertsFilePath)

Specified by:

tlsTrustCertsFilePath in interface ClientBuilder

allowTlsInsecureConnection

public ClientBuilder allowTlsInsecureConnection(boolean tlsAllowInsecureConnection)

Specified by:

allowTlsInsecureConnection in interface ClientBuilder

useKeyStoreTls

public ClientBuilder useKeyStoreTls(boolean useKeyStoreTls)

Specified by:

useKeyStoreTls in interface ClientBuilder

sslProvider

public ClientBuilder sslProvider(String sslProvider)

Specified by:

sslProvider in interface ClientBuilder

tlsKeyStoreType

public ClientBuilder tlsKeyStoreType(String tlsKeyStoreType)

Specified by:

tlsKeyStoreType in interface ClientBuilder

tlsKeyStorePath

public ClientBuilder tlsKeyStorePath(String tlsTrustStorePath)

Specified by:

tlsKeyStorePath in interface ClientBuilder

tlsKeyStorePassword

public ClientBuilder tlsKeyStorePassword(String tlsKeyStorePassword)

Specified by:

tlsKeyStorePassword in interface ClientBuilder

tlsTrustStoreType

public ClientBuilder tlsTrustStoreType(String tlsTrustStoreType)

Specified by:

tlsTrustStoreType in interface ClientBuilder

tlsTrustStorePath

public ClientBuilder tlsTrustStorePath(String tlsTrustStorePath)

Specified by:

tlsTrustStorePath in interface ClientBuilder

tlsTrustStorePassword

public ClientBuilder tlsTrustStorePassword(String tlsTrustStorePassword)

Specified by:

tlsTrustStorePassword in interface ClientBuilder

tlsCiphers

public ClientBuilder tlsCiphers(Set<String> tlsCiphers)

Specified by:

tlsCiphers in interface ClientBuilder

tlsProtocols

public ClientBuilder tlsProtocols(Set<String> tlsProtocols)

Specified by:

tlsProtocols in interface ClientBuilder

statsInterval

public ClientBuilder statsInterval(long statsInterval,
 TimeUnit unit)

Specified by:

statsInterval in interface ClientBuilder

maxConcurrentLookupRequests

public ClientBuilder maxConcurrentLookupRequests(int concurrentLookupRequests)

Specified by:

maxConcurrentLookupRequests in interface ClientBuilder

maxLookupRequests

public ClientBuilder maxLookupRequests(int maxLookupRequests)

Specified by:

maxLookupRequests in interface ClientBuilder

maxLookupRedirects

public ClientBuilder maxLookupRedirects(int maxLookupRedirects)

Specified by:

maxLookupRedirects in interface ClientBuilder

maxNumberOfRejectedRequestPerConnection

public ClientBuilder maxNumberOfRejectedRequestPerConnection(int maxNumberOfRejectedRequestPerConnection)

Specified by:

maxNumberOfRejectedRequestPerConnection in interface ClientBuilder

keepAliveInterval

public ClientBuilder keepAliveInterval(int keepAliveInterval,
 TimeUnit unit)

Specified by:

keepAliveInterval in interface ClientBuilder

connectionTimeout

public ClientBuilder connectionTimeout(int duration,
 TimeUnit unit)

Specified by:

connectionTimeout in interface ClientBuilder

startingBackoffInterval

public ClientBuilder startingBackoffInterval(long duration,
 TimeUnit unit)

Specified by:

startingBackoffInterval in interface ClientBuilder

maxBackoffInterval

public ClientBuilder maxBackoffInterval(long duration,
 TimeUnit unit)

Specified by:

maxBackoffInterval in interface ClientBuilder

enableBusyWait

public ClientBuilder enableBusyWait(boolean enableBusyWait)

Specified by:

enableBusyWait in interface ClientBuilder

getClientConfigurationData

public ClientConfigurationData getClientConfigurationData()

memoryLimit

public ClientBuilder memoryLimit(long memoryLimit,
 SizeUnit unit)

Specified by:

memoryLimit in interface ClientBuilder

clock

public ClientBuilder clock(Clock clock)

Specified by:

clock in interface ClientBuilder

proxyServiceUrl

public ClientBuilder proxyServiceUrl(String proxyServiceUrl,
 ProxyProtocol proxyProtocol)

Specified by:

proxyServiceUrl in interface ClientBuilder

enableTransaction

public ClientBuilder enableTransaction(boolean enableTransaction)

Specified by:

enableTransaction in interface ClientBuilder

dnsLookupBind

public ClientBuilder dnsLookupBind(String address,
 int port)

Specified by:

dnsLookupBind in interface ClientBuilder

socks5ProxyAddress

public ClientBuilder socks5ProxyAddress(InetSocketAddress socks5ProxyAddress)

Specified by:

socks5ProxyAddress in interface ClientBuilder

socks5ProxyUsername

public ClientBuilder socks5ProxyUsername(String socks5ProxyUsername)

Specified by:

socks5ProxyUsername in interface ClientBuilder

socks5ProxyPassword

public ClientBuilder socks5ProxyPassword(String socks5ProxyPassword)

Specified by:

socks5ProxyPassword in interface ClientBuilder

description

public ClientBuilder description(String description)

Set the description.

By default, when the client connects to the broker, a version string like "Pulsar-Java-v<x.y.z>" will be carried and saved by the broker. The client version string could be queried from the topic stats.

This method provides a way to add more description to a specific PulsarClient instance. If it's configured, the description will be appended to the original client version string, with '-' as the separator.

For example, if the client version is 3.0.0, and the description is "forked", the final client version string will be "Pulsar-Java-v3.0.0-forked".

Parameters:

description - the description of the current PulsarClient instance

Throws:

IllegalArgumentException - if the length of description exceeds 64