com.feedzai.commons.sql.abstraction.engine.pool

Class DatabaseEnginePool

java.lang.Object

com.feedzai.commons.sql.abstraction.engine.pool.DatabaseEnginePool

All Implemented Interfaces:

AutoCloseable

public class DatabaseEnginePool
extends Object
implements AutoCloseable

A pool of DatabaseEngine instances.

Since:

2.8.3

Author:

Luiz Silva (luiz.silva@feedzai.com), Francisco Santos (francisco.santos@feedzai.com)

Method Summary

Modifier and Type	Method and Description
DatabaseEngine	borrow() Borrows a database engine from the pool.
DatabaseEngine	borrow(long borrowMaxWaitMillis) Borrows a database engine from the pool.
void	close() Closes the pool.
static DatabaseEnginePool	getConnectionPool(Map<String,String> properties) Creates a new DatabaseEnginePool.
static DatabaseEnginePool	getConnectionPool(Map<String,String> properties, Consumer<DatabaseEngine> engineModifier) Creates a new DatabaseEnginePool.
static DatabaseEnginePool	getConnectionPool(PdbProperties properties) Creates a new DatabaseEnginePool.
static DatabaseEnginePool	getConnectionPool(PdbProperties properties, Consumer<DatabaseEngine> engineModifier) Creates a new DatabaseEnginePool.
static DatabaseEnginePool	getConnectionPool(Properties properties) Creates a new DatabaseEnginePool.
static DatabaseEnginePool	getConnectionPool(Properties properties, Consumer<DatabaseEngine> engineModifier) Creates a new DatabaseEnginePool.
int	getMaxTotal() Gets the maximum number of connections.
int	getNumActive() Gets the number of borrowed connections.
String	getPoolJdbc() Gets the Pool JDBC string.
String	getPoolName() Gets the pool name.
boolean	isClosed() Returns whether the pool is closed or not.

Methods inherited from class java.lang.Object

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

Method Detail

borrow

public DatabaseEngine borrow()

Borrows a database engine from the pool. Call DatabaseEngine.close() to return the borrowed database engine to pool.

Returns:

a database engine.

borrow

public DatabaseEngine borrow(long borrowMaxWaitMillis)

Borrows a database engine from the pool. Call DatabaseEngine.close() to return the borrowed database engine to pool.

Parameters:

borrowMaxWaitMillis - the time to wait in milliseconds for an object to become available.

Returns:

a database engine.

close

public void close()

Closes the pool.

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

Returns whether the pool is closed or not.

Returns:

true if the pool is closed, false otherwise.

getPoolJdbc

public String getPoolJdbc()

Gets the Pool JDBC string.

Returns:

the Pool JDBC string.

getMaxTotal

public int getMaxTotal()

Gets the maximum number of connections.

Returns:

the maximum number of connections.

getNumActive

public int getNumActive()

Gets the number of borrowed connections.

Returns:

the number of borrowed connections.

getPoolName

public String getPoolName()

Gets the pool name.

Returns:

the pool name.

getConnectionPool

public static DatabaseEnginePool getConnectionPool(Map<String,String> properties,
                                                   Consumer<DatabaseEngine> engineModifier)

Creates a new DatabaseEnginePool.

Parameters:

properties - the configured database and pool properties.

engineModifier - the database engine modifier to fit the application needs.

Returns:

a new DatabaseEnginePool.

getConnectionPool

public static DatabaseEnginePool getConnectionPool(Map<String,String> properties)

Creates a new DatabaseEnginePool.

Parameters:

properties - the configured database and pool properties.

Returns:

a new DatabaseEnginePool.

getConnectionPool

public static DatabaseEnginePool getConnectionPool(Properties properties,
                                                   Consumer<DatabaseEngine> engineModifier)

Creates a new DatabaseEnginePool.

Parameters:

properties - the configured database and pool properties.

engineModifier - the database engine modifier to fit the application needs.

Returns:

a new DatabaseEnginePool.

getConnectionPool

public static DatabaseEnginePool getConnectionPool(Properties properties)

Creates a new DatabaseEnginePool.

Parameters:

properties - the configured database and pool properties.

Returns:

a new DatabaseEnginePool.

getConnectionPool

public static DatabaseEnginePool getConnectionPool(PdbProperties properties,
                                                   Consumer<DatabaseEngine> engineModifier)

Creates a new DatabaseEnginePool.

Parameters:

properties - the configured database and pool properties.

engineModifier - the database engine modifier to fit the application needs.

Returns:

a new DatabaseEnginePool.

getConnectionPool

public static DatabaseEnginePool getConnectionPool(PdbProperties properties)

Creates a new DatabaseEnginePool.

Parameters:

properties - the configured database and pool properties.

Returns:

a new DatabaseEnginePool.