kafka.tier.state

Interface FileTierPartitionState.MaterializationListener

All Known Implementing Classes:

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

Enclosing class:

FileTierPartitionState

public static interface FileTierPartitionState.MaterializationListener

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileTierPartitionState.MaterializationListener.Initialization Listener for materialization to reach or surpass a minimum leader epoch.
static class	FileTierPartitionState.MaterializationListener.LeaderEpoch Listener for materialization to reach or surpass a particular leader epoch.
static class	FileTierPartitionState.MaterializationListener.ReplicationTargetObjectId Listener for materialization to witness a particular objectId at an FileTierPartitionState restore epoch equal to or greater than the provided target restore epoch.
static class	FileTierPartitionState.MaterializationListener.ReplicationTargetOffset Listener for materialization to reach or surpass a particular offset.

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.
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.

Method Detail

mayComplete

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

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.

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

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

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.

Parameters:

flushedState - The flushed TierPartitionState.State.

Returns:

True if this listener has completed.

Throws:

IOException

cancel

void cancel(Exception e)

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.