Package org.apache.pulsar.client.impl

Class PulsarClientImpl

java.lang.Object

org.apache.pulsar.client.impl.PulsarClientImpl

All Implemented Interfaces:

Closeable, AutoCloseable, PulsarClient

public class PulsarClientImpl
extends Object
implements PulsarClient

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PulsarClientImpl.State

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClientConfigurationData	conf
protected final io.netty.channel.EventLoopGroup	eventLoopGroup

Constructor Summary

Constructors

Constructor	Description
PulsarClientImpl(ClientConfigurationData conf)
PulsarClientImpl(ClientConfigurationData conf, io.netty.channel.EventLoopGroup eventLoopGroup)
PulsarClientImpl(ClientConfigurationData conf, io.netty.channel.EventLoopGroup eventLoopGroup, ConnectionPool cnxPool)
PulsarClientImpl(ClientConfigurationData conf, io.netty.channel.EventLoopGroup eventLoopGroup, ConnectionPool cnxPool, io.netty.util.Timer timer)
PulsarClientImpl(ClientConfigurationData conf, io.netty.channel.EventLoopGroup eventLoopGroup, ConnectionPool connectionPool, io.netty.util.Timer timer, ExecutorProvider externalExecutorProvider, ExecutorProvider internalExecutorProvider, ScheduledExecutorProvider scheduledExecutorProvider)

Method Summary

Modifier and Type	Method	Description
void	close()
CompletableFuture<Void>	closeAsync()
LookupService	createLookup(String url)
protected <T> CompletableFuture<Reader<T>>	createMultiTopicReaderAsync(ReaderConfigurationData<T> conf, Schema<T> schema)
CompletableFuture<Producer<byte[]>>	createProducerAsync(ProducerConfigurationData conf)
<T> CompletableFuture<Producer<T>>	createProducerAsync(ProducerConfigurationData conf, Schema<T> schema)
<T> CompletableFuture<Producer<T>>	createProducerAsync(ProducerConfigurationData conf, Schema<T> schema, ProducerInterceptors interceptors)
CompletableFuture<Reader<byte[]>>	createReaderAsync(ReaderConfigurationData<byte[]> conf)
<T> CompletableFuture<Reader<T>>	createReaderAsync(ReaderConfigurationData<T> conf, Schema<T> schema)
protected <T> CompletableFuture<Reader<T>>	createSingleTopicReaderAsync(ReaderConfigurationData<T> conf, Schema<T> schema)
io.netty.channel.EventLoopGroup	eventLoopGroup()
ExecutorProvider	externalExecutorProvider()
Clock	getClientClock()
ConnectionPool	getCnxPool()
ClientConfigurationData	getConfiguration()
CompletableFuture<ClientCnx>	getConnection(String topic)	Only for test.
CompletableFuture<ClientCnx>	getConnection(String topic, int randomKeyForSelectConnection)
CompletableFuture<ClientCnx>	getConnection(String topic, String url)
CompletableFuture<ClientCnx>	getConnection(InetSocketAddress logicalAddress, InetSocketAddress physicalAddress, int randomKeyForSelectConnection)
CompletableFuture<ClientCnx>	getConnectionToServiceUrl()
ExecutorService	getInternalExecutorService()
LookupService	getLookup()
LookupService	getLookup(String serviceUrl)
MemoryLimitController	getMemoryLimitController()
CompletableFuture<org.apache.pulsar.common.partition.PartitionedTopicMetadata>	getPartitionedTopicMetadata(String topic, boolean metadataAutoCreationEnabled, boolean useFallbackForNonPIP344Brokers)
CompletableFuture<List<String>>	getPartitionsForTopic(String topic, boolean metadataAutoCreationEnabled)
ScheduledExecutorProvider	getScheduledExecutorProvider()
CompletableFuture<Optional<SchemaInfo>>	getSchema(String topic)	Read the schema information for a given topic.
com.google.common.cache.LoadingCache<String,SchemaInfoProvider>	getSchemaProviderLoadingCache()
AtomicReference<PulsarClientImpl.State>	getState()
boolean	isClosed()
ConsumerBuilder<byte[]>	newConsumer()
<T> ConsumerBuilder<T>	newConsumer(Schema<T> schema)
protected <T> PartitionedProducerImpl<T>	newPartitionedProducerImpl(String topic, ProducerConfigurationData conf, Schema<T> schema, ProducerInterceptors interceptors, CompletableFuture<Producer<T>> producerCreatedFuture, int partitions)	Factory method for creating PartitionedProducerImpl instance.
ProducerBuilder<byte[]>	newProducer()
<T> ProducerBuilder<T>	newProducer(Schema<T> schema)
protected <T> ProducerImpl<T>	newProducerImpl(String topic, int partitionIndex, ProducerConfigurationData conf, Schema<T> schema, ProducerInterceptors interceptors, CompletableFuture<Producer<T>> producerCreatedFuture, Optional<String> overrideProducerName)	Factory method for creating ProducerImpl instance.
ReaderBuilder<byte[]>	newReader()
<T> ReaderBuilder<T>	newReader(Schema<T> schema)
long	newRequestId()
TableViewBuilder<byte[]>	newTableView()
<T> TableViewBuilder<T>	newTableView(Schema<T> schema)
<T> TableViewBuilder<T>	newTableViewBuilder(Schema<T> schema)	Deprecated. use newTableView(Schema) instead.
TransactionBuilder	newTransaction()
CompletableFuture<Consumer<byte[]>>	patternTopicSubscribeAsync(ConsumerConfigurationData<byte[]> conf)
protected <T> CompletableFuture<Schema<T>>	preProcessSchemaBeforeSubscribe(PulsarClientImpl pulsarClientImpl, Schema<T> schema, String topicName)
void	reloadLookUp()
void	setLookup(LookupService lookup)
void	shutdown()
CompletableFuture<Consumer<byte[]>>	subscribeAsync(ConsumerConfigurationData<byte[]> conf)
<T> CompletableFuture<Consumer<T>>	subscribeAsync(ConsumerConfigurationData<T> conf, Schema<T> schema, ConsumerInterceptors<T> interceptors)
io.netty.util.Timer	timer()	visible for pulsar-functions.
void	updateAuthentication(Authentication authentication)
void	updateServiceUrl(String serviceUrl)
void	updateTlsTrustCertsFilePath(String tlsTrustCertsFilePath)
void	updateTlsTrustStorePathAndPassword(String tlsTrustStorePath, String tlsTrustStorePassword)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.client.api.PulsarClient

