Module com.aoapps.sql.pool

Package com.aoapps.sql.pool

Class AOConnectionPool

java.lang.Object

java.lang.Thread

com.aoapps.hodgepodge.io.AOPool<Connection,SQLException,SQLException>

com.aoapps.sql.pool.AOConnectionPool

All Implemented Interfaces:

Runnable

public class AOConnectionPool
extends AOPool<Connection,SQLException,SQLException>

Reusable connection pooling with dynamic flaming tiger feature.

Author:

AO Industries, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	IDLE_READ_ONLY	The read-only state of connections while idle in the pool.

Fields inherited from class com.aoapps.hodgepodge.io.AOPool

DEFAULT_CONNECT_TIMEOUT, DEFAULT_DELAY_TIME, DEFAULT_MAX_CONNECTION_AGE, DEFAULT_MAX_IDLE_TIME, DEFAULT_SOCKET_SO_LINGER, logger, UNLIMITED_MAX_CONNECTION_AGE

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
AOConnectionPool(String driver, String url, String user, String password, int numConnections, long maxConnectionAge, Logger logger)	Creates a new pool.

Method Summary

Modifier and Type	Method	Description
protected void	close(Connection conn)
static void	defaultLogConnection(Connection conn, Logger logger)	Default implementation of logConnection(java.sql.Connection).
static void	defaultResetConnection(Connection conn)	Default implementation of resetConnection(java.sql.Connection).
Connection	getConnection()	Gets a read/write connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION, warning when a connection is already used by this thread.
Connection	getConnection(boolean readOnly)	Gets a connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION, warning when a connection is already used by this thread.
Connection	getConnection(int maxConnections)	Gets a read/write connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION.
Connection	getConnection(int isolationLevel, boolean readOnly)	Gets a connection to the database, warning when a connection is already used by this thread.
Connection	getConnection(int isolationLevel, boolean readOnly, int maxConnections)	Gets a connection to the database.
protected Connection	getConnectionObject()
protected boolean	isClosed(Connection conn)
protected void	logConnection(Connection conn)
protected SQLException	newException(String message, Throwable cause)
protected SQLException	newInterruptedException(String message, Throwable cause)
protected void	printConnectionStats(Appendable out, boolean isXhtml)
protected void	resetConnection(Connection conn)
String	toString()

Methods inherited from class com.aoapps.hodgepodge.io.AOPool

close, getConcurrency, getConnectionCount, getConnects, getLogger, getMaxConcurrency, getMaxConnectionAge, getPoolSize, getTotalTime, getTransactionCount, printStatisticsHtml, printStatisticsHTML, printStatisticsHTML, release, releaseConnection, run

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, suspend, yield

Methods inherited from class java.lang.Object

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

Field Details

IDLE_READ_ONLY

public static final boolean IDLE_READ_ONLY

The read-only state of connections while idle in the pool.

See Also:

• Constant Field Values

Constructor Details

AOConnectionPool

public AOConnectionPool(String driver,
 String url,
 String user,
 String password,
 int numConnections,
 long maxConnectionAge,
 Logger logger)

Creates a new pool.

Method Details

close

protected void close(Connection conn)
              throws SQLException

If the connection not already closed, and is not auto-commit, the connection will be rolled back and set back to auto-commit before closing.

Specified by:

close in class AOPool<Connection,SQLException,SQLException>

Throws:

SQLException

getConnection

public Connection getConnection()
                         throws SQLException

Gets a read/write connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION, warning when a connection is already used by this thread.

The connection will be in auto-commit mode, as configured by resetConnection(java.sql.Connection)

If all the connections in the pool are busy and the pool is at capacity, waits until a connection becomes available.

The connection will be a ConnectionTracker, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The connection tracking is used to close/free all objects before returning the connection to the pool.

Overrides:

getConnection in class AOPool<Connection,SQLException,SQLException>

Returns:

The read/write connection to the database

Throws:

SQLException - when an error occurs, or when a thread attempts to allocate more than half the pool

See Also:

• getConnection(int, boolean, int)
• Connection.close()

getConnection

public Connection getConnection(int maxConnections)
                         throws SQLException

Gets a read/write connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION.

The connection will be in auto-commit mode, as configured by resetConnection(java.sql.Connection)

If all the connections in the pool are busy and the pool is at capacity, waits until a connection becomes available.

The connection will be a ConnectionTracker, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The connection tracking is used to close/free all objects before returning the connection to the pool.

Overrides:

getConnection in class AOPool<Connection,SQLException,SQLException>

Parameters:

maxConnections - The maximum number of connections expected to be used by the current thread. This should normally be one to avoid potential deadlock.

