Package org.nuxeo.lib.stream.log.chronicle

Class ChronicleLogTailer<M extends Externalizable>

java.lang.Object

org.nuxeo.lib.stream.log.chronicle.ChronicleLogTailer<M>

All Implemented Interfaces:

AutoCloseable, LogTailer<M>

public class ChronicleLogTailer<M extends Externalizable>
extends Object
implements LogTailer<M>

Since:

9.3

Field Summary

Fields

Modifier and Type	Field	Description
protected String	basePath
protected boolean	closed
protected Codec<M>	codec
protected net.openhft.chronicle.queue.ExcerptTailer	cqTailer
protected LogPartitionGroup	id
protected boolean	initialized
protected ChronicleLogOffsetTracker	offsetTracker
protected LogPartition	partition
protected static long	POLL_INTERVAL_MS
protected ChronicleRetentionDuration	retention
protected static Set<LogPartitionGroup>	tailersId

Constructor Summary

Constructors

Constructor	Description
ChronicleLogTailer(Codec<M> codec, String basePath, net.openhft.chronicle.queue.ExcerptTailer cqTailer, LogPartition partition, Name group, ChronicleRetentionDuration retention)

Method Summary

Modifier and Type	Method	Description
Collection<LogPartition>	assignments()	Returns the list of Log name, partitions tuples currently assigned to this tailer.
protected void	checkInitialized()
void	close()
boolean	closed()	Returns true if the tailer has been closed.
void	commit()	Commit current positions for all partitions (last message offset returned by read).
LogOffset	commit(LogPartition partition)	Commit current position for the partition.
Codec<M>	getCodec()	Returns the codec used to read the records.
protected ChronicleLogOffsetTracker	getOffsetTracker()
Name	group()	Returns the consumer group.
LogOffset	offsetForTimestamp(LogPartition partition, long timestamp)	Look up the offset for the given partition by timestamp.
protected LogRecord<M>	read()
LogRecord<M>	read(Duration timeout)	Read a message from assigned partitions within the timeout.
protected void	registerTailer()
void	reset()	Reset all committed positions for this group, next read will be done from beginning.
void	reset(LogPartition partition)	Reset the committed position for this group on this partition, next read for this partition will be done from the beginning.
void	seek(LogOffset offset)	Set the current position for a single partition.
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 positions to the beginning of all partitions.
String	toString()
protected void	unregisterTailer()

Methods inherited from class java.lang.Object

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

Field Detail

POLL_INTERVAL_MS

protected static final long POLL_INTERVAL_MS

See Also:

Constant Field Values

tailersId

protected static final Set<LogPartitionGroup> tailersId

basePath

protected final String basePath

cqTailer

protected final net.openhft.chronicle.queue.ExcerptTailer cqTailer

offsetTracker

protected ChronicleLogOffsetTracker offsetTracker

retention

protected final ChronicleRetentionDuration retention

id

protected final LogPartitionGroup id

partition

protected final LogPartition partition

codec

protected final Codec<M extends Externalizable> codec

closed

protected volatile boolean closed

initialized

protected boolean initialized

Constructor Detail

ChronicleLogTailer

public ChronicleLogTailer(Codec<M> codec,
                          String basePath,
                          net.openhft.chronicle.queue.ExcerptTailer cqTailer,
                          LogPartition partition,
                          Name group,
                          ChronicleRetentionDuration retention)

Method Detail

getOffsetTracker

protected ChronicleLogOffsetTracker getOffsetTracker()

registerTailer

protected void registerTailer()

checkInitialized

protected void checkInitialized()

unregisterTailer

protected void unregisterTailer()

read

public LogRecord<M> read(Duration timeout)
                  throws InterruptedException

Description copied from interface: LogTailer

Read a message from assigned partitions within the timeout.

Specified by:

read in interface LogTailer<M extends Externalizable>

Returns:

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

Throws:

InterruptedException

read

protected LogRecord<M> read()

commit

public LogOffset commit(LogPartition partition)

Description copied from interface: LogTailer

Commit current position for the partition.

Specified by:

commit in interface LogTailer<M extends Externalizable>

Returns:

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

commit

public void commit()

Description copied from interface: LogTailer

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

Specified by:

commit in interface LogTailer<M extends Externalizable>

toEnd

public void toEnd()

Description copied from interface: LogTailer

Set the current positions to the end of all partitions.

Specified by:

toEnd in interface LogTailer<M extends Externalizable>

toStart

public void toStart()

Description copied from interface: LogTailer

Set the current positions to the beginning of all partitions.

Specified by:

toStart in interface LogTailer<M extends Externalizable>

toLastCommitted

public void toLastCommitted()

Description copied from interface: LogTailer

Set the current positions to previously committed positions.

Specified by:

toLastCommitted in interface LogTailer<M extends Externalizable>

seek

public void seek(LogOffset offset)

Description copied from interface: LogTailer

Set the current position for a single partition. Do not change other partitions positions.

Specified by:

seek in interface LogTailer<M extends Externalizable>

reset

public void reset()

Description copied from interface: LogTailer

Reset all committed positions for this group, next read will be done from beginning.

Specified by:

reset in interface LogTailer<M extends Externalizable>

reset

public void reset(LogPartition partition)

Description copied from interface: LogTailer

Reset the committed position for this group on this partition, next read for this partition will be done from the beginning.

Specified by:

reset in interface LogTailer<M extends Externalizable>

offsetForTimestamp

public LogOffset offsetForTimestamp(LogPartition partition,
                                    long timestamp)

Description copied from interface: LogTailer

Look up the offset for the given partition by timestamp. The position is the earliest offset whose timestamp is greater than or equal to the given timestamp.

The timestamp used depends on the implementation, for Kafka this is the LogAppendTime. Returns null if no record offset is found with an appropriate timestamp.

Specified by:

offsetForTimestamp in interface LogTailer<M extends Externalizable>

assignments

public Collection<LogPartition> assignments()

Description copied from interface: LogTailer

Returns the list of Log name, partitions tuples currently assigned to this tailer. Assignments can change only if the tailer has been created using LogManager.subscribe(org.nuxeo.lib.stream.log.Name, java.util.Collection<org.nuxeo.lib.stream.log.Name>, org.nuxeo.lib.stream.log.RebalanceListener, org.nuxeo.lib.stream.codec.Codec<M>).

Specified by:

assignments in interface LogTailer<M extends Externalizable>

group

public Name group()

Description copied from interface: LogTailer

Returns the consumer group.

Specified by:

group in interface LogTailer<M extends Externalizable>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface LogTailer<M extends Externalizable>

closed

public boolean closed()

Description copied from interface: LogTailer

Returns true if the tailer has been closed.

Specified by:

closed in interface LogTailer<M extends Externalizable>

getCodec

public Codec<M> getCodec()

Description copied from interface: LogTailer

Returns the codec used to read the records. A null codec is the default legacy encoding.

Specified by:

getCodec in interface LogTailer<M extends Externalizable>

toString

public String toString()

Overrides:

toString in class Object