StateManager¶

StateManager is an abstraction of state managers.

Contract¶

baseDir¶

File baseDir()

Used when:

• AbstractProcessorContext is requested for the stateDir
• GlobalStateUpdateTask is requested to close
• StateManagerUtil is requested to closeStateManager

changelogFor¶

String changelogFor(
  String storeName)

Used when:

• AbstractProcessorContext is requested for the changelogFor
• GlobalStateManagerImpl is created
• ProcessorStateManager is requested to getStorePartition and isLoggingEnabled

changelogOffsets¶

Map<TopicPartition, Long> changelogOffsets()

Used when:

• AbstractTask is requested to maybeWriteCheckpoint
• GlobalStateUpdateTask is requested to initialize
• ProcessorStateManager is requested to changelogPartitions
• StandbyTask is requested to commitNeeded and changelogOffsets
• StoreChangelogReader is requested to getPositionString
• StreamTask is requested to changelogOffsets

checkpoint¶

void checkpoint()

Used when:

• AbstractTask is requested to maybeWriteCheckpoint
• GlobalStateUpdateTask is requested to flushState

close¶

void close()

Used when:

• GlobalStateUpdateTask is requested to close
• StateManagerUtil is requested to closeStateManager

flush¶

void flush()

Used when:

• AbstractTask is requested to maybeWriteCheckpoint
• GlobalStateUpdateTask is requested to flushState

getGlobalStore¶

StateStore getGlobalStore(
  String name)

Used when:

• GlobalProcessorContextImpl is requested to getStateStore
• GlobalStateManagerImpl is requested to getStore
• ProcessorContextImpl is requested to getStateStore

getStore¶

StateStore getStore(
  String name)

Used when:

• AbstractTask is requested to getStore
• ProcessorContextImpl is requested to getStateStore
• TopologyTestDriver is requested to getStateStore

registerStore¶

void registerStore(
  StateStore store,
  StateRestoreCallback stateRestoreCallback)

Used when:

• AbstractProcessorContext is requested to register

taskType¶

TaskType taskType()

updateChangelogOffsets¶

void updateChangelogOffsets(
  Map<TopicPartition, Long> writtenOffsets)

Used when:

• GlobalStateUpdateTask is requested to flushState
• StreamTask is requested to maybeWriteCheckpoint

Implementations¶

• GlobalStateManager
• ProcessorStateManager