Package org.apache.pulsar.broker.systopic

Class SystemTopicClientBase<T>

java.lang.Object

org.apache.pulsar.broker.systopic.SystemTopicClientBase<T>

All Implemented Interfaces:

SystemTopicClient<T>

Direct Known Subclasses:

TopicPoliciesSystemTopicClient, TransactionBufferSystemTopicClient

public abstract class SystemTopicClientBase<T>
extends Object
implements SystemTopicClient<T>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pulsar.broker.systopic.SystemTopicClient

SystemTopicClient.Reader<T>, SystemTopicClient.Writer<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.pulsar.client.api.PulsarClient	client
protected final List<SystemTopicClient.Reader<T>>	readers
protected final org.apache.pulsar.common.naming.TopicName	topicName
protected final List<SystemTopicClient.Writer<T>>	writers

Constructor Summary

Constructors

Constructor	Description
SystemTopicClientBase(org.apache.pulsar.client.api.PulsarClient client, org.apache.pulsar.common.naming.TopicName topicName)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the system topic.
CompletableFuture<Void>	closeAsync()	Close the system topic asynchronously.
List<SystemTopicClient.Reader<T>>	getReaders()	Get all readers of the system topic.
org.apache.pulsar.common.naming.TopicName	getTopicName()	Get topic name of the system topic.
List<SystemTopicClient.Writer<T>>	getWriters()	Get all writers of the system topic.
SystemTopicClient.Reader<T>	newReader()	Create a reader for the system topic.
CompletableFuture<SystemTopicClient.Reader<T>>	newReaderAsync()	Create a reader for the system topic asynchronously.
protected abstract CompletableFuture<SystemTopicClient.Reader<T>>	newReaderAsyncInternal()
SystemTopicClient.Writer<T>	newWriter()	Create a writer for the system topic.
CompletableFuture<SystemTopicClient.Writer<T>>	newWriterAsync()	Create a writer for the system topic asynchronously.
protected abstract CompletableFuture<SystemTopicClient.Writer<T>>	newWriterAsyncInternal()

Methods inherited from class java.lang.Object

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

Field Details

topicName

protected final org.apache.pulsar.common.naming.TopicName topicName

client

protected final org.apache.pulsar.client.api.PulsarClient client

writers

protected final List<SystemTopicClient.Writer<T>> writers

readers

protected final List<SystemTopicClient.Reader<T>> readers

Constructor Details

SystemTopicClientBase

public SystemTopicClientBase(org.apache.pulsar.client.api.PulsarClient client,
 org.apache.pulsar.common.naming.TopicName topicName)

Method Details

newReader

public SystemTopicClient.Reader<T> newReader()
                                      throws org.apache.pulsar.client.api.PulsarClientException

Description copied from interface: SystemTopicClient

Create a reader for the system topic.

Specified by:

newReader in interface SystemTopicClient<T>

Returns:

a new reader for the system topic

Throws:

org.apache.pulsar.client.api.PulsarClientException

newReaderAsync

public CompletableFuture<SystemTopicClient.Reader<T>> newReaderAsync()

Description copied from interface: SystemTopicClient

Create a reader for the system topic asynchronously.

Specified by:

newReaderAsync in interface SystemTopicClient<T>

newWriter

public SystemTopicClient.Writer<T> newWriter()
                                      throws org.apache.pulsar.client.api.PulsarClientException

Description copied from interface: SystemTopicClient

Create a writer for the system topic.

Specified by:

newWriter in interface SystemTopicClient<T>

Returns:

writer for the system topic

Throws:

org.apache.pulsar.client.api.PulsarClientException

newWriterAsync

public CompletableFuture<SystemTopicClient.Writer<T>> newWriterAsync()

Description copied from interface: SystemTopicClient

Create a writer for the system topic asynchronously.

Specified by:

newWriterAsync in interface SystemTopicClient<T>

newWriterAsyncInternal

protected abstract CompletableFuture<SystemTopicClient.Writer<T>> newWriterAsyncInternal()

newReaderAsyncInternal

protected abstract CompletableFuture<SystemTopicClient.Reader<T>> newReaderAsyncInternal()

closeAsync

public CompletableFuture<Void> closeAsync()

Description copied from interface: SystemTopicClient

Close the system topic asynchronously.

Specified by:

closeAsync in interface SystemTopicClient<T>

Returns:

close

public void close()
           throws Exception

Description copied from interface: SystemTopicClient

Close the system topic.

Specified by:

close in interface SystemTopicClient<T>

Throws:

Exception

getTopicName

public org.apache.pulsar.common.naming.TopicName getTopicName()

Description copied from interface: SystemTopicClient

Get topic name of the system topic.

Specified by:

getTopicName in interface SystemTopicClient<T>

Returns:

topic name

getReaders

public List<SystemTopicClient.Reader<T>> getReaders()

Description copied from interface: SystemTopicClient

Get all readers of the system topic.

Specified by:

getReaders in interface SystemTopicClient<T>

Returns:

Set the set of readers

getWriters

public List<SystemTopicClient.Writer<T>> getWriters()

Description copied from interface: SystemTopicClient

Get all writers of the system topic.

Specified by:

getWriters in interface SystemTopicClient<T>

Returns:

Set the set of writers