org.thales.punch.kafka.impl

Class OffsetTreePartitionImpl<K,V>

java.lang.Object

org.thales.punch.kafka.impl.MonitoredPartition

org.thales.punch.kafka.impl.AbstractPartition<K,V>

org.thales.punch.kafka.impl.OffsetTreePartitionImpl<K,V>

Type Parameters:

K - record key type

V - record value type

All Implemented Interfaces:

IPartition

public class OffsetTreePartitionImpl<K,V>
extends AbstractPartition<K,V>

Our IPartition implementation. This is one of the most crucial class of the punch.

Author:

dimi, cedric

Field Summary

Fields inherited from class org.thales.punch.kafka.impl.AbstractPartition

consumer, earliestOffset, latestOffset, partitionNumber, topic

Fields inherited from class org.thales.punch.kafka.impl.MonitoredPartition

commitLatency, committedOffsetGauge, currentDelayGauge, currentTimestampGauge, earliestOffsetGauge, fetchSize, latestOffsetGauge, messagesCommitBacklogGauge, messagesFetchBacklogGauge, messagesPersistedBacklogGauge, messagesReplayableGauge, metricsContext, msgFetchRate, offsetAckRate, offsetFailRate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OffsetTreePartitionImpl(org.thales.punch.libraries.metrics.api.IMetricContext metricContext, String topic, int partitionNumber, org.apache.kafka.clients.consumer.KafkaConsumer<K,V> consumer, long offsetToRead, Long offsetWatchDogTimeout, boolean smartFailureHandling) constructor

Method Summary

Modifier and Type	Method and Description
void	ack(long offset) Optional operation.
void	commit(long offset, String metadata) Commit an explicit offset for the given partition.
void	commit(String metadata) Commit the latest acknowledged offset for the given partition.
void	fail(long offset) Optional operation, fail an offset.
protected void	onReceive(IRecordHandler<K,V> receiver, org.apache.kafka.clients.consumer.ConsumerRecord<K,V> record) Transfer the record to the receiver and keep track of current offset.
void	rewind(long offset) Optional operation, rewind the offset to a past position.
String	toString()

Methods inherited from class org.thales.punch.kafka.impl.AbstractPartition

attach, getAttachment, getPartitionNumber, getTopic, setEarliestOffset, setLatestOffset

Methods inherited from class org.thales.punch.kafka.impl.MonitoredPartition

close

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.thales.punch.kafka.api.IPartition

close

Constructor Detail

OffsetTreePartitionImpl

protected OffsetTreePartitionImpl(org.thales.punch.libraries.metrics.api.IMetricContext metricContext,
                                  String topic,
                                  int partitionNumber,
                                  org.apache.kafka.clients.consumer.KafkaConsumer<K,V> consumer,
                                  long offsetToRead,
                                  Long offsetWatchDogTimeout,
                                  boolean smartFailureHandling)

constructor

Parameters:

topic - the target topic

partitionNumber - the partition number.

consumer - the associated KafkaConsumer

offsetToRead - : the current offset at which the consumer is configured to fetch data for this partition.

offsetWatchDogTimeout - the watchdog committed offset timeout in ms.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

ack

public void ack(long offset)

Description copied from interface: IPartition

Optional operation. Acknowledge an offset

Parameters:

offset - the offset

fail

public void fail(long offset)

Description copied from interface: IPartition

Optional operation, fail an offset.

Parameters:

offset - the failed offset

commit

public void commit(String metadata)

Description copied from interface: IPartition

Commit the latest acknowledged offset for the given partition.

Parameters:

metadata - an optional metadata, can be null. If not it will be saved along with the commit

commit

public void commit(long offset,
                   String metadata)

Description copied from interface: IPartition

Commit an explicit offset for the given partition.

Parameters:

offset - the offset to commit. Remember you should always commit +1 the latest processed message (this is the kafka way).

metadata - an optional metadata, can be null. If not it will be saved along with the commit. It should relate to the NEXT data to read and process

onReceive

protected void onReceive(IRecordHandler<K,V> receiver,
                         org.apache.kafka.clients.consumer.ConsumerRecord<K,V> record)

Transfer the record to the receiver and keep track of current offset.

Specified by:

onReceive in class AbstractPartition<K,V>

Parameters:

receiver -

record -

rewind

public void rewind(long offset)

Description copied from interface: IPartition

Optional operation, rewind the offset to a past position. The next read will start from there.

Parameters:

offset - the offset value