The connection will continue to be considered used by the allocating thread until released (via Connection.close(), even if the connection is shared by another thread.

Returns:

The read/write connection to the database

Throws:

SQLException - when an error occurs, or when a thread attempts to allocate more than half the pool

See Also:

• getConnection(int, boolean, int)
• Connection.close()

getConnection

public Connection getConnection(boolean readOnly)
                         throws SQLException

Gets a connection to the database with a transaction level of Connections.DEFAULT_TRANSACTION_ISOLATION, warning when a connection is already used by this thread.

The connection will be in auto-commit mode, as configured by resetConnection(java.sql.Connection)

If all the connections in the pool are busy and the pool is at capacity, waits until a connection becomes available.

The connection will be a ConnectionTracker, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The connection tracking is used to close/free all objects before returning the connection to the pool.

Parameters:

readOnly - The read-only flag

Returns:

The connection to the database

Throws:

SQLException - when an error occurs, or when a thread attempts to allocate more than half the pool

See Also:

• getConnection(int, boolean, int)
• Connection.close()

getConnection

public Connection getConnection(int isolationLevel,
 boolean readOnly)
                         throws SQLException

Gets a connection to the database, warning when a connection is already used by this thread.

The connection will be in auto-commit mode, as configured by resetConnection(java.sql.Connection)

If all the connections in the pool are busy and the pool is at capacity, waits until a connection becomes available.

The connection will be a ConnectionTracker, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The connection tracking is used to close/free all objects before returning the connection to the pool.

Parameters:

isolationLevel - The transaction isolation level

readOnly - The read-only flag

Returns:

The connection to the database

Throws:

SQLException - when an error occurs, or when a thread attempts to allocate more than half the pool

See Also:

• getConnection(int, boolean, int)
• Connection.close()

getConnection

public Connection getConnection(int isolationLevel,
 boolean readOnly,
 int maxConnections)
                         throws SQLException

Gets a connection to the database.

The connection will be in auto-commit mode, as configured by resetConnection(java.sql.Connection)

If all the connections in the pool are busy and the pool is at capacity, waits until a connection becomes available.

The connection will be a ConnectionTracker, which may be unwrapped via Wrapper.unwrap(java.lang.Class). The connection tracking is used to close/free all objects before returning the connection to the pool.

Parameters:

isolationLevel - The transaction isolation level

readOnly - The read-only flag

maxConnections - The maximum number of connections expected to be used by the current thread. This should normally be one to avoid potential deadlock.

The connection will continue to be considered used by the allocating thread until released (via Connection.close(), even if the connection is shared by another thread.

Returns:

The connection to the database

Throws:

SQLException - when an error occurs, or when a thread attempts to allocate more than half the pool

See Also:

• Connection.close()

getConnectionObject

protected Connection getConnectionObject()
                                  throws SQLException

Specified by:

getConnectionObject in class AOPool<Connection,SQLException,SQLException>

Throws:

SQLException

isClosed

protected boolean isClosed(Connection conn)
                    throws SQLException

Specified by:

isClosed in class AOPool<Connection,SQLException,SQLException>

Throws:

SQLException

printConnectionStats

protected void printConnectionStats(Appendable out,
 boolean isXhtml)
                             throws IOException

Overrides:

printConnectionStats in class AOPool<Connection,SQLException,SQLException>

Throws:

IOException

defaultLogConnection

public static void defaultLogConnection(Connection conn,
 Logger logger)
                                 throws SQLException

Default implementation of logConnection(java.sql.Connection).

Throws:

SQLException

See Also:

• logConnection(java.sql.Connection)

logConnection

protected void logConnection(Connection conn)
                      throws SQLException

Overrides:

logConnection in class AOPool<Connection,SQLException,SQLException>

Throws:

SQLException

See Also:

• defaultLogConnection(java.sql.Connection, java.util.logging.Logger)

defaultResetConnection

public static void defaultResetConnection(Connection conn)
                                   throws SQLException

Default implementation of resetConnection(java.sql.Connection).

1. Warnings are cleared
2. Any transaction in-progress is rolled-back
3. Auto-commit is enabled
4. Read-only state is set to IDLE_READ_ONLY
5. Transaction isolation level set to Connections.DEFAULT_TRANSACTION_ISOLATION

Throws:

SQLException

See Also:

• resetConnection(java.sql.Connection)

resetConnection

protected void resetConnection(Connection conn)
                        throws SQLException

Specified by:

resetConnection in class AOPool<Connection,SQLException,SQLException>

Throws:

SQLException

See Also:

• defaultResetConnection(java.sql.Connection)

newException

protected SQLException newException(String message,
 Throwable cause)

Specified by:

newException in class AOPool<Connection,SQLException,SQLException>

newInterruptedException

protected SQLException newInterruptedException(String message,
 Throwable cause)

Specified by:

newInterruptedException in class AOPool<Connection,SQLException,SQLException>

toString

public String toString()

Overrides:

toString in class Thread