org.apache.samza.checkpoint

Interface CheckpointListener

public interface CheckpointListener

SystemConsumers that want to be notified about checkpoints for their SSPs and potentially modify them may implement this interface. Note: For broadcast streams, different Tasks may checkpoint the same ssp with different offsets. It is the SystemConsumer's responsibility to select the appropriate (e.g., lowest) offset for its own use.

Method Summary

Modifier and Type	Method and Description
default void	afterCheckpoint(java.util.Map<SystemStreamPartition,java.lang.String> offsets) Called after writing the checkpoint for each Task in the Container processing SSPs on this system.
default java.util.Map<SystemStreamPartition,java.lang.String>	beforeCheckpoint(java.util.Map<SystemStreamPartition,java.lang.String> offsets) Called before writing the checkpoint for each Task in the Container processing SSPs on this system.
default void	onCheckpoint(java.util.Map<SystemStreamPartition,java.lang.String> offsets) Deprecated.

Method Detail

beforeCheckpoint

default java.util.Map<SystemStreamPartition,java.lang.String> beforeCheckpoint(java.util.Map<SystemStreamPartition,java.lang.String> offsets)

Called before writing the checkpoint for each Task in the Container processing SSPs on this system. Implementations may modify the Task offsets to be checkpointed, or return the provided offsets as-is.

Parameters:

offsets - offsets about to be checkpointed.

Returns:

potentially modified offsets to be checkpointed.

afterCheckpoint

default void afterCheckpoint(java.util.Map<SystemStreamPartition,java.lang.String> offsets)

Called after writing the checkpoint for each Task in the Container processing SSPs on this system.

Parameters:

offsets - offsets that were checkpointed.

onCheckpoint

@Deprecated
default void onCheckpoint(java.util.Map<SystemStreamPartition,java.lang.String> offsets)

Deprecated.

Called after writing the checkpoint for each Task in the Container processing SSPs on this system. This method is deprecated. Implement afterCheckpoint(Map) instead.

Parameters:

offsets - offsets that were checkpointed.