Class AbstractItemStore

java.lang.Object

org.tasktide.itemstore.AbstractItemStore

All Implemented Interfaces:

ItemStore

Direct Known Subclasses:

RocksDbStore, SqliteStore

public abstract class AbstractItemStore
extends Object
implements ItemStore

Abstract ItemStore to implement getting ItemStore attributes, handling the locking/releasing of masterDB for updates, and caching/clearing the master prototype to another file.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Path	dbDirectory
protected final ItemStoreLockStrategy	lockStrategy
protected final Path	masterDB
protected final Path	protoDB
protected final String	storeName

Constructor Summary

Constructors

Constructor	Description
AbstractItemStore(String storeName, String dbDirectory)	Preferred constructor moving forward
AbstractItemStore(String storeName, String dbDirectory, String masterDB, String protoDB)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	cacheMaster()	Cache master DB to prototype
boolean	clearPrototype()	Remove prototypeDB
boolean	closeConn(DbTarget target)	Standardizes how concrete ItemStore close connections, using the evaluation logic from ItemStoreConnectionStrategy, and targeted AbstractItemStore methods.
protected abstract <T> T	getConnection(DbTarget target, Class<T> type)	Get connection
String	getDbDirectory()	Return directory of where DB is stored
String	getFilePath()	Return file path prototype DB
String	getMasterFilePath()	Return full file path for master
String	getStoreName()	Return store name
boolean	openConn(DbTarget target)	Standardizes how concrete ItemStore open connections, using the evaluation logic from ItemStoreConnectionStrategy, and targeted AbstractItemStore methods.
void	syncToMaster()	Sync all records from cache to master
void	syncToMaster(List<Item> items)	Syncs Item list to master
void	syncToMaster(Item item)	Sync an Item to the master.
protected <R> R	withLockedConnection(String label, DbTarget target, ThrowableItemStoreOperation operation)	Synchronizes lock and connection lifecycles under one operation.
protected <R> R	withLockedConnectionUnchecked(String label, DbTarget target, ItemStoreOperation operation)	Synchronizes lock and connection lifecycles under one operation.

Methods inherited from class Object

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

Methods inherited from interface ItemStore

closeMaster, closePrototoype, delete, execute, execute, execute, getAll, getById, getItemsByState, getPayloadById, isClosed, isOpen, openMaster, openPrototoype, saveItem, saveItems, update

Field Details

storeName

protected final String storeName

dbDirectory

protected final Path dbDirectory

masterDB

protected final Path masterDB

protoDB

protected final Path protoDB

lockStrategy

protected final ItemStoreLockStrategy lockStrategy

Constructor Details

AbstractItemStore

@Deprecated
public AbstractItemStore(String storeName,
 String dbDirectory,
 String masterDB,
 String protoDB)

Deprecated.

Construct with all attributes. Throws IllegalArgument RunTime exception if not writable.

Parameters:

storeName -

dbDirectory -

masterDB -

protoDB -

AbstractItemStore

public AbstractItemStore(String storeName,
 String dbDirectory)

Preferred constructor moving forward

Parameters:

storeName -

dbDirectory -

Method Details

getConnection

protected abstract <T> T getConnection(DbTarget target,
 Class<T> type)

Get connection

Type Parameters:

T -

Parameters:

target -

type - SqliteStore | RocksDbStore

Returns:

T

withLockedConnection

protected <R> R withLockedConnection(String label,
 DbTarget target,
 ThrowableItemStoreOperation operation)
                              throws ItemStoreCheckedException

Synchronizes lock and connection lifecycles under one operation. Allowing callers to solely own the required operation, without having to know about these distinct strategies

Type Parameters:

R -

Parameters:

label -

target -

operation -

Returns:

R Operation Result

Throws:

ItemStoreCheckedException

withLockedConnectionUnchecked

protected <R> R withLockedConnectionUnchecked(String label,
 DbTarget target,
 ItemStoreOperation operation)
                                       throws ItemStoreUncheckedException

Synchronizes lock and connection lifecycles under one operation. Allowing callers to solely own the required operation, without having to know about these distinct strategies

Type Parameters:

R -

Parameters:

label -

target -

operation -

Returns:

R Operation Result

Throws:

ItemStoreUncheckedException

openConn

public boolean openConn(DbTarget target)

Standardizes how concrete ItemStore open connections, using the evaluation logic from ItemStoreConnectionStrategy, and targeted AbstractItemStore methods. Allowing concrete classes to only own opening appropriate DbTarget

Specified by:

openConn in interface ItemStore

Parameters:

target -

Returns:

boolean

closeConn

public boolean closeConn(DbTarget target)

Standardizes how concrete ItemStore close connections, using the evaluation logic from ItemStoreConnectionStrategy, and targeted AbstractItemStore methods. Allowing concrete classes to only own opening appropriate DbTarget

Specified by:

closeConn in interface ItemStore

Parameters:

target -

Returns:

boolean

syncToMaster

public void syncToMaster(Item item)
                  throws ItemStoreCheckedException

Sync an Item to the master. Assumes with lock handle by the interface method, to prevent request duplication

Specified by:

syncToMaster in interface ItemStore

Parameters:

item -

Throws:

ItemStoreCheckedException

syncToMaster

public void syncToMaster(List<Item> items)
                  throws ItemStoreCheckedException

Syncs Item list to master

Specified by:

syncToMaster in interface ItemStore

Parameters:

items -

Throws:

ItemStoreCheckedException

syncToMaster

public void syncToMaster()
                  throws ItemStoreCheckedException

Sync all records from cache to master

Specified by:

syncToMaster in interface ItemStore

Throws:

ItemStoreCheckedException

cacheMaster

public boolean cacheMaster()

Cache master DB to prototype

Specified by:

cacheMaster in interface ItemStore

Returns:

boolean

clearPrototype

public boolean clearPrototype()

Remove prototypeDB

Specified by:

clearPrototype in interface ItemStore

Returns:

boolean

getStoreName

public String getStoreName()

Return store name

Specified by:

getStoreName in interface ItemStore

Returns:

String

getMasterFilePath

public String getMasterFilePath()

Return full file path for master

Specified by:

getMasterFilePath in interface ItemStore

Returns:

String

getFilePath

public String getFilePath()

Return file path prototype DB

Specified by:

getFilePath in interface ItemStore

Returns:

String

getDbDirectory

public String getDbDirectory()

Return directory of where DB is stored

Specified by:

getDbDirectory in interface ItemStore

Returns:

String