org.zalando.fahrschein

Interface CursorManager

All Known Implementing Classes:

InMemoryCursorManager, JdbcCursorManager, ManagedCursorManager, RedisCursorManager

public interface CursorManager

Manages cursor offsets for one consumer. One consumer can handle several distinct events.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.Ordering<String>	OFFSET_ORDERING

Method Summary

Modifier and Type	Method and Description
default void	addSubscription(Subscription subscription)
default void	fromNewestAvailableOffsets(String eventName, List<Partition> partitions) Initializes offsets to start streaming from the newest available offset.
default void	fromOldestAvailableOffset(String eventName, List<Partition> partitions) Initializes offsets to start streaming at the oldest available offset (BEGIN).
Collection<Cursor>	getCursors(String eventName)
void	onError(String eventName, Cursor cursor, Throwable throwable)
void	onSuccess(String eventName, Cursor cursor)
default void	updatePartitions(String eventName, List<Partition> partitions) Updates offsets in case the currently stored offset is no longer available.

Field Detail

OFFSET_ORDERING

static final com.google.common.collect.Ordering<String> OFFSET_ORDERING

Method Detail

onSuccess

void onSuccess(String eventName,
               Cursor cursor)
        throws IOException

Throws:

IOException

onError

void onError(String eventName,
             Cursor cursor,
             Throwable throwable)
      throws IOException

Throws:

IOException

getCursors

Collection<Cursor> getCursors(String eventName)
                       throws IOException

Throws:

IOException

addSubscription

default void addSubscription(Subscription subscription)

fromNewestAvailableOffsets

default void fromNewestAvailableOffsets(String eventName,
                                        List<Partition> partitions)
                                 throws IOException

Initializes offsets to start streaming from the newest available offset.

Throws:

IOException

fromOldestAvailableOffset

default void fromOldestAvailableOffset(String eventName,
                                       List<Partition> partitions)
                                throws IOException

Initializes offsets to start streaming at the oldest available offset (BEGIN).

Throws:

IOException

updatePartitions

default void updatePartitions(String eventName,
                              List<Partition> partitions)
                       throws IOException

Updates offsets in case the currently stored offset is no longer available. Streaming will start at the oldest available offset (BEGIN) to minimize the amount of events skipped.

Throws:

IOException