org.apache.pulsar.client.impl

Interface LookupService

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BinaryProtoLookupService

public interface LookupService
extends AutoCloseable

Provides lookup service to find broker which serves given topic. It helps to lookup

• topic-lookup: lookup to find broker-address which serves given topic
• Partitioned-topic-Metadata-lookup: lookup to find PartitionedMetadata for a given topic

Method Summary

Modifier and Type	Method and Description
CompletableFuture<org.apache.commons.lang3.tuple.Pair<InetSocketAddress,InetSocketAddress>>	getBroker(TopicName topicName) Calls broker lookup-api to get broker InetSocketAddress which serves namespace bundle that contains given topic.
CompletableFuture<PartitionedTopicMetadata>	getPartitionedTopicMetadata(TopicName topicName) Returns PartitionedTopicMetadata for a given topic.
CompletableFuture<Optional<SchemaInfo>>	getSchema(TopicName topicName)
String	getServiceUrl() Returns broker-service lookup api url.
CompletableFuture<List<String>>	getTopicsUnderNamespace(NamespaceName namespace, PulsarApi.CommandGetTopicsOfNamespace.Mode mode) Returns all the topics name for a given namespace.
void	updateServiceUrl(String serviceUrl) Instruct the LookupService to switch to a new service URL for all subsequent requests

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

updateServiceUrl

void updateServiceUrl(String serviceUrl)
               throws PulsarClientException

Instruct the LookupService to switch to a new service URL for all subsequent requests

Throws:

PulsarClientException

getBroker

CompletableFuture<org.apache.commons.lang3.tuple.Pair<InetSocketAddress,InetSocketAddress>> getBroker(TopicName topicName)

Calls broker lookup-api to get broker InetSocketAddress which serves namespace bundle that contains given topic.

Parameters:

topicName - topic-name

Returns:

a pair of addresses, representing the logical and physical address of the broker that serves given topic

getPartitionedTopicMetadata

CompletableFuture<PartitionedTopicMetadata> getPartitionedTopicMetadata(TopicName topicName)

Returns PartitionedTopicMetadata for a given topic.

Parameters:

topicName - topic-name

Returns:

getSchema

CompletableFuture<Optional<SchemaInfo>> getSchema(TopicName topicName)

getServiceUrl

String getServiceUrl()

Returns broker-service lookup api url.

Returns:

getTopicsUnderNamespace

CompletableFuture<List<String>> getTopicsUnderNamespace(NamespaceName namespace,
                                                        PulsarApi.CommandGetTopicsOfNamespace.Mode mode)

Returns all the topics name for a given namespace.

Parameters:

namespace - : namespace-name

Returns: