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

Constructor Summary

Constructors

Constructor and Description
PulsarClientImpl(ClientConfigurationData conf)
PulsarClientImpl(ClientConfigurationData conf, io.netty.channel.EventLoopGroup eventLoopGroup)
PulsarClientImpl(ClientConfigurationData conf, io.netty.channel.EventLoopGroup eventLoopGroup, ConnectionPool cnxPool)
PulsarClientImpl(String serviceUrl, ClientConfiguration conf) Deprecated.
PulsarClientImpl(String serviceUrl, ClientConfiguration conf, io.netty.channel.EventLoopGroup eventLoopGroup) Deprecated.
PulsarClientImpl(String serviceUrl, ClientConfiguration conf, io.netty.channel.EventLoopGroup eventLoopGroup, ConnectionPool cnxPool) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	close() Close the PulsarClient and release all the resources.
CompletableFuture<Void>	closeAsync() Asynchronously close the PulsarClient and release all the resources.
Producer<byte[]>	createProducer(String topic) Create a producer with default ProducerConfiguration for publishing on a specific topic
Producer<byte[]>	createProducer(String topic, ProducerConfiguration conf) Create a producer with given ProducerConfiguration for publishing on a specific topic
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<T> interceptors)
CompletableFuture<Producer<byte[]>>	createProducerAsync(String topic) Asynchronously create a producer with default ProducerConfiguration for publishing on a specific topic
CompletableFuture<Producer<byte[]>>	createProducerAsync(String topic, ProducerConfiguration conf) Asynchronously create a producer with given ProducerConfiguration for publishing on a specific topic
Reader<byte[]>	createReader(String topic, MessageId startMessageId, ReaderConfiguration conf) Create a topic reader with given ReaderConfiguration for reading messages from the specified topic.
CompletableFuture<Reader<byte[]>>	createReaderAsync(ReaderConfigurationData<byte[]> conf)
<T> CompletableFuture<Reader<T>>	createReaderAsync(ReaderConfigurationData<T> conf, Schema<T> schema)
CompletableFuture<Reader<byte[]>>	createReaderAsync(String topic, MessageId startMessageId, ReaderConfiguration conf) Asynchronously create a topic reader with given ReaderConfiguration for reading messages from the specified topic.
io.netty.channel.EventLoopGroup	eventLoopGroup()
ConnectionPool	getCnxPool()
ClientConfigurationData	getConfiguration()
protected CompletableFuture<ClientCnx>	getConnection(String topic)
LookupService	getLookup()
CompletableFuture<Integer>	getNumberOfPartitions(String topic)
CompletableFuture<PartitionedTopicMetadata>	getPartitionedTopicMetadata(String topic)
CompletableFuture<Optional<SchemaInfo>>	getSchema(String topic) Read the schema information for a given topic.
ConsumerBuilder<byte[]>	newConsumer() Create a consumer with default for subscribing on a specific topic
<T> ConsumerBuilder<T>	newConsumer(Schema<T> schema) Create a consumer with default for subscribing on a specific topic Since 2.2, if you are creating a consumer with non-bytes schema on a non-existence topic, it will automatically create the topic with the provided schema.
ProducerBuilder<byte[]>	newProducer() Create a producer with default for publishing on a specific topic
<T> ProducerBuilder<T>	newProducer(Schema<T> schema) Create a producer with default for publishing on a specific topic
ReaderBuilder<byte[]>	newReader() Create a topic reader for reading messages from the specified topic.
<T> ReaderBuilder<T>	newReader(Schema<T> schema) Create a topic reader for reading messages from the specified topic.
long	newRequestId()
CompletableFuture<Consumer<byte[]>>	patternTopicSubscribeAsync(ConsumerConfigurationData<byte[]> conf)
void	reloadLookUp()
void	shutdown() Perform immediate shutdown of PulsarClient.
Consumer<byte[]>	subscribe(String topic, String subscription) Subscribe to the given topic and subscription combination with default ConsumerConfiguration
Consumer<byte[]>	subscribe(String topic, String subscription, ConsumerConfiguration conf) Subscribe to the given topic and subscription combination with given ConsumerConfiguration
CompletableFuture<Consumer<byte[]>>	subscribeAsync(ConsumerConfigurationData<byte[]> conf)
<T> CompletableFuture<Consumer<T>>	subscribeAsync(ConsumerConfigurationData<T> conf, Schema<T> schema, ConsumerInterceptors<T> interceptors)
CompletableFuture<Consumer<byte[]>>	subscribeAsync(String topic, String subscription) Asynchronously subscribe to the given topic and subscription combination using default ConsumerConfiguration
CompletableFuture<Consumer<byte[]>>	subscribeAsync(String topic, String subscription, ConsumerConfiguration conf) Asynchronously subscribe to the given topic and subscription combination using given ConsumerConfiguration
io.netty.util.Timer	timer() visiable for pulsar-functions
static List<String>	topicsPatternFilter(List<String> original, Pattern topicsPattern)
void	updateServiceUrl(String serviceUrl) Update the service URL this client is using.

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

