Package io.github.mrtesz.teszcore.db.manager.mariadb

Class AbstractMariaDBManager

java.lang.Object

io.github.mrtesz.teszcore.db.manager.AbstractDBManager

io.github.mrtesz.teszcore.db.manager.mariadb.AbstractMariaDBManager

All Implemented Interfaces:

DBManager, Copyable<DBManager>

Direct Known Subclasses:

AsyncMariaDBManager, MariaDBManager

public abstract class AbstractMariaDBManager
extends AbstractDBManager

Parent class of all MariaDBManagers

Field Summary

Fields

Modifier and Type	Field	Description
protected com.zaxxer.hikari.HikariDataSource	dataSource
protected final boolean	infoWhenCredentialsAreNull
protected final @NotNull String	name
protected final String	password
protected final String	projectName
protected final String	url
protected final String	user

Constructor Summary

Constructors

Constructor	Description
AbstractMariaDBManager()

Method Summary

Modifier and Type	Method	Description
AsyncDBManager	async(int timeoutSecs)	Creates an AsyncDBManager with same information as the current database manager
void	checkConnection()	Connects the manager to the database again, when it is not connected
void	connect()	Connect the database manager with the database
protected @NotNull com.zaxxer.hikari.HikariConfig	createHikariConfig()
void	disconnect()	Close the database manager
Connection	getConnection()	calls DBManager.checkConnection() and returns a database connection
SyncDBManager	sync()	Creates a SyncDBManager with same information as the current database manager (When called from an AsyncDBManager the param timeoutSeconds will be forgotten)

Methods inherited from class io.github.mrtesz.teszcore.db.manager.AbstractDBManager

close, isClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mrtesz.teszcore.copyable.Copyable

copy

Methods inherited from interface io.github.mrtesz.teszcore.api.db.manager.DBManager

async, buildSqlWithParams, getName

Field Details

infoWhenCredentialsAreNull

protected final boolean infoWhenCredentialsAreNull

name

@NotNull
protected final @NotNull String name

url

protected final String url

user

protected final String user

password

protected final String password

dataSource

protected com.zaxxer.hikari.HikariDataSource dataSource

projectName

protected final String projectName

Constructor Details

AbstractMariaDBManager

public AbstractMariaDBManager()

Method Details

createHikariConfig

@NotNull
protected @NotNull com.zaxxer.hikari.HikariConfig createHikariConfig()

connect

public void connect()
             throws IllegalStateException,
NullPointerException

Connect the database manager with the database

Throws:

IllegalStateException - if the DBManager is closed

NullPointerException - if any of the credentials are null/empty

checkConnection

public void checkConnection()
                     throws IllegalStateException

Description copied from interface: DBManager

Connects the manager to the database again, when it is not connected

Throws:

IllegalStateException - when the DBManager is closed

disconnect

public void disconnect()

Description copied from interface: DBManager

Close the database manager

getConnection

public Connection getConnection()
                         throws IllegalStateException

Description copied from interface: DBManager

calls DBManager.checkConnection() and returns a database connection

Returns:

a database connection

Throws:

IllegalStateException - when the DBManager is closed

async

public AsyncDBManager async(int timeoutSecs)

Description copied from interface: DBManager

Creates an AsyncDBManager with same information as the current database manager

Parameters:

timeoutSecs - The CompletableFuture.completeOnTimeout(T, long, java.util.concurrent.TimeUnit) time in seconds

Returns:

an asynchronous copy of the current database manager

sync

public SyncDBManager sync()

Description copied from interface: DBManager

Creates a SyncDBManager with same information as the current database manager (When called from an AsyncDBManager the param timeoutSeconds will be forgotten)

Returns:

a synchronous copy of the current database manager