Powered by GitBook

StateRestoreListener Contract

StateRestoreListener is the contract of objects that want to be notified about the store-related events, i.e. onBatchRestored, onRestoreEnd and onRestoreStart.

Note	A Kafka Streams developer uses KafkaStreams.setGlobalStateRestoreListener method to register a `StateRestoreListener` in a Kafka Streams application.

Table 1. StateRestoreListener Contract
Method	Description
`onBatchRestored`	`void onBatchRestored( TopicPartition topicPartition, String storeName, long batchEndOffset, long numRestored)` Used when: `GlobalStateManagerImpl` is requested to restoreState (when requested to register a state store) `StateRestorer` is requested to restoreBatchCompleted
`onRestoreEnd`	`void onRestoreEnd( TopicPartition topicPartition, String storeName, long totalRestored)` Used when: `GlobalStateManagerImpl` is requested to restoreState (when requested to register a state store) `StateRestorer` is requested to restoreDone
`onRestoreStart`	`void onRestoreStart( TopicPartition topicPartition, String storeName, long startingOffset, long endingOffset)` Used when: `GlobalStateManagerImpl` is requested to restoreState (when requested to register a state store) `StateRestorer` is requested to restoreStarted

Table 2. StateRestoreListeners (Direct Implementations)
StateRestoreListener	Description
AbstractNotifyingBatchingRestoreCallback
AbstractNotifyingRestoreCallback
CompositeRestoreListener
DelegatingStateRestoreListener

results matching ""

No results matching ""