builder, create, create

Constructor Detail

PulsarClientImpl

@Deprecated
public PulsarClientImpl(String serviceUrl,
                                    ClientConfiguration conf)
                             throws PulsarClientException

Deprecated.

Throws:

PulsarClientException

PulsarClientImpl

@Deprecated
public PulsarClientImpl(String serviceUrl,
                                    ClientConfiguration conf,
                                    io.netty.channel.EventLoopGroup eventLoopGroup)
                             throws PulsarClientException

Deprecated.

Throws:

PulsarClientException

PulsarClientImpl

@Deprecated
public PulsarClientImpl(String serviceUrl,
                                    ClientConfiguration conf,
                                    io.netty.channel.EventLoopGroup eventLoopGroup,
                                    ConnectionPool cnxPool)
                             throws PulsarClientException

Deprecated.

Throws:

PulsarClientException

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

Method Detail

getConfiguration

public ClientConfigurationData getConfiguration()

newProducer

public ProducerBuilder<byte[]> newProducer()

Description copied from interface: PulsarClient

Create a producer with default for publishing on a specific topic

Example: Producer producer = client.newProducer().topic(myTopic).create();

Specified by:

newProducer in interface PulsarClient

Returns:

a ProducerBuilder object to configure and construct the Producer instance

newProducer

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

Description copied from interface: PulsarClient

Create a producer with default for publishing on a specific topic

Example: Producer producer = client.newProducer(mySchema).topic(myTopic).create();

Specified by:

newProducer in interface PulsarClient

Parameters:

schema - provide a way to convert between serialized data and domain objects

Returns:

a ProducerBuilder object to configure and construct the Producer instance

newConsumer

public ConsumerBuilder<byte[]> newConsumer()

Description copied from interface: PulsarClient

Create a consumer with default for subscribing on a specific topic

Specified by:

newConsumer in interface PulsarClient

Returns:

a ConsumerBuilder object to configure and construct the Consumer instance

newConsumer

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

Description copied from interface: PulsarClient

Create a consumer with default for subscribing on a specific topic Since 2.2, if you are creating a consumer with non-bytes schema on a non-existence topic, it will automatically create the topic with the provided schema.

Specified by:

newConsumer in interface PulsarClient

Parameters:

schema - provide a way to convert between serialized data and domain objects

Returns:

a ConsumerBuilder object to configure and construct the Consumer instance

newReader

public ReaderBuilder<byte[]> newReader()

Description copied from interface: PulsarClient

Create a topic reader for reading messages from the specified topic.

The Reader provides a low-level abstraction that allows for manual positioning in the topic, without using a subscription. Reader can only work on non-partitioned topics.

Specified by:

newReader in interface PulsarClient

Returns:

a ReaderBuilder that can be used to configure and construct a Reader instance

newReader

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

Description copied from interface: PulsarClient

Create a topic reader for reading messages from the specified topic.

The Reader provides a low-level abstraction that allows for manual positioning in the topic, without using a subscription. Reader can only work on non-partitioned topics.

Specified by:

newReader in interface PulsarClient

Parameters:

schema - provide a way to convert between serialized data and domain objects

