org.axonframework.kafka.eventhandling.consumer

Class KafkaTrackingToken

java.lang.Object

org.axonframework.kafka.eventhandling.consumer.KafkaTrackingToken

All Implemented Interfaces:

Serializable, TrackingToken

public class KafkaTrackingToken
extends Object
implements TrackingToken, Serializable

Use to track messages consumed & committed from Kafka to Axon.

Since:

3.0

Author:

Nakul Mishra

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
KafkaTrackingToken	advancedTo(int partition, long offset)
boolean	covers(TrackingToken other) Indicates whether this token covers the other token completely.
static KafkaTrackingToken	emptyToken()
boolean	equals(Object o)
int	hashCode()
static boolean	isEmpty(KafkaTrackingToken token)
static boolean	isNotEmpty(KafkaTrackingToken token)
TrackingToken	lowerBound(TrackingToken other) Returns a token that represents the lower bound between this and the other token.
static KafkaTrackingToken	newInstance(Map<Integer,Long> partitionPositions)
static org.apache.kafka.common.TopicPartition	partition(String topic, int partitionNumber)
Map<Integer,Long>	partitionPositions()
Collection<org.apache.kafka.common.TopicPartition>	partitions(String topic)
String	toString()
TrackingToken	upperBound(TrackingToken other) Returns the token that represents the furthest possible position in a stream that either this token or the given other represents.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newInstance

public static KafkaTrackingToken newInstance(Map<Integer,Long> partitionPositions)

emptyToken

public static KafkaTrackingToken emptyToken()

partitionPositions

public Map<Integer,Long> partitionPositions()

partitions

public Collection<org.apache.kafka.common.TopicPartition> partitions(String topic)

partition

public static org.apache.kafka.common.TopicPartition partition(String topic,
                                                               int partitionNumber)

advancedTo

public KafkaTrackingToken advancedTo(int partition,
                                     long offset)

lowerBound

public TrackingToken lowerBound(TrackingToken other)

Description copied from interface: TrackingToken

Returns a token that represents the lower bound between this and the other token. Effectively, the returned token will cause messages not received by both this and the other token to be redelivered.

Specified by:

lowerBound in interface TrackingToken

Parameters:

other - The token to compare to this one

Returns:

The token representing the lower bound of the two

upperBound

public TrackingToken upperBound(TrackingToken other)

Description copied from interface: TrackingToken

Returns the token that represents the furthest possible position in a stream that either this token or the given other represents. Effectively, this means this token will only deliver messages that neither this, nor the other have been received.

Specified by:

upperBound in interface TrackingToken

Parameters:

other - The token to compare this token to

Returns:

a token that represents the furthest position of this or the other stream

covers

public boolean covers(TrackingToken other)

Description copied from interface: TrackingToken

Indicates whether this token covers the other token completely. That means that this token represents a position in a stream that has received all of the messages that a stream represented by the other token has received.

Specified by:

covers in interface TrackingToken

Parameters:

other - The token to compare to this one

Returns:

true if this token covers the other, otherwise false

isEmpty

public static boolean isEmpty(KafkaTrackingToken token)

isNotEmpty

public static boolean isNotEmpty(KafkaTrackingToken token)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object