com.j256.ormlite.jdbc

Class JdbcPooledConnectionSource

java.lang.Object

com.j256.ormlite.support.BaseConnectionSource

com.j256.ormlite.jdbc.BaseJdbcConnectionSource

com.j256.ormlite.jdbc.JdbcConnectionSource

com.j256.ormlite.jdbc.JdbcPooledConnectionSource

All Implemented Interfaces:

com.j256.ormlite.support.ConnectionSource, AutoCloseable

public class JdbcPooledConnectionSource
extends JdbcConnectionSource
implements com.j256.ormlite.support.ConnectionSource

Implementation of the ConnectionSource interface that supports basic pooled connections. New connections are created on demand only if there are no dormant connections otherwise released connections will be reused. This class is reentrant and can handle requests from multiple threads.

NOTE: If you are using the Spring type wiring in Java, initialize() should be called after all of the set methods. In Spring XML, init-method="initialize" should be used.

NOTE: This class spawns a thread to test the pooled connections that are in the free-list as a keep-alive mechanism. It will test any dormant connections every so often to see if they are still valid. If this is not the behavior that you want then call setCheckConnectionsEveryMillis(long) with 0 to disable the thread. You can also call setTestBeforeGet(boolean) and set it to true to test the connection before it is handed back to you.

Author:

graywatson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JdbcPooledConnectionSource.ConnectionMetaData Class to hold the connection and its meta data.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<com.j256.ormlite.support.DatabaseConnection,JdbcPooledConnectionSource.ConnectionMetaData>	connectionMap

Fields inherited from class com.j256.ormlite.jdbc.BaseJdbcConnectionSource

connection, databaseType, initialized, url

Constructor Summary

Constructors

Constructor and Description
JdbcPooledConnectionSource()
JdbcPooledConnectionSource(String url)
JdbcPooledConnectionSource(String url, com.j256.ormlite.db.DatabaseType databaseType)
JdbcPooledConnectionSource(String url, String username, String password)
JdbcPooledConnectionSource(String url, String username, String password, com.j256.ormlite.db.DatabaseType databaseType)

Method Summary

Modifier and Type	Method and Description
void	clearSpecialConnection(com.j256.ormlite.support.DatabaseConnection connection)
void	close()
protected void	closeConnection(com.j256.ormlite.support.DatabaseConnection connection) This should be inside of synchronized (lock) stanza.
protected void	closeConnectionQuietly(JdbcPooledConnectionSource.ConnectionMetaData connMetaData) Must be called inside of synchronized(lock)
int	getCloseCount() Return the approximate number of connections closed over the life of the pool.
int	getCurrentConnectionsFree() Return the number of currently freed connections in the free list.
int	getCurrentConnectionsManaged() Return the number of current connections that we are tracking.
int	getMaxConnectionsEverUsed() Return the approximate maximum number of connections in use at one time.
int	getOpenCount() Return the approximate number of connections opened over the life of the pool.
com.j256.ormlite.support.DatabaseConnection	getReadOnlyConnection(String tableName)
com.j256.ormlite.support.DatabaseConnection	getReadWriteConnection(String tableName)
int	getReleaseCount() Return the approximate number of connections released over the life of the pool.
int	getTestLoopCount() Mostly for testing purposes to see how many times our test loop ran.
void	initialize() Initialize the class after the setters have been called.
boolean	isOpen(String tableName)
boolean	isSingleConnection(String tableName)
void	releaseConnection(com.j256.ormlite.support.DatabaseConnection connection)
boolean	saveSpecialConnection(com.j256.ormlite.support.DatabaseConnection connection)
void	setCheckConnectionsEveryMillis(long checkConnectionsEveryMillis) There is an internal thread which checks each of the database connections as a keep-alive mechanism.
void	setMaxConnectionAgeMillis(long maxConnectionAgeMillis) Set the number of milliseconds that a connection can stay open before being closed.
void	setMaxConnectionsFree(int maxConnectionsFree) Set the number of connections that can be unused in the available list.
void	setTestBeforeGet(boolean testBeforeGetFromPool)
protected boolean	testConnection(JdbcPooledConnectionSource.ConnectionMetaData connMetaData)

Methods inherited from class com.j256.ormlite.jdbc.JdbcConnectionSource

makeConnection, setLoginTimeoutSecs, setPassword, setUsername

Methods inherited from class com.j256.ormlite.jdbc.BaseJdbcConnectionSource

closeQuietly, getDatabaseType, getUrl, setDatabaseConnectionProxyFactory, setDatabaseType, setUrl

Methods inherited from class com.j256.ormlite.support.BaseConnectionSource

clearSpecial, getSavedConnection, getSpecialConnection, isSavedConnection, isSingleConnection, saveSpecial

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.j256.ormlite.support.ConnectionSource

closeQuietly, getDatabaseType, getSpecialConnection

Field Detail

connectionMap

protected final Map<com.j256.ormlite.support.DatabaseConnection,JdbcPooledConnectionSource.ConnectionMetaData> connectionMap

Constructor Detail

JdbcPooledConnectionSource

public JdbcPooledConnectionSource()

JdbcPooledConnectionSource

public JdbcPooledConnectionSource(String url)
                           throws SQLException

