Package com.cognite.client.statestore

Class LocalStateStore

java.lang.Object

com.cognite.client.statestore.AbstractStateStore

com.cognite.client.statestore.LocalStateStore

All Implemented Interfaces:

StateStore, Closeable, AutoCloseable

public abstract class LocalStateStore
extends AbstractStateStore

A state store using a local file to persist state entries. Abstract parent class for all state store implementations.

Field Summary

Fields inherited from class com.cognite.client.statestore.AbstractStateStore

COLUMN_KEY_HIGH, COLUMN_KEY_LOW, DEFAULT_MAX_COMMIT_INTERVAL, deletedEntries, executor, LOG, MAX_MAX_COMMIT_INTERVAL, MIN_MAX_COMMIT_INTERVAL, modifiedEntries, recurringTask, stateMap

Constructor Summary

Constructors

Constructor	Description
LocalStateStore()

Method Summary

Modifier and Type	Method	Description
void	commit()	Commit the current states to the persistent store.
void	load()	Load the states from the persistent store.
static LocalStateStore	of(String fileName)	Initialize a local state store based on the provided file name.
static LocalStateStore	of(Path fileName)	Initialize a local state store based on the provided Path.
LocalStateStore	withMaxCommitInterval(Duration interval)	Sets the max commit interval.

Methods inherited from class com.cognite.client.statestore.AbstractStateStore

close, deleteState, expandHigh, expandLow, getHigh, getLow, getState, isOutsideState, keySet, setHigh, setLow, start, stop, verifyStateMap

Methods inherited from class java.lang.Object

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

Constructor Details

LocalStateStore

public LocalStateStore()

Method Details

of

public static LocalStateStore of(String fileName)
                          throws InvalidPathException

Initialize a local state store based on the provided file name.

Parameters:

fileName - the name of the state file.

Returns:

the state store.

Throws:

InvalidPathException - if the provided file name cannot be resolved to a valid file

of

public static LocalStateStore of(Path fileName)
                          throws InvalidPathException

Initialize a local state store based on the provided Path.

Parameters:

fileName - the Path of the state file.

Returns:

the state store.

Throws:

InvalidPathException - if the provided Path name cannot be resolved to a valid file.

withMaxCommitInterval

public LocalStateStore withMaxCommitInterval(Duration interval)

Sets the max commit interval. When you activate the commit background thread via AbstractStateStore.start(), the state will be committed to persistent storage at least every commit interval. The default max commit interval is 20 seconds.

Parameters:

interval - The target max upload interval.

Returns:

The LocalStateStore with the upload interval configured.

load

public void load()
          throws Exception

Load the states from the persistent store.

Specified by:

load in interface StateStore

Specified by:

load in class AbstractStateStore

Throws:

Exception

commit

public void commit()
            throws Exception

Commit the current states to the persistent store. Will overwrite/replace previously persisted states.

Specified by:

commit in interface StateStore

Specified by:

commit in class AbstractStateStore

Throws:

Exception