Package io.camunda.zeebe.broker.system.partitions.impl

Class StateControllerImpl

java.lang.Object

io.camunda.zeebe.broker.system.partitions.impl.StateControllerImpl

All Implemented Interfaces:

StateController, PersistedSnapshotListener, AutoCloseable

public class StateControllerImpl
extends Object
implements StateController, PersistedSnapshotListener

Controls how snapshot/recovery operations are performed

Constructor Summary

Constructors

Constructor	Description
StateControllerImpl(int partitionId, ZeebeDbFactory zeebeDbFactory, ConstructableSnapshotStore constructableSnapshotStore, ReceivableSnapshotStore receivableSnapshotStore, Path runtimeDirectory, SnapshotReplication replication, AtomixRecordEntrySupplier entrySupplier, ToLongFunction<ZeebeDb> exporterPositionSupplier)

Method Summary

Modifier and Type	Method	Description
void	close()
void	consumeReplicatedSnapshots()	Registers to consumes replicated snapshots.
int	getValidSnapshotsCount()	Returns the current number of valid snapshots.
void	onNewSnapshot(PersistedSnapshot newPersistedSnapshot)
ZeebeDb	openDb()	Opens the database from the latest snapshot.
void	recover()	Recovers the state from the latest snapshot.
Optional<TransientSnapshot>	takeTransientSnapshot(long lowerBoundSnapshotPosition)	Takes a snapshot based on the given position.

Methods inherited from class java.lang.Object

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

Constructor Detail

StateControllerImpl

public StateControllerImpl(int partitionId,
                           ZeebeDbFactory zeebeDbFactory,
                           ConstructableSnapshotStore constructableSnapshotStore,
                           ReceivableSnapshotStore receivableSnapshotStore,
                           Path runtimeDirectory,
                           SnapshotReplication replication,
                           AtomixRecordEntrySupplier entrySupplier,
                           ToLongFunction<ZeebeDb> exporterPositionSupplier)

Method Detail

takeTransientSnapshot

public Optional<TransientSnapshot> takeTransientSnapshot(long lowerBoundSnapshotPosition)

Description copied from interface: StateController

Takes a snapshot based on the given position. The position is a last processed lower bound event position.

Specified by:

takeTransientSnapshot in interface StateController

Parameters:

lowerBoundSnapshotPosition - the lower bound snapshot position

Returns:

a pending snapshot, or nothing if the operation fails

consumeReplicatedSnapshots

public void consumeReplicatedSnapshots()

Description copied from interface: StateController

Registers to consumes replicated snapshots.

Specified by:

consumeReplicatedSnapshots in interface StateController

recover

public void recover()
             throws Exception

Description copied from interface: StateController

Recovers the state from the latest snapshot.

Specified by:

recover in interface StateController

Throws:

Exception

openDb

public ZeebeDb openDb()

Description copied from interface: StateController

Opens the database from the latest snapshot.

Specified by:

openDb in interface StateController

Returns:

an opened database

getValidSnapshotsCount

public int getValidSnapshotsCount()

Description copied from interface: StateController

Returns the current number of valid snapshots.

Specified by:

getValidSnapshotsCount in interface StateController

Returns:

valid snapshots count

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

onNewSnapshot

public void onNewSnapshot(PersistedSnapshot newPersistedSnapshot)

Specified by:

onNewSnapshot in interface PersistedSnapshotListener