getPartitionsForTopic

Field Details

conf

protected final ClientConfigurationData conf

eventLoopGroup

protected final io.netty.channel.EventLoopGroup eventLoopGroup

Constructor Details

PulsarClientImpl

public PulsarClientImpl(ClientConfigurationData conf)
                 throws PulsarClientException

Throws:

PulsarClientException

PulsarClientImpl

public PulsarClientImpl(ClientConfigurationData conf,
 io.netty.channel.EventLoopGroup eventLoopGroup)
                 throws PulsarClientException

Throws:

PulsarClientException

PulsarClientImpl

public PulsarClientImpl(ClientConfigurationData conf,
 io.netty.channel.EventLoopGroup eventLoopGroup,
 ConnectionPool cnxPool)
                 throws PulsarClientException

Throws:

PulsarClientException

PulsarClientImpl

public PulsarClientImpl(ClientConfigurationData conf,
 io.netty.channel.EventLoopGroup eventLoopGroup,
 ConnectionPool cnxPool,
 io.netty.util.Timer timer)
                 throws PulsarClientException

Throws:

PulsarClientException

PulsarClientImpl

public PulsarClientImpl(ClientConfigurationData conf,
 io.netty.channel.EventLoopGroup eventLoopGroup,
 ConnectionPool connectionPool,
 io.netty.util.Timer timer,
 ExecutorProvider externalExecutorProvider,
 ExecutorProvider internalExecutorProvider,
 ScheduledExecutorProvider scheduledExecutorProvider)
                 throws PulsarClientException

Throws:

PulsarClientException

Method Details

getConfiguration

public ClientConfigurationData getConfiguration()

getClientClock

public Clock getClientClock()

getState

public AtomicReference<PulsarClientImpl.State> getState()

newProducer

public ProducerBuilder<byte[]> newProducer()

