org.apache.flink.streaming.connectors.kafka.internals

Interface OffsetHandler

All Known Implementing Classes:

ZookeeperOffsetHandler

public interface OffsetHandler

The offset handler is responsible for locating the initial partition offsets where the source should start reading, as well as committing offsets from completed checkpoints.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the offset handler, releasing all resources.
void	commit(Map<org.apache.kafka.common.TopicPartition,Long> offsetsToCommit) Commits the given offset for the partitions.
void	seekFetcherToInitialOffsets(List<org.apache.kafka.common.TopicPartition> partitions, Fetcher fetcher) Positions the given fetcher to the initial read offsets where the stream consumption will start from.

Method Detail

commit

void commit(Map<org.apache.kafka.common.TopicPartition,Long> offsetsToCommit)
     throws Exception

Commits the given offset for the partitions. May commit the offsets to the Kafka broker, or to ZooKeeper, based on its configured behavior.

Parameters:

offsetsToCommit - The offset to commit, per partition.

Throws:

Exception

seekFetcherToInitialOffsets

void seekFetcherToInitialOffsets(List<org.apache.kafka.common.TopicPartition> partitions,
                                 Fetcher fetcher)
                          throws Exception

Positions the given fetcher to the initial read offsets where the stream consumption will start from.

Parameters:

partitions - The partitions for which to seeks the fetcher to the beginning.

fetcher - The fetcher that will pull data from Kafka and must be positioned.

Throws:

Exception

close

void close()
    throws IOException

Closes the offset handler, releasing all resources.

Throws:

IOException - Thrown, if the closing fails.