Returns:

a ReaderBuilder that can be used to configure and construct a Reader instance

createProducer

public Producer<byte[]> createProducer(String topic)
                                throws PulsarClientException

Description copied from interface: PulsarClient

Create a producer with default ProducerConfiguration for publishing on a specific topic

Specified by:

createProducer in interface PulsarClient

Parameters:

topic - The name of the topic where to produce

Returns:

The producer object

Throws:

PulsarClientException.AlreadyClosedException - if the client was already closed

PulsarClientException.InvalidTopicNameException - if the topic name is not valid

PulsarClientException.AuthenticationException - if there was an error with the supplied credentials

PulsarClientException.AuthorizationException - if the authorization to publish on topic was denied

PulsarClientException

createProducer

public Producer<byte[]> createProducer(String topic,
                                       ProducerConfiguration conf)
                                throws PulsarClientException

Description copied from interface: PulsarClient

Create a producer with given ProducerConfiguration for publishing on a specific topic

Specified by:

createProducer in interface PulsarClient

Parameters:

topic - The name of the topic where to produce

conf - The ProducerConfiguration object

Returns:

The producer object

Throws:

PulsarClientException - if it was not possible to create the producer

createProducerAsync

public CompletableFuture<Producer<byte[]>> createProducerAsync(String topic)

Description copied from interface: PulsarClient

Asynchronously create a producer with default ProducerConfiguration for publishing on a specific topic

Specified by:

createProducerAsync in interface PulsarClient

Parameters:

topic - The name of the topic where to produce

Returns:

Future of the asynchronously created producer object

createProducerAsync

public CompletableFuture<Producer<byte[]>> createProducerAsync(String topic,
                                                               ProducerConfiguration conf)

Description copied from interface: PulsarClient

Asynchronously create a producer with given ProducerConfiguration for publishing on a specific topic

Specified by:

createProducerAsync in interface PulsarClient

Parameters:

topic - The name of the topic where to produce

conf - The ProducerConfiguration object

Returns:

Future of the asynchronously created producer object

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<T> interceptors)

subscribe

public Consumer<byte[]> subscribe(String topic,
                                  String subscription)
                           throws PulsarClientException

Description copied from interface: PulsarClient

Subscribe to the given topic and subscription combination with default ConsumerConfiguration

Specified by:

subscribe in interface PulsarClient

Parameters:

topic - The name of the topic

subscription - The name of the subscription

Returns:

The Consumer object

Throws:

PulsarClientException

subscribe

public Consumer<byte[]> subscribe(String topic,
                                  String subscription,
                                  ConsumerConfiguration conf)
                           throws PulsarClientException

Description copied from interface: PulsarClient

Subscribe to the given topic and subscription combination with given ConsumerConfiguration

Specified by:

subscribe in interface PulsarClient

Parameters:

topic - The name of the topic

subscription - The name of the subscription

conf - The ConsumerConfiguration object

Returns:

The Consumer object

Throws:

PulsarClientException

subscribeAsync

public CompletableFuture<Consumer<byte[]>> subscribeAsync(String topic,
                                                          String subscription)

Description copied from interface: PulsarClient

Asynchronously subscribe to the given topic and subscription combination using default ConsumerConfiguration

Specified by:

subscribeAsync in interface PulsarClient

Parameters:

topic - The topic name

subscription - The subscription name

Returns:

Future of the Consumer object

subscribeAsync

public CompletableFuture<Consumer<byte[]>> subscribeAsync(String topic,
                                                          String subscription,
                                                          ConsumerConfiguration conf)

Description copied from interface: PulsarClient

Asynchronously subscribe to the given topic and subscription combination using given ConsumerConfiguration

Specified by:

subscribeAsync in interface PulsarClient

Parameters:

topic - The name of the topic

subscription - The name of the subscription

conf - The ConsumerConfiguration object

Returns:

Future of the Consumer object

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)

topicsPatternFilter

public static List<String> topicsPatternFilter(List<String> original,
                                               Pattern topicsPattern)

createReader

public Reader<byte[]> createReader(String topic,
                                   MessageId startMessageId,
                                   ReaderConfiguration conf)
                            throws PulsarClientException