Throws:

SQLException

JdbcPooledConnectionSource

public JdbcPooledConnectionSource(String url,
                                  com.j256.ormlite.db.DatabaseType databaseType)
                           throws SQLException

Throws:

SQLException

JdbcPooledConnectionSource

public JdbcPooledConnectionSource(String url,
                                  String username,
                                  String password)
                           throws SQLException

Throws:

SQLException

JdbcPooledConnectionSource

public JdbcPooledConnectionSource(String url,
                                  String username,
                                  String password,
                                  com.j256.ormlite.db.DatabaseType databaseType)
                           throws SQLException

Throws:

SQLException

Method Detail

initialize

public void initialize()
                throws SQLException

Description copied from class: BaseJdbcConnectionSource

Initialize the class after the setters have been called. If you are using the no-arg constructor and Spring type wiring, this should be called after all of the set methods.

Overrides:

initialize in class BaseJdbcConnectionSource

Throws:

SQLException - If the driver associated with the database URL is not found in the classpath.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Overrides:

close in class BaseJdbcConnectionSource

Throws:

Exception

getReadOnlyConnection

public com.j256.ormlite.support.DatabaseConnection getReadOnlyConnection(String tableName)
                                                                  throws SQLException

Specified by:

getReadOnlyConnection in interface com.j256.ormlite.support.ConnectionSource

Overrides:

getReadOnlyConnection in class BaseJdbcConnectionSource

Throws:

SQLException

getReadWriteConnection

public com.j256.ormlite.support.DatabaseConnection getReadWriteConnection(String tableName)
                                                                   throws SQLException

Specified by:

getReadWriteConnection in interface com.j256.ormlite.support.ConnectionSource

Overrides:

getReadWriteConnection in class BaseJdbcConnectionSource

Throws:

SQLException

releaseConnection

public void releaseConnection(com.j256.ormlite.support.DatabaseConnection connection)
                       throws SQLException

Specified by:

releaseConnection in interface com.j256.ormlite.support.ConnectionSource

Overrides:

releaseConnection in class BaseJdbcConnectionSource

Throws:

SQLException

saveSpecialConnection

public boolean saveSpecialConnection(com.j256.ormlite.support.DatabaseConnection connection)
                              throws SQLException

Specified by:

saveSpecialConnection in interface com.j256.ormlite.support.ConnectionSource

Overrides:

saveSpecialConnection in class BaseJdbcConnectionSource

Throws:

SQLException

clearSpecialConnection

public void clearSpecialConnection(com.j256.ormlite.support.DatabaseConnection connection)

Specified by:

clearSpecialConnection in interface com.j256.ormlite.support.ConnectionSource

Overrides:

clearSpecialConnection in class BaseJdbcConnectionSource

isOpen

public boolean isOpen(String tableName)

Specified by:

isOpen in interface com.j256.ormlite.support.ConnectionSource

Overrides:

isOpen in class BaseJdbcConnectionSource

isSingleConnection

public boolean isSingleConnection(String tableName)

Specified by:

isSingleConnection in interface com.j256.ormlite.support.ConnectionSource

Overrides:

isSingleConnection in class BaseJdbcConnectionSource

setMaxConnectionsFree

public void setMaxConnectionsFree(int maxConnectionsFree)

Set the number of connections that can be unused in the available list.

setMaxConnectionAgeMillis

public void setMaxConnectionAgeMillis(long maxConnectionAgeMillis)

Set the number of milliseconds that a connection can stay open before being closed. Set to Long.MAX_VALUE to have the connections never expire.

getOpenCount

public int getOpenCount()

Return the approximate number of connections opened over the life of the pool.

getReleaseCount

public int getReleaseCount()

Return the approximate number of connections released over the life of the pool.

getCloseCount

public int getCloseCount()

Return the approximate number of connections closed over the life of the pool.

getMaxConnectionsEverUsed

public int getMaxConnectionsEverUsed()

Return the approximate maximum number of connections in use at one time.

getCurrentConnectionsFree

public int getCurrentConnectionsFree()

Return the number of currently freed connections in the free list.

getCurrentConnectionsManaged

public int getCurrentConnectionsManaged()

Return the number of current connections that we are tracking.

setCheckConnectionsEveryMillis

public void setCheckConnectionsEveryMillis(long checkConnectionsEveryMillis)

There is an internal thread which checks each of the database connections as a keep-alive mechanism. This set the number of milliseconds it sleeps between checks -- default is 30000. To disable the checking thread, set this to 0 before you start using the connection source.

setTestBeforeGet

public void setTestBeforeGet(boolean testBeforeGetFromPool)

getTestLoopCount

public int getTestLoopCount()

Mostly for testing purposes to see how many times our test loop ran.

closeConnection

protected void closeConnection(com.j256.ormlite.support.DatabaseConnection connection)
                        throws SQLException

This should be inside of synchronized (lock) stanza.

Throws:

SQLException

closeConnectionQuietly

protected void closeConnectionQuietly(JdbcPooledConnectionSource.ConnectionMetaData connMetaData)

Must be called inside of synchronized(lock)

testConnection

protected boolean testConnection(JdbcPooledConnectionSource.ConnectionMetaData connMetaData)