Package com.cognite.client.statestore

Class RawStateStore

java.lang.Object

com.cognite.client.statestore.AbstractStateStore

com.cognite.client.statestore.RawStateStore

All Implemented Interfaces:

StateStore, Closeable, AutoCloseable

public abstract class RawStateStore
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
RawStateStore()

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 RawStateStore	of(CogniteClient client, String dbName, String tableName)	Initialize a state store backed by a CDF Raw table.
RawStateStore	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 Detail

RawStateStore

public RawStateStore()

Method Detail

of

public static RawStateStore of(CogniteClient client,
                               String dbName,
                               String tableName)

Initialize a state store backed by a CDF Raw table.

Parameters:

client - Cognite client to use for the accessing the Raw table

dbName - The name of the Raw data base hosting the backing table

tableName - The name of the Raw table

Returns:

the state store.

withMaxCommitInterval

public RawStateStore 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 RawStateStore 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