io.zeebe.logstreams.state

Class StateSnapshotController

java.lang.Object

io.zeebe.logstreams.state.StateSnapshotController

All Implemented Interfaces:

SnapshotController

public class StateSnapshotController
extends Object
implements SnapshotController

Controls how snapshot/recovery operations are performed on a StateController

Constructor Summary

Constructors

Constructor and Description
StateSnapshotController(StateController controller, StateStorage storage)

Method Summary

Modifier and Type	Method and Description
void	purgeAll(java.util.function.Predicate<StateSnapshotMetadata> matcher) Purges all snapshots which return true for the given matcher.
StateSnapshotMetadata	recover(long commitPosition, int term, java.util.function.Predicate<StateSnapshotMetadata> filter) Recovers the state from the latest snapshot and returns the corresponding metadata.
void	takeSnapshot(StateSnapshotMetadata metadata) Takes a snapshot based on the given metadata: - last successful processed event - last written event (regardless of whether or not it is committed) - term of the last written event

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.zeebe.logstreams.spi.SnapshotController

purgeAll, purgeAllExcept, takeSnapshot

Constructor Detail

StateSnapshotController

public StateSnapshotController(StateController controller,
                               StateStorage storage)

Method Detail

takeSnapshot

public void takeSnapshot(StateSnapshotMetadata metadata)
                  throws Exception

Description copied from interface: SnapshotController

Takes a snapshot based on the given metadata: - last successful processed event - last written event (regardless of whether or not it is committed) - term of the last written event

Specified by:

takeSnapshot in interface SnapshotController

Parameters:

metadata - current state metadata

Throws:

Exception

recover

public StateSnapshotMetadata recover(long commitPosition,
                                     int term,
                                     java.util.function.Predicate<StateSnapshotMetadata> filter)
                              throws Exception

Description copied from interface: SnapshotController

Recovers the state from the latest snapshot and returns the corresponding metadata. The metadata is used by the StreamProcessController to know where to seek to in the log stream. Defaults to: (-1, -1, term)

Specified by:

recover in interface SnapshotController

Parameters:

commitPosition - current log stream commit position

Returns:

recovered state metadata

Throws:

Exception

purgeAll

public void purgeAll(java.util.function.Predicate<StateSnapshotMetadata> matcher)
              throws Exception

Description copied from interface: SnapshotController

Purges all snapshots which return true for the given matcher.

Specified by:

purgeAll in interface SnapshotController

Parameters:

matcher - predicate used to match

Throws:

Exception