org.apache.samza.system

Class ChangelogSSPIterator

java.lang.Object

org.apache.samza.system.BoundedSSPIterator

org.apache.samza.system.ChangelogSSPIterator

All Implemented Interfaces:

java.util.Iterator<IncomingMessageEnvelope>

public class ChangelogSSPIterator
extends BoundedSSPIterator

Iterates over messages in the provided changelog SystemStreamPartition using the provided SystemConsumer until all messages have been consumed. The iterator has a ChangelogSSPIterator.Mode that depends on its position in the changelog SSP. If trim mode is enabled, the mode switches to TRIM if the current message offset is greater than the provided restoreOffset, or if restoreOffset is null. The iterator mode is used during transactional state restore to determine which changelog SSP entries should be restored and which ones need to be reverted / trimmed from the changelog topic.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChangelogSSPIterator.Mode

Field Summary

Fields inherited from class org.apache.samza.system.BoundedSSPIterator

admin

Constructor Summary

Constructors

Constructor and Description
ChangelogSSPIterator(SystemConsumer systemConsumer, SystemStreamPartition systemStreamPartition, java.lang.String restoreOffset, SystemAdmin admin, boolean trimEnabled)
ChangelogSSPIterator(SystemConsumer systemConsumer, SystemStreamPartition systemStreamPartition, java.lang.String restoreOffset, SystemAdmin admin, boolean trimEnabled, java.lang.String endOffset)

Method Summary

Modifier and Type	Method and Description
ChangelogSSPIterator.Mode	getMode()
IncomingMessageEnvelope	next()

Methods inherited from class org.apache.samza.system.BoundedSSPIterator

hasNext

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

ChangelogSSPIterator

public ChangelogSSPIterator(SystemConsumer systemConsumer,
                            SystemStreamPartition systemStreamPartition,
                            java.lang.String restoreOffset,
                            SystemAdmin admin,
                            boolean trimEnabled)

ChangelogSSPIterator

public ChangelogSSPIterator(SystemConsumer systemConsumer,
                            SystemStreamPartition systemStreamPartition,
                            java.lang.String restoreOffset,
                            SystemAdmin admin,
                            boolean trimEnabled,
                            java.lang.String endOffset)

Method Detail

next

public IncomingMessageEnvelope next()

Specified by:

next in interface java.util.Iterator<IncomingMessageEnvelope>

Overrides:

next in class BoundedSSPIterator

getMode

public ChangelogSSPIterator.Mode getMode()