Specified by:

newProducer in interface PulsarClient

newProducer

public <T> ProducerBuilder<T> newProducer(Schema<T> schema)

Specified by:

newProducer in interface PulsarClient

newConsumer

public ConsumerBuilder<byte[]> newConsumer()

Specified by:

newConsumer in interface PulsarClient

newConsumer

public <T> ConsumerBuilder<T> newConsumer(Schema<T> schema)

Specified by:

newConsumer in interface PulsarClient

newReader

public ReaderBuilder<byte[]> newReader()

Specified by:

newReader in interface PulsarClient

newReader

public <T> ReaderBuilder<T> newReader(Schema<T> schema)

Specified by:

newReader in interface PulsarClient

newTableViewBuilder

@Deprecated
public <T> TableViewBuilder<T> newTableViewBuilder(Schema<T> schema)

Deprecated.

use newTableView(Schema) instead.

Specified by:

newTableViewBuilder in interface PulsarClient

newTableView

public TableViewBuilder<byte[]> newTableView()

Specified by:

newTableView in interface PulsarClient

newTableView

public <T> TableViewBuilder<T> newTableView(Schema<T> schema)

Specified by:

newTableView in interface PulsarClient

createProducerAsync

public CompletableFuture<Producer<byte[]>> createProducerAsync(ProducerConfigurationData conf)

createProducerAsync

public <T> CompletableFuture<Producer<T>> createProducerAsync(ProducerConfigurationData conf,
 Schema<T> schema)

createProducerAsync

public <T> CompletableFuture<Producer<T>> createProducerAsync(ProducerConfigurationData conf,
 Schema<T> schema,
 ProducerInterceptors interceptors)

newPartitionedProducerImpl

protected <T> PartitionedProducerImpl<T> newPartitionedProducerImpl(String topic,
 ProducerConfigurationData conf,
 Schema<T> schema,
 ProducerInterceptors interceptors,
 CompletableFuture<Producer<T>> producerCreatedFuture,
 int partitions)

Factory method for creating PartitionedProducerImpl instance. Allows overriding the PartitionedProducerImpl instance in tests.

Type Parameters:

T - message type class

Parameters:

topic - topic name

conf - producer configuration

schema - topic schema

interceptors - producer interceptors

producerCreatedFuture - future for signaling completion of async producer creation

Returns:

new PartitionedProducerImpl instance

newProducerImpl

protected <T> ProducerImpl<T> newProducerImpl(String topic,
 int partitionIndex,
 ProducerConfigurationData conf,
 Schema<T> schema,
 ProducerInterceptors interceptors,
 CompletableFuture<Producer<T>> producerCreatedFuture,
 Optional<String> overrideProducerName)

Factory method for creating ProducerImpl instance. Allows overriding the ProducerImpl instance in tests.

Type Parameters:

T - message type class

Parameters:

topic - topic name

partitionIndex - partition index of a partitioned topic. the value -1 is used for non-partitioned topics.

conf - producer configuration

schema - topic schema

interceptors - producer interceptors

producerCreatedFuture - future for signaling completion of async producer creation

Returns:

a producer instance

subscribeAsync

public CompletableFuture<Consumer<byte[]>> subscribeAsync(ConsumerConfigurationData<byte[]> conf)

subscribeAsync

public <T> CompletableFuture<Consumer<T>> subscribeAsync(ConsumerConfigurationData<T> conf,
 Schema<T> schema,
 ConsumerInterceptors<T> interceptors)

patternTopicSubscribeAsync

public CompletableFuture<Consumer<byte[]>> patternTopicSubscribeAsync(ConsumerConfigurationData<byte[]> conf)

createReaderAsync

public CompletableFuture<Reader<byte[]>> createReaderAsync(ReaderConfigurationData<byte[]> conf)

createReaderAsync

public <T> CompletableFuture<Reader<T>> createReaderAsync(ReaderConfigurationData<T> conf,
 Schema<T> schema)

createMultiTopicReaderAsync

protected <T> CompletableFuture<Reader<T>> createMultiTopicReaderAsync(ReaderConfigurationData<T> conf,
 Schema<T> schema)

createSingleTopicReaderAsync

