H2 Database Engine 2.3.232 · org.h2.jdbcx.JdbcConnectionPool

Modifier and Type	Field and Description
private AtomicInteger	activeConnections
private final ConnectionPoolDataSource	dataSource
private static final int	DEFAULT_MAX_CONNECTIONS
private static final int	DEFAULT_TIMEOUT
private AtomicBoolean	isDisposed
private PrintWriter	logWriter
private volatile int	maxConnections
private final Queue<PooledConnection>	recycledConnections
private volatile int	timeout

Access	Constructor and Description
private	JdbcConnectionPool(ConnectionPoolDataSource dataSource)

Method Summary

Modifier and Type	Method and Description
private void	closeConnection(PooledConnection pc)
public void	connectionClosed(ConnectionEvent an event object describing the source of the event event) Implements javax.sql.ConnectionEventListener.connectionClosed. INTERNAL
public void	connectionErrorOccurred(ConnectionEvent an event object describing the source of the event and containing the `SQLException` that the driver is about to throw event) Implements javax.sql.ConnectionEventListener.connectionErrorOccurred. INTERNAL
public static JdbcConnectionPool	Returns: the connection pool create(ConnectionPoolDataSource the data source to create connections dataSource) Constructs a new connection pool.
public static JdbcConnectionPool	Returns: the connection pool create(String the database URL of the H2 connection url, String the user name user, String the password password) Constructs a new connection pool for H2 databases.
public void	dispose() Closes all unused pooled connections.
public int	Returns: the number of active connections. getActiveConnections() Returns the number of active (open) connections of this pool.
public Connection	Returns: a new Connection object. getConnection() Implements javax.sql.DataSource.getConnection. Retrieves a connection from the connection pool.
public Connection	getConnection(String the database user on whose behalf the connection is being made user, String the user's password password) Implements javax.sql.DataSource.getConnection. INTERNAL
private Connection	getConnectionNow()
public int	Returns: the timeout in seconds getLoginTimeout() Implements javax.sql.DataSource.getLoginTimeout. Gets the maximum time in seconds to wait for a free connection.
public PrintWriter	getLogWriter() Implements javax.sql.DataSource.getLogWriter. INTERNAL
public int	Returns: the max the maximum number of connections getMaxConnections() Gets the maximum number of connections to use.
public java.util.logging.Logger	getParentLogger() Implements javax.sql.CommonDataSource.getParentLogger. [Not supported]
public boolean	Returns: whether or not the interface is assignable from this class isWrapperFor(Class<?> the class iface) Implements java.sql.Wrapper.isWrapperFor. Checks if unwrap can return an object of this class.
private void	recycleConnection(PooledConnection the pooled connection pc) This method usually puts the connection back into the pool.
public void	setLoginTimeout(int the timeout, 0 meaning the default seconds) Implements javax.sql.DataSource.setLoginTimeout. Sets the maximum time in seconds to wait for a free connection.
public void	setLogWriter(PrintWriter the new log writer; to disable logging, set to null logWriter) Implements javax.sql.DataSource.setLogWriter. INTERNAL
public void	setMaxConnections(int the maximum number of connections max) Sets the maximum number of connections to use from now on.
public <T> T	Returns: this unwrap(Class<T> the class iface) Implements java.sql.Wrapper.unwrap. Return an object of this class if possible.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

activeConnections	back to summary
private AtomicInteger activeConnections

dataSource	back to summary
private final ConnectionPoolDataSource dataSource

DEFAULT_MAX_CONNECTIONS	back to summary
private static final int DEFAULT_MAX_CONNECTIONS

DEFAULT_TIMEOUT	back to summary
private static final int DEFAULT_TIMEOUT

isDisposed	back to summary
private AtomicBoolean isDisposed

logWriter	back to summary
private PrintWriter logWriter

maxConnections	back to summary
private volatile int maxConnections

recycledConnections	back to summary
private final Queue<PooledConnection> recycledConnections

timeout	back to summary
private volatile int timeout

JdbcConnectionPool	back to summary
private JdbcConnectionPool(ConnectionPoolDataSource dataSource)

Method Detail

closeConnection	back to summary
private void closeConnection(PooledConnection pc)

connectionClosed	back to summary
public void connectionClosed(ConnectionEvent event) Implements javax.sql.ConnectionEventListener.connectionClosed. INTERNAL Parameters event:ConnectionEvent Doc from javax.sql.ConnectionEventListener.connectionClosed. an event object describing the source of the event Annotations @Override

connectionClosed

back to summary

public void connectionClosed(ConnectionEvent event)

Implements javax.sql.ConnectionEventListener.connectionClosed.

INTERNAL

Parameters

event:ConnectionEvent

Doc from javax.sql.ConnectionEventListener.connectionClosed.

an event object describing the source of the event

Annotations

@Override

connectionErrorOccurred back to summary

connectionErrorOccurred	back to summary
public void connectionErrorOccurred(ConnectionEvent event) Implements javax.sql.ConnectionEventListener.connectionErrorOccurred. INTERNAL Parameters event:ConnectionEvent Doc from javax.sql.ConnectionEventListener.connectionErrorOccurred. an event object describing the source of the event and containing the `SQLException` that the driver is about to throw Annotations @Override

public void connectionErrorOccurred(ConnectionEvent event)

Implements javax.sql.ConnectionEventListener.connectionErrorOccurred.

INTERNAL

Parameters

event:ConnectionEvent

Doc from javax.sql.ConnectionEventListener.connectionErrorOccurred.

an event object describing the source of the event and containing the SQLException that the driver is about to throw

Annotations

@Override

create	back to summary
public static JdbcConnectionPool create(ConnectionPoolDataSource dataSource) Constructs a new connection pool. Parameters dataSource:ConnectionPoolDataSource the data source to create connections Returns:JdbcConnectionPool the connection pool

create

back to summary

public static JdbcConnectionPool create(ConnectionPoolDataSource dataSource)

Constructs a new connection pool.

Parameters

dataSource:ConnectionPoolDataSource: the data source to create connections

Returns:JdbcConnectionPool

the connection pool

create	back to summary
public static JdbcConnectionPool create(String url, String user, String password) Constructs a new connection pool for H2 databases. Parameters url:String the database URL of the H2 connection user:String the user name password:String the password Returns:JdbcConnectionPool the connection pool

create

back to summary

public static JdbcConnectionPool create(String url, String user, String password)

Constructs a new connection pool for H2 databases.

Parameters

url:String: the database URL of the H2 connection
user:String: the user name
password:String: the password

Returns:JdbcConnectionPool

the connection pool

dispose	back to summary
public void dispose() Closes all unused pooled connections. Exceptions while closing are written to the log stream (if set).

getActiveConnections back to summary

getActiveConnections	back to summary
public int getActiveConnections() Returns the number of active (open) connections of this pool. This is the number of `Connection` objects that have been issued by getConnection() for which `Connection.close()` has not yet been called. Returns:int the number of active connections.

public int getActiveConnections()

Returns the number of active (open) connections of this pool. This is the number of Connection objects that have been issued by getConnection() for which Connection.close() has not yet been called.

Returns:int: the number of active connections.

getConnection back to summary

getConnection	back to summary
public Connection getConnection() throws SQLException Implements javax.sql.DataSource.getConnection. Retrieves a connection from the connection pool. If `maxConnections` connections are already in use, the method waits until a connection becomes available or `timeout` seconds elapsed. When the application is finished using the connection, it must close it in order to return it to the pool. If no connection becomes available within the given timeout, an exception with SQL state 08001 and vendor code 8001 is thrown. Returns:Connection a new Connection object. Annotations @Override Exceptions SQLException: when a new connection could not be established, or a timeout occurred

public Connection getConnection() throws SQLException

Implements javax.sql.DataSource.getConnection.

Retrieves a connection from the connection pool. If maxConnections connections are already in use, the method waits until a connection becomes available or timeout seconds elapsed. When the application is finished using the connection, it must close it in order to return it to the pool. If no connection becomes available within the given timeout, an exception with SQL state 08001 and vendor code 8001 is thrown.

Returns:Connection

a new Connection object.

Annotations

@Override

Exceptions

SQLException:: when a new connection could not be established, or a timeout occurred

getConnection	back to summary
public Connection getConnection(String user, String password) Implements javax.sql.DataSource.getConnection. INTERNAL Parameters user:String Doc from javax.sql.DataSource.getConnection. the database user on whose behalf the connection is being made password:String Doc from javax.sql.DataSource.getConnection. the user's password Returns:Connection Doc from javax.sql.DataSource.getConnection. a connection to the data source Annotations @Override

getConnection

back to summary

public Connection getConnection(String user, String password)

Implements javax.sql.DataSource.getConnection.

INTERNAL

Parameters

user:String

Doc from javax.sql.DataSource.getConnection.

the database user on whose behalf the connection is being made

password:String

Doc from javax.sql.DataSource.getConnection.

the user's password

Returns:Connection

Doc from javax.sql.DataSource.getConnection.

a connection to the data source

Annotations

@Override

getConnectionNow	back to summary
private Connection getConnectionNow() throws SQLException

getLoginTimeout	back to summary
public int getLoginTimeout() Implements javax.sql.DataSource.getLoginTimeout. Gets the maximum time in seconds to wait for a free connection. Returns:int the timeout in seconds Annotations @Override

getLoginTimeout

back to summary

public int getLoginTimeout()

Implements javax.sql.DataSource.getLoginTimeout.

Gets the maximum time in seconds to wait for a free connection.

Returns:int

the timeout in seconds

Annotations

@Override

getLogWriter	back to summary
public PrintWriter getLogWriter() Implements javax.sql.DataSource.getLogWriter. INTERNAL Returns:PrintWriter Doc from javax.sql.CommonDataSource.getLogWriter. the log writer for this data source or null if logging is disabled Annotations @Override

getLogWriter

back to summary

public PrintWriter getLogWriter()

Implements javax.sql.DataSource.getLogWriter.

INTERNAL

Returns:PrintWriter

Doc from javax.sql.CommonDataSource.getLogWriter.

the log writer for this data source or null if logging is disabled

Annotations

@Override

getMaxConnections	back to summary
public int getMaxConnections() Gets the maximum number of connections to use. Returns:int the max the maximum number of connections

getMaxConnections

back to summary

public int getMaxConnections()

Gets the maximum number of connections to use.

Returns:int: the max the maximum number of connections

getParentLogger	back to summary
public java.util.logging.Logger getParentLogger() Implements javax.sql.CommonDataSource.getParentLogger. [Not supported] Returns:java.util.logging.Logger Doc from javax.sql.CommonDataSource.getParentLogger. the parent Logger for this data source Annotations @Override

getParentLogger

back to summary

public java.util.logging.Logger getParentLogger()

Implements javax.sql.CommonDataSource.getParentLogger.

[Not supported]

Returns:java.util.logging.Logger

Doc from javax.sql.CommonDataSource.getParentLogger.

the parent Logger for this data source

Annotations

@Override

isWrapperFor	back to summary
public boolean isWrapperFor(Class<?> iface) throws SQLException Implements java.sql.Wrapper.isWrapperFor. Checks if unwrap can return an object of this class. Parameters iface:Class<?> the class Returns:boolean whether or not the interface is assignable from this class Annotations @Override Exceptions SQLException: Doc from java.sql.Wrapper.isWrapperFor. if an error occurs while determining whether this is a wrapper for an object with the given interface.

isWrapperFor

back to summary

public boolean isWrapperFor(Class<?> iface) throws SQLException

Implements java.sql.Wrapper.isWrapperFor.

Checks if unwrap can return an object of this class.

Parameters

iface:Class<?>: the class

Returns:boolean

whether or not the interface is assignable from this class

Annotations

@Override

Exceptions

SQLException:

Doc from java.sql.Wrapper.isWrapperFor.

if an error occurs while determining whether this is a wrapper for an object with the given interface.

recycleConnection	back to summary
private void recycleConnection(PooledConnection pc) This method usually puts the connection back into the pool. There are some exceptions: if the pool is disposed, the connection is disposed as well. If the pool is full, the connection is closed. Parameters pc:PooledConnection the pooled connection

recycleConnection

back to summary

private void recycleConnection(PooledConnection pc)

This method usually puts the connection back into the pool. There are some exceptions: if the pool is disposed, the connection is disposed as well. If the pool is full, the connection is closed.

Parameters

pc:PooledConnection: the pooled connection

setLoginTimeout	back to summary
public void setLoginTimeout(int seconds) Implements javax.sql.DataSource.setLoginTimeout. Sets the maximum time in seconds to wait for a free connection. The default timeout is 30 seconds. Calling this method with the value 0 will set the timeout to the default value. Parameters seconds:int the timeout, 0 meaning the default Annotations @Override

setLoginTimeout

back to summary

public void setLoginTimeout(int seconds)

Implements javax.sql.DataSource.setLoginTimeout.

Sets the maximum time in seconds to wait for a free connection. The default timeout is 30 seconds. Calling this method with the value 0 will set the timeout to the default value.

Parameters

seconds:int: the timeout, 0 meaning the default

Annotations

@Override

setLogWriter	back to summary
public void setLogWriter(PrintWriter logWriter) Implements javax.sql.DataSource.setLogWriter. INTERNAL Parameters logWriter:PrintWriter Doc from javax.sql.CommonDataSource.setLogWriter. the new log writer; to disable logging, set to null Annotations @Override

setLogWriter

back to summary

public void setLogWriter(PrintWriter logWriter)

Implements javax.sql.DataSource.setLogWriter.

INTERNAL

Parameters

logWriter:PrintWriter

Doc from javax.sql.CommonDataSource.setLogWriter.

the new log writer; to disable logging, set to null

Annotations

@Override

setMaxConnections	back to summary
public void setMaxConnections(int max) Sets the maximum number of connections to use from now on. The default value is 10 connections. Parameters max:int the maximum number of connections

setMaxConnections

back to summary

public void setMaxConnections(int max)

Sets the maximum number of connections to use from now on. The default value is 10 connections.

Parameters

max:int: the maximum number of connections

unwrap	back to summary
public <T> T unwrap(Class<T> iface) throws SQLException Implements java.sql.Wrapper.unwrap. Return an object of this class if possible. Parameters <T> Doc from java.sql.Wrapper.unwrap. the type of the class modeled by this Class object iface:Class<T> the class Returns:T this Annotations @Override @SuppressWarnings:unchecked Exceptions SQLException: Doc from java.sql.Wrapper.unwrap. If no object found that implements the interface

unwrap

back to summary

public <T> T unwrap(Class<T> iface) throws SQLException

Implements java.sql.Wrapper.unwrap.

Return an object of this class if possible.

Parameters