org.apache.pulsar.broker.systopic

Class SystemTopicClientBase

java.lang.Object

org.apache.pulsar.broker.systopic.SystemTopicClientBase

All Implemented Interfaces:

SystemTopicClient

Direct Known Subclasses:

TopicPoliciesSystemTopicClient

public abstract class SystemTopicClientBase
extends Object
implements SystemTopicClient

Nested Class Summary

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

SystemTopicClient.Reader, SystemTopicClient.Writer

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Close the system topic
CompletableFuture<Void>	closeAsync() Close the system topic asynchronously.
List<SystemTopicClient.Reader>	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>	getWriters() Get all writers of the system topic
SystemTopicClient.Reader	newReader() Create a reader for the system topic.
CompletableFuture<SystemTopicClient.Reader>	newReaderAsync() Create a reader for the system topic asynchronously.
protected abstract CompletableFuture<SystemTopicClient.Reader>	newReaderAsyncInternal()
SystemTopicClient.Writer	newWriter() Create a writer for the system topic.
CompletableFuture<SystemTopicClient.Writer>	newWriterAsync() Create a writer for the system topic asynchronously.
protected abstract CompletableFuture<SystemTopicClient.Writer>	newWriterAsyncInternal()

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.broker.systopic.SystemTopicClient

isSystemTopic

Field Detail

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> writers

readers

protected final List<SystemTopicClient.Reader> readers

Constructor Detail

SystemTopicClientBase

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

Method Detail

newReader

public SystemTopicClient.Reader 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

Returns:

a new reader for the system topic

Throws:

org.apache.pulsar.client.api.PulsarClientException

newReaderAsync

public CompletableFuture<SystemTopicClient.Reader> newReaderAsync()

Description copied from interface: SystemTopicClient

Create a reader for the system topic asynchronously.

Specified by:

newReaderAsync in interface SystemTopicClient

newWriter

public SystemTopicClient.Writer 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

Returns:

writer for the system topic

Throws:

org.apache.pulsar.client.api.PulsarClientException

newWriterAsync

public CompletableFuture<SystemTopicClient.Writer> newWriterAsync()

Description copied from interface: SystemTopicClient

Create a writer for the system topic asynchronously.

Specified by:

newWriterAsync in interface SystemTopicClient

newWriterAsyncInternal

protected abstract CompletableFuture<SystemTopicClient.Writer> newWriterAsyncInternal()

newReaderAsyncInternal

protected abstract CompletableFuture<SystemTopicClient.Reader> newReaderAsyncInternal()

closeAsync

public CompletableFuture<Void> closeAsync()

Description copied from interface: SystemTopicClient

Close the system topic asynchronously.

Specified by:

closeAsync in interface SystemTopicClient

Returns:

close

public void close()
           throws Exception

Description copied from interface: SystemTopicClient

Close the system topic

Specified by:

close in interface SystemTopicClient

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

Returns:

topic name

getReaders

public List<SystemTopicClient.Reader> getReaders()

Description copied from interface: SystemTopicClient

Get all readers of the system topic

Specified by:

getReaders in interface SystemTopicClient

Returns:

reader list

getWriters

public List<SystemTopicClient.Writer> getWriters()

Description copied from interface: SystemTopicClient

Get all writers of the system topic

Specified by:

getWriters in interface SystemTopicClient

Returns:

writer list