protected <T> CompletableFuture<Reader<T>> createSingleTopicReaderAsync(ReaderConfigurationData<T> conf,
 Schema<T> schema)

getSchema

public CompletableFuture<Optional<SchemaInfo>> getSchema(String topic)

Read the schema information for a given topic. If the topic does not exist or it has no schema associated, it will return an empty response

close

public void close()
           throws PulsarClientException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface PulsarClient

Throws:

PulsarClientException

closeAsync

public CompletableFuture<Void> closeAsync()

Specified by:

closeAsync in interface PulsarClient

shutdown

public void shutdown()
              throws PulsarClientException

Specified by:

shutdown in interface PulsarClient

Throws:

PulsarClientException

isClosed

public boolean isClosed()

Specified by:

isClosed in interface PulsarClient

updateServiceUrl

public void updateServiceUrl(String serviceUrl)
                      throws PulsarClientException

Specified by:

updateServiceUrl in interface PulsarClient

Throws:

PulsarClientException

updateAuthentication

public void updateAuthentication(Authentication authentication)
                          throws IOException

Throws:

IOException

updateTlsTrustCertsFilePath

public void updateTlsTrustCertsFilePath(String tlsTrustCertsFilePath)

updateTlsTrustStorePathAndPassword

public void updateTlsTrustStorePathAndPassword(String tlsTrustStorePath,
 String tlsTrustStorePassword)

getConnection

public CompletableFuture<ClientCnx> getConnection(String topic,
 int randomKeyForSelectConnection)

getConnection

public CompletableFuture<ClientCnx> getConnection(String topic)

Only for test.

getConnection

public CompletableFuture<ClientCnx> getConnection(String topic,
 String url)

getLookup

public LookupService getLookup(String serviceUrl)

getConnectionToServiceUrl

public CompletableFuture<ClientCnx> getConnectionToServiceUrl()

getConnection

public CompletableFuture<ClientCnx> getConnection(InetSocketAddress logicalAddress,
 InetSocketAddress physicalAddress,
 int randomKeyForSelectConnection)

timer

public io.netty.util.Timer timer()

visible for pulsar-functions.

externalExecutorProvider

public ExecutorProvider externalExecutorProvider()

newRequestId

public long newRequestId()

getCnxPool

public ConnectionPool getCnxPool()

eventLoopGroup

public io.netty.channel.EventLoopGroup eventLoopGroup()

setLookup

public void setLookup(LookupService lookup)

getLookup

public LookupService getLookup()

reloadLookUp

public void reloadLookUp()
                  throws PulsarClientException

Throws:

PulsarClientException

createLookup

public LookupService createLookup(String url)
                           throws PulsarClientException

Throws:

PulsarClientException

getPartitionedTopicMetadata

public CompletableFuture<org.apache.pulsar.common.partition.PartitionedTopicMetadata> getPartitionedTopicMetadata(String topic,
 boolean metadataAutoCreationEnabled,
 boolean useFallbackForNonPIP344Brokers)

Parameters:

useFallbackForNonPIP344Brokers -

If true, fallback to the prior behavior of the method getPartitionedTopicMetadata if the broker does not support the PIP-344 feature 'supports_get_partitioned_metadata_without_auto_creation'. This parameter only affects the behavior when is false.

getPartitionsForTopic

public CompletableFuture<List<String>> getPartitionsForTopic(String topic,
 boolean metadataAutoCreationEnabled)

Specified by:

getPartitionsForTopic in interface PulsarClient

getSchemaProviderLoadingCache

public com.google.common.cache.LoadingCache<String,SchemaInfoProvider> getSchemaProviderLoadingCache()

getMemoryLimitController

public MemoryLimitController getMemoryLimitController()

preProcessSchemaBeforeSubscribe

protected <T> CompletableFuture<Schema<T>> preProcessSchemaBeforeSubscribe(PulsarClientImpl pulsarClientImpl,
 Schema<T> schema,
 String topicName)

getInternalExecutorService

public ExecutorService getInternalExecutorService()

getScheduledExecutorProvider

public ScheduledExecutorProvider getScheduledExecutorProvider()

newTransaction

public TransactionBuilder newTransaction()

Specified by:

newTransaction in interface PulsarClient