Description copied from interface: PulsarClient

Create a topic reader with given ReaderConfiguration for reading messages from the specified topic.

The Reader provides a low-level abstraction that allows for manual positioning in the topic, without using a subscription. Reader can only work on non-partitioned topics.

The initial reader positioning is done by specifying a message id. The options are:

• MessageId.earliest : Start reading from the earliest message available in the topic
• MessageId.latest : Start reading from the end topic, only getting messages published after the reader was created
• MessageId : When passing a particular message id, the reader will position itself on that specific position. The first message to be read will be the message next to the specified messageId.

Specified by:

createReader in interface PulsarClient

Parameters:

topic - The name of the topic where to read

startMessageId - The message id where the reader will position itself. The first message returned will be the one after the specified startMessageId

conf - The ReaderConfiguration object

Returns:

The Reader object

Throws:

PulsarClientException

createReaderAsync

public CompletableFuture<Reader<byte[]>> createReaderAsync(String topic,
                                                           MessageId startMessageId,
                                                           ReaderConfiguration conf)

Description copied from interface: PulsarClient

Asynchronously create a topic reader with given ReaderConfiguration for reading messages from the specified topic.

The Reader provides a low-level abstraction that allows for manual positioning in the topic, without using a subscription. Reader can only work on non-partitioned topics.

The initial reader positioning is done by specifying a message id. The options are:

• MessageId.earliest : Start reading from the earliest message available in the topic
• MessageId.latest : Start reading from the end topic, only getting messages published after the reader was created
• MessageId : When passing a particular message id, the reader will position itself on that specific position. The first message to be read will be the message next to the specified messageId.

Specified by:

createReaderAsync in interface PulsarClient

Parameters:

topic - The name of the topic where to read

startMessageId - The message id where the reader will position itself. The first message returned will be the one after the specified startMessageId

conf - The ReaderConfiguration object

Returns:

Future of the asynchronously created producer object

createReaderAsync

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

createReaderAsync

public <T> CompletableFuture<Reader<T>> createReaderAsync(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

Description copied from interface: PulsarClient

Close the PulsarClient and release all the resources. All the producers and consumers will be orderly closed. Waits until all pending write request are persisted.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface PulsarClient

Throws:

PulsarClientException - if the close operation fails

closeAsync

public CompletableFuture<Void> closeAsync()

Description copied from interface: PulsarClient

Asynchronously close the PulsarClient and release all the resources. All the producers and consumers will be orderly closed. Waits until all pending write request are persisted.

Specified by:

closeAsync in interface PulsarClient

shutdown

public void shutdown()
              throws PulsarClientException

Description copied from interface: PulsarClient

Perform immediate shutdown of PulsarClient. Release all the resources and close all the producers without waiting for ongoing operations to complete.

Specified by:

shutdown in interface PulsarClient

Throws:

PulsarClientException - if the forceful shutdown fails

updateServiceUrl

public void updateServiceUrl(String serviceUrl)
                      throws PulsarClientException

Description copied from interface: PulsarClient

Update the service URL this client is using. This will force the client close all existing connections and to restart service discovery to the new service endpoint.

Specified by:

updateServiceUrl in interface PulsarClient

Parameters:

serviceUrl - the new service URL this client should connect to

Throws:

PulsarClientException - in case the serviceUrl is not valid

getConnection

protected CompletableFuture<ClientCnx> getConnection(String topic)

timer

public io.netty.util.Timer timer()

visiable for pulsar-functions

newRequestId

public long newRequestId()

getCnxPool

public ConnectionPool getCnxPool()

eventLoopGroup

public io.netty.channel.EventLoopGroup eventLoopGroup()

getLookup

public LookupService getLookup()

reloadLookUp

public void reloadLookUp()
                  throws PulsarClientException

Throws:

PulsarClientException

getNumberOfPartitions

public CompletableFuture<Integer> getNumberOfPartitions(String topic)

getPartitionedTopicMetadata

public CompletableFuture<PartitionedTopicMetadata> getPartitionedTopicMetadata(String topic)