kafka.tier.state

Class FileTierPartitionState.MaterializationListener.ReplicationTargetOffset

java.lang.Object

kafka.tier.state.FileTierPartitionState.MaterializationListener.ReplicationTargetOffset

All Implemented Interfaces:

FileTierPartitionState.MaterializationListener

Enclosing interface:

FileTierPartitionState.MaterializationListener

public static class FileTierPartitionState.MaterializationListener.ReplicationTargetOffset
extends Object
implements FileTierPartitionState.MaterializationListener

Listener for materialization to reach or surpass a particular offset. This is the deprecated path, and only present for backwards compatibility. KSTORAGE-390 introduces a new procedure for ensuring a follower has "caught up" sufficiently in the tier topic to restore from object storage. The ReplicationTargetObjectId listener should be used going forward.

Nested Class Summary

Nested classes/interfaces inherited from interface kafka.tier.state.FileTierPartitionState.MaterializationListener

FileTierPartitionState.MaterializationListener.Initialization, FileTierPartitionState.MaterializationListener.LeaderEpoch, FileTierPartitionState.MaterializationListener.ReplicationTargetObjectId, FileTierPartitionState.MaterializationListener.ReplicationTargetOffset

Constructor Summary

Constructors

Constructor and Description
ReplicationTargetOffset(org.slf4j.Logger log, TopicIdPartition topicIdPartition, CompletableFuture<kafka.log.TierLogSegment> promise, long targetEndOffset)

Method Summary

Modifier and Type	Method and Description
void	cancel(Exception e) Complete this MaterializationListener without a result.
boolean	complete(kafka.tier.state.FileTierPartitionState.State flushedState) Try to complete this listener.
long	materializationProgress(long endOffset)
boolean	mayComplete(kafka.tier.state.FileTierPartitionState.State unflushedState, Optional<AbstractTierMetadata> unflushedMessage) Observe the unflushed FileTierPartitionState.State to determine if this listener can be completed after a flush.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplicationTargetOffset

public ReplicationTargetOffset(org.slf4j.Logger log,
                               TopicIdPartition topicIdPartition,
                               CompletableFuture<kafka.log.TierLogSegment> promise,
                               long targetEndOffset)

Method Detail

mayComplete

public boolean mayComplete(kafka.tier.state.FileTierPartitionState.State unflushedState,
                           Optional<AbstractTierMetadata> unflushedMessage)
                    throws IOException

Description copied from interface: FileTierPartitionState.MaterializationListener

Observe the unflushed FileTierPartitionState.State to determine if this listener can be completed after a flush. This is used as a hint to indicate that flushing the FileTierPartitionState.State *may* allow the listener to complete. There is no guarantee that MaterializationListener::canComplete will be called prior to MaterializationListener::complete, or at all.

Specified by:

mayComplete in interface FileTierPartitionState.MaterializationListener

Parameters:

unflushedState - The unflushed TierPartitionState.State

unflushedMessage - Optionally, an unflushed message which has mutated the provided FileTierPartitionState.State. This is sometimes useful for situations where it is expensive to query the unflushedState, but a cheaper check is possible by observing the most recently applied AbstractTierMetadata.

Returns:

True if a state flush *may* allow the listener to complete.

Throws:

IOException

complete

public boolean complete(kafka.tier.state.FileTierPartitionState.State flushedState)
                 throws IOException

Description copied from interface: FileTierPartitionState.MaterializationListener

Try to complete this listener. Completed listeners will not be called again. It's important that implementation of this method do not rely on MaterializationListener::canComplete, as there are no guarantees that MaterializationListener::canComplete will be called prior to MaterializationListener::complete.

Specified by:

complete in interface FileTierPartitionState.MaterializationListener

Parameters:

flushedState - The flushed TierPartitionState.State.

Returns:

True if this listener has completed.

Throws:

IOException

cancel

public void cancel(Exception e)

Description copied from interface: FileTierPartitionState.MaterializationListener

Complete this MaterializationListener without a result. In cases where the FileTierPartitionState.State needs to interrupt materialization for closing, or replacing the current FileTierPartitionState.State, this will be called.

Specified by:

cancel in interface FileTierPartitionState.MaterializationListener

materializationProgress

public long materializationProgress(long endOffset)

toString

public String toString()

Overrides:

toString in class Object