org.nuxeo.ecm.platform.importer.mqueues.mqueues

Interface MQTailer<M extends Externalizable>

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ChronicleCompoundMQTailer, ChronicleMQTailer, KafkaMQTailer

public interface MQTailer<M extends Externalizable>
extends AutoCloseable

Sequential reader for a partition or multiple partitions. A tailer is not thread safe and should not be shared by multiple threads.

Method Summary

Modifier and Type	Method and Description
Collection<MQPartition>	assignments() Returns the list of MQueue name/partition tuples currently assigned to this tailer.
boolean	closed() Returns true if the tailer has been closed.
void	commit() Commit current positions for all partitions (last message offset returned by read).
MQOffset	commit(MQPartition partition) Commit current position for the partition.
String	group() Returns the consumer group.
MQRecord<M>	read(Duration timeout) Read a message from assigned partitions within the timeout.
void	toEnd() Set the current positions to the end of all partitions.
void	toLastCommitted() Set the current positions to previously committed positions.
void	toStart() Set the current position to the fist message of all partitions.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

group

String group()

Returns the consumer group.

assignments

Collection<MQPartition> assignments()

Returns the list of MQueue name/partition tuples currently assigned to this tailer. Assignments can change only if the tailer has been created using MQManager.subscribe(java.lang.String, java.util.Collection<java.lang.String>, org.nuxeo.ecm.platform.importer.mqueues.mqueues.MQRebalanceListener).

read

MQRecord<M> read(Duration timeout)
          throws InterruptedException

Read a message from assigned partitions within the timeout.

Returns:

null if there is no message in the queue after the timeout.

Throws:

MQRebalanceException - if a partition rebalancing happen during the read, this is possible only when using MQManager.subscribe(java.lang.String, java.util.Collection<java.lang.String>, org.nuxeo.ecm.platform.importer.mqueues.mqueues.MQRebalanceListener).

InterruptedException

commit

void commit()

Commit current positions for all partitions (last message offset returned by read).

commit

MQOffset commit(MQPartition partition)

Commit current position for the partition.

Returns:

the committed offset, can return null if there was no previous read done on this partition.

toEnd

void toEnd()

Set the current positions to the end of all partitions.

toStart

void toStart()

Set the current position to the fist message of all partitions.

toLastCommitted

void toLastCommitted()

Set the current positions to previously committed positions.

closed

boolean closed()

Returns true if the tailer has been closed.