org.zalando.fahrschein

Interface PartitionManager

All Known Implementing Classes:

InMemoryPartitionManager, JdbcPartitionManager

public interface PartitionManager

Method Summary

Modifier and Type	Method and Description
boolean	lockPartition(String consumerName, String eventName, String partition, String lockedBy, long timeout, TimeUnit timeoutUnit)
default List<Partition>	lockPartitions(String consumerName, String eventName, List<Partition> partitions, String lockedBy, long timeout, TimeUnit timeoutUnit)
void	unlockPartition(String consumerName, String eventName, String partition, String lockedBy)

Method Detail

lockPartition

boolean lockPartition(String consumerName,
                      String eventName,
                      String partition,
                      String lockedBy,
                      long timeout,
                      TimeUnit timeoutUnit)

Parameters:

consumerName - Name of the consuming application which might be running on multiple nodes

eventName - Name of the event

partition - The partition to lock

lockedBy - Name of one node of the consuming application

timeout - Timeout after that the lock will automatically be released

timeoutUnit - Time unit for the timeout

Returns:

Whether locking succeeded, i.e. the lock was not held by anyone or the existing lock expired. The current implementations will also return true if the lock is already held by the same node, but not update the expiry time.

unlockPartition

void unlockPartition(String consumerName,
                     String eventName,
                     String partition,
                     String lockedBy)

Parameters:

consumerName - Name of the consuming application which might be running on multiple nodes

eventName - Name of the event

partition - The partition to lock

lockedBy - Name of one node of the consuming application

lockPartitions

default List<Partition> lockPartitions(String consumerName,
                                       String eventName,
                                       List<Partition> partitions,
                                       String lockedBy,
                                       long timeout,
                                       TimeUnit timeoutUnit)

Parameters:

consumerName - Name of the consuming application which might be running on multiple nodes

eventName - Name of the event

partitions - List of the partitions that should be locked

lockedBy - Name of one node of the consuming application

timeout - Timeout after that the lock will automatically be released

timeoutUnit - Time unit for the timeout

Returns:

List of the successfully locked partitions