com.neocoretechs.rocksack.session

Class SessionManager

java.lang.Object

com.neocoretechs.rocksack.session.SessionManager

public final class SessionManager
extends java.lang.Object

SessionManager class is a singleton that accepts connections and returns a Session subclass instance. A table of one to one sessions and tables is maintained. Primary means by which DatabaseManager receives various TransactionSession, OptimisticTransactionSession, etc. and from there obtains the BufferedMap, TransactionalMap, etc. maps by which most of the work gets done. The session typically provides the overarching set of methods from which the various maps encapsulate the functionality of the specific type of map.

Author:

Jonathan Groff (c) NeoCoreTechs 2003, 2017, 2021, 2024, 2025

Method Summary

Modifier and Type	Method and Description
static Session	Connect(java.lang.String dbname, org.rocksdb.Options options) Open the database and extract the ColumnFamily that represents the default column family for main class
static Session	Connect(java.lang.String dbname, org.rocksdb.Options options, java.lang.String derivedClassName) Open the database and extract the ColumnFamily that represents the derivedClassName
static Session	ConnectNoRecovery(java.lang.String dbname, org.rocksdb.Options options) Start the DB with no logging for debugging purposes or to run read only without logging for some reason
static TransactionSession	ConnectOptimisticTransaction(Alias alias, java.lang.String dbname, org.rocksdb.Options options) Connect to an optimistic transaction database column family for a default ColumnFamily class being stored in that database.
static TransactionSession	ConnectOptimisticTransaction(Alias alias, java.lang.String dbname, org.rocksdb.Options options, java.lang.String derivedClassName) Connect to an optimistic transaction database column family for a derived class being stored in that database.
static TransactionSession	ConnectOptimisticTransaction(java.lang.String dbname, org.rocksdb.Options options) Connect to an optimistic transaction database column family for a default ColumnFamily class being stored in that database.
static TransactionSession	ConnectOptimisticTransaction(java.lang.String dbname, org.rocksdb.Options options, java.lang.String derivedClassName) Connect to an optimistic transaction database column family for a derived class being stored in that database.
static TransactionSession	ConnectTransaction(Alias alias, java.lang.String dbname, org.rocksdb.Options options) Connect to a transaction database column family for a default ColumnFamily class being stored in that database.
static TransactionSession	ConnectTransaction(Alias alias, java.lang.String dbname, org.rocksdb.Options options, long timeout) Connect to a transaction database column family for a default ColumnFamily class being stored in that database with associated transaction timeout.
static TransactionSession	ConnectTransaction(Alias alias, java.lang.String dbname, org.rocksdb.Options options, java.lang.String derivedClassName) Connect to a transaction database column family for a derived class being stored in that database.
static TransactionSession	ConnectTransaction(Alias alias, java.lang.String dbname, org.rocksdb.Options options, java.lang.String derivedClassName, long timeout) Connect to a transaction database column family for a derived class being stored in that database with associated transaction timeout.
static TransactionSession	ConnectTransaction(java.lang.String dbname, org.rocksdb.Options options) Connect to a transaction database column family for a default ColumnFamily class being stored in that database.
static TransactionSession	ConnectTransaction(java.lang.String dbname, org.rocksdb.Options options, long timeout) Connect to a transaction database column family for a default ColumnFamily class being stored in that database with associated transaction timeout.
static TransactionSession	ConnectTransaction(java.lang.String dbname, org.rocksdb.Options options, java.lang.String derivedClassName) Connect to a transaction database column family for a derived class being stored in that database.
static TransactionSession	ConnectTransaction(java.lang.String dbname, org.rocksdb.Options options, java.lang.String derivedClassName, long timeout) Connect to a transaction database column family for a derived class being stored in that database with associated transaction timeout.
static SessionManager	getInstance()
static java.util.concurrent.ConcurrentHashMap<java.lang.String,Session>	getSessionTable()
static boolean	isDBOffline(java.lang.String dbname)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SessionManager getInstance()

Connect

public static Session Connect(java.lang.String dbname,
                              org.rocksdb.Options options,
                              java.lang.String derivedClassName)
                       throws java.io.IOException,
                              java.lang.IllegalAccessException

Open the database and extract the ColumnFamily that represents the derivedClassName

Parameters:

dbname -

options - RocksDb.listColumnFamilies options

derivedClassName -

Returns:

The Session that contains the methods to be invoked with ColumnFamilyHandle once we extract it from DB params

Throws:

java.io.IOException

java.lang.IllegalAccessException

Connect

public static Session Connect(java.lang.String dbname,
                              org.rocksdb.Options options)
                       throws java.io.IOException,
                              java.lang.IllegalAccessException

Open the database and extract the ColumnFamily that represents the default column family for main class

Parameters:

dbname -

options - RocksDb.listColumnFamilies options

Returns:

The Session that contains the methods to be invoked with ColumnFamilyHandle once we extract it from DB params

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectTransaction

public static TransactionSession ConnectTransaction(java.lang.String dbname,
                                                    org.rocksdb.Options options)
                                             throws java.io.IOException,
                                                    java.lang.IllegalAccessException

Connect to a transaction database column family for a default ColumnFamily class being stored in that database.

Parameters:

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectTransaction

public static TransactionSession ConnectTransaction(java.lang.String dbname,
                                                    org.rocksdb.Options options,
                                                    long timeout)
                                             throws java.io.IOException,
                                                    java.lang.IllegalAccessException

Connect to a transaction database column family for a default ColumnFamily class being stored in that database with associated transaction timeout.

Parameters:

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

timeout - the transaction timeout

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectTransaction

public static TransactionSession ConnectTransaction(Alias alias,
                                                    java.lang.String dbname,
                                                    org.rocksdb.Options options)
                                             throws java.io.IOException,
                                                    java.lang.IllegalAccessException

Connect to a transaction database column family for a default ColumnFamily class being stored in that database.

Parameters:

alias - the database alias

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectTransaction

public static TransactionSession ConnectTransaction(Alias alias,
                                                    java.lang.String dbname,
                                                    org.rocksdb.Options options,
                                                    long timeout)
                                             throws java.io.IOException,
                                                    java.lang.IllegalAccessException

Connect to a transaction database column family for a default ColumnFamily class being stored in that database with associated transaction timeout.

Parameters:

alias - the database alias

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

timeout - the transaction timeout

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectTransaction

public static TransactionSession ConnectTransaction(Alias alias,
                                                    java.lang.String dbname,
                                                    org.rocksdb.Options options,
                                                    java.lang.String derivedClassName)
                                             throws java.io.IOException,
                                                    java.lang.IllegalAccessException

Connect to a transaction database column family for a derived class being stored in that database.

Parameters:

alias - the database alias

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

derivedClassName - the derived class that will contain the ColumnFamily of the same name

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectTransaction

public static TransactionSession ConnectTransaction(Alias alias,
                                                    java.lang.String dbname,
                                                    org.rocksdb.Options options,
                                                    java.lang.String derivedClassName,
                                                    long timeout)
                                             throws java.io.IOException,
                                                    java.lang.IllegalAccessException

Connect to a transaction database column family for a derived class being stored in that database with associated transaction timeout.

Parameters:

alias - the database alias

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

derivedClassName - the derived class that will contain the ColumnFamily of the same name

timeout - transaction timeout

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectTransaction

public static TransactionSession ConnectTransaction(java.lang.String dbname,
                                                    org.rocksdb.Options options,
                                                    java.lang.String derivedClassName)
                                             throws java.io.IOException,
                                                    java.lang.IllegalAccessException

Connect to a transaction database column family for a derived class being stored in that database.

Parameters:

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

derivedClassName - the derived class that will contain the ColumnFamily of the same name

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectTransaction

public static TransactionSession ConnectTransaction(java.lang.String dbname,
                                                    org.rocksdb.Options options,
                                                    java.lang.String derivedClassName,
                                                    long timeout)
                                             throws java.io.IOException,
                                                    java.lang.IllegalAccessException

Connect to a transaction database column family for a derived class being stored in that database with associated transaction timeout.

Parameters:

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

derivedClassName - the derived class that will contain the ColumnFamily of the same name

timeout - the transaction timeout

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectOptimisticTransaction

public static TransactionSession ConnectOptimisticTransaction(java.lang.String dbname,
                                                              org.rocksdb.Options options)
                                                       throws java.io.IOException,
                                                              java.lang.IllegalAccessException

Connect to an optimistic transaction database column family for a default ColumnFamily class being stored in that database.

Parameters:

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectOptimisticTransaction

public static TransactionSession ConnectOptimisticTransaction(Alias alias,
                                                              java.lang.String dbname,
                                                              org.rocksdb.Options options)
                                                       throws java.io.IOException,
                                                              java.lang.IllegalAccessException

Connect to an optimistic transaction database column family for a default ColumnFamily class being stored in that database.

Parameters:

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectOptimisticTransaction

public static TransactionSession ConnectOptimisticTransaction(Alias alias,
                                                              java.lang.String dbname,
                                                              org.rocksdb.Options options,
                                                              java.lang.String derivedClassName)
                                                       throws java.io.IOException,
                                                              java.lang.IllegalAccessException

Connect to an optimistic transaction database column family for a derived class being stored in that database.

Parameters:

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

derivedClassName - the derived class that will contain the ColumnFamily of the same name

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectOptimisticTransaction

public static TransactionSession ConnectOptimisticTransaction(java.lang.String dbname,
                                                              org.rocksdb.Options options,
                                                              java.lang.String derivedClassName)
                                                       throws java.io.IOException,
                                                              java.lang.IllegalAccessException

Connect to an optimistic transaction database column family for a derived class being stored in that database.

Parameters:

dbname - the path to the database

options - the RocksDb options RocksDb.listColumnFamilies options

derivedClassName - the derived class that will contain the ColumnFamily of the same name

Returns:

the TransactionSession that contains methods we call using ColumnFamilyHandle

Throws:

java.io.IOException

java.lang.IllegalAccessException

ConnectNoRecovery

public static Session ConnectNoRecovery(java.lang.String dbname,
                                        org.rocksdb.Options options)
                                 throws java.io.IOException,
                                        java.lang.IllegalAccessException

Start the DB with no logging for debugging purposes or to run read only without logging for some reason

Parameters:

dbname - the path to the database (path+dbname)

options - db options RocksDb.listColumnFamilies options

Returns:

The Session

Throws:

java.io.IOException

java.lang.IllegalAccessException

isDBOffline

public static boolean isDBOffline(java.lang.String dbname)

getSessionTable

public static java.util.concurrent.ConcurrentHashMap<java.lang.String,Session> getSessionTable()