org.apache.flink.connector.pulsar.source

Class PulsarSubscriber

java.lang.Object

org.apache.flink.connector.pulsar.source.PulsarSubscriber

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractPulsarSubscriber

@PublicEvolving
public abstract class PulsarSubscriber
extends Object
implements Serializable

Pulsar consumer allows a few different ways to consume from the topics, including:

1. Subscribe from a collection of topics.
2. Subscribe to a topic pattern using Java Regex.

The PulsarSubscriber provides a unified interface for the Pulsar source to support all these three types of subscribing mode.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PulsarSubscriber.PartitionChange A container class to hold the newly added partitions and removed partitions.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.flink.api.connector.source.SplitEnumeratorContext<PulsarPartitionSplit>	context

Constructor Summary

Constructors

Constructor and Description
PulsarSubscriber()

Method Summary

Modifier and Type	Method and Description
abstract PulsarSubscriber.PartitionChange	getPartitionChanges(org.apache.pulsar.client.admin.PulsarAdmin pulsarAdmin, Set<AbstractPartition> currentAssignment) Get the partitions changes compared to the current partition assignment.
static PulsarSubscriber	getTopicListSubscriber(SplitDivisionStrategy splitDivisionStrategy, String... topics)
static PulsarSubscriber	getTopicPatternSubscriber(String namespace, SplitDivisionStrategy splitDivisionStrategy, Set<String> topicPatterns)
void	setContext(org.apache.flink.api.connector.source.SplitEnumeratorContext<PulsarPartitionSplit> context)

Methods inherited from class java.lang.Object

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

Field Detail

context

protected org.apache.flink.api.connector.source.SplitEnumeratorContext<PulsarPartitionSplit> context

Constructor Detail

PulsarSubscriber

public PulsarSubscriber()

Method Detail

setContext

public void setContext(org.apache.flink.api.connector.source.SplitEnumeratorContext<PulsarPartitionSplit> context)

getPartitionChanges

public abstract PulsarSubscriber.PartitionChange getPartitionChanges(org.apache.pulsar.client.admin.PulsarAdmin pulsarAdmin,
                                                                     Set<AbstractPartition> currentAssignment)
                                                              throws org.apache.pulsar.client.admin.PulsarAdminException,
                                                                     InterruptedException,
                                                                     IOException

Get the partitions changes compared to the current partition assignment.

Although Pulsar partitions can only expand and will not shrink, the partitions may still disappear when the topic is deleted.

Parameters:

pulsarAdmin - The pulsar admin used to retrieve partition information.

currentAssignment - the partitions that are currently assigned to the source readers.

Returns:

The partition changes compared with the currently assigned partitions.

Throws:

org.apache.pulsar.client.admin.PulsarAdminException

InterruptedException

IOException

getTopicListSubscriber

public static PulsarSubscriber getTopicListSubscriber(SplitDivisionStrategy splitDivisionStrategy,
                                                      String... topics)

getTopicPatternSubscriber

public static PulsarSubscriber getTopicPatternSubscriber(String namespace,
                                                         SplitDivisionStrategy splitDivisionStrategy,
                                                         Set<String> topicPatterns)