com.j256.ormlite.jdbc

Class DataSourceConnectionSource

java.lang.Object

com.j256.ormlite.support.BaseConnectionSource

com.j256.ormlite.jdbc.DataSourceConnectionSource

All Implemented Interfaces:

com.j256.ormlite.support.ConnectionSource, AutoCloseable

public class DataSourceConnectionSource
extends com.j256.ormlite.support.BaseConnectionSource
implements com.j256.ormlite.support.ConnectionSource

Wrapper around a DataSource that supports our ConnectionSource interface. This allows you to wrap other multi-threaded, high-performance data sources, see Apache DBCP, CP30, or BoneCP.

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.

Author:

graywatson

Constructor Summary

Constructors

Constructor and Description
DataSourceConnectionSource() Constructor for Spring type wiring if you are using the set methods.
DataSourceConnectionSource(DataSource dataSource, com.j256.ormlite.db.DatabaseType databaseType) Create a data source wrapper for a DataSource.
DataSourceConnectionSource(DataSource dataSource, String databaseUrl) Create a data source wrapper for a DataSource.

Method Summary

Modifier and Type	Method and Description
void	clearSpecialConnection(com.j256.ormlite.support.DatabaseConnection connection)
void	close() This typically closes the connection source but because there is not a close() method on the DataSource (grrrr), this close method does _nothing_.
void	closeQuietly()
com.j256.ormlite.db.DatabaseType	getDatabaseType()
com.j256.ormlite.support.DatabaseConnection	getReadOnlyConnection(String tableName)
com.j256.ormlite.support.DatabaseConnection	getReadOnlyConnection(String tableName, String username, String password)
com.j256.ormlite.support.DatabaseConnection	getReadWriteConnection(String tableName)
com.j256.ormlite.support.DatabaseConnection	getReadWriteConnection(String tableName, String username, String password)
void	initialize() Initialize the class after the setters have been called.
boolean	isOpen(String tableName) Unfortunately we cannot tell if the related data source has been closed so this just returns true.
boolean	isSingleConnection(String tableName) Return true if there is only one connection to the database.
void	releaseConnection(com.j256.ormlite.support.DatabaseConnection connection)
boolean	saveSpecialConnection(com.j256.ormlite.support.DatabaseConnection connection)
void	setDatabaseType(com.j256.ormlite.db.DatabaseType databaseType)
void	setDatabaseUrl(String databaseUrl)
void	setDataSource(DataSource dataSource)

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

getSpecialConnection

Constructor Detail

DataSourceConnectionSource

public DataSourceConnectionSource()

Constructor for Spring type wiring if you are using the set methods. If you are using Spring then your should use: init-method="initialize"

DataSourceConnectionSource

public DataSourceConnectionSource(DataSource dataSource,
                                  String databaseUrl)
                           throws SQLException

Create a data source wrapper for a DataSource.

Throws:

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

DataSourceConnectionSource

public DataSourceConnectionSource(DataSource dataSource,
                                  com.j256.ormlite.db.DatabaseType databaseType)
                           throws SQLException

Create a data source wrapper for a DataSource. The databaseType is usually determined from the databaseUrl so most users should call DataSourceConnectionSource(DataSource, String) instead. If, however, you need to force the class to use a specific DatabaseType then this constructor should be used.

Throws:

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

Method Detail

initialize

public void initialize()
                throws SQLException

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.

Throws:

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

getReadOnlyConnection

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

Specified by:

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

Throws:

SQLException

getReadOnlyConnection

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

Throws:

SQLException

getReadWriteConnection

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

Specified by:

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

Throws:

SQLException

releaseConnection

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

Specified by:

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

Throws:

SQLException

getReadWriteConnection

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

Throws:

SQLException

saveSpecialConnection

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

Specified by:

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

Throws:

SQLException

clearSpecialConnection

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

Specified by:

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

close

public void close()
           throws Exception

This typically closes the connection source but because there is not a close() method on the DataSource (grrrr), this close method does _nothing_. You must close the underlying data-source yourself.

Specified by:

close in interface AutoCloseable

Throws:

Exception

closeQuietly

public void closeQuietly()

Specified by:

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

getDatabaseType

public com.j256.ormlite.db.DatabaseType getDatabaseType()

Specified by:

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

isOpen

public boolean isOpen(String tableName)

Unfortunately we cannot tell if the related data source has been closed so this just returns true.

Specified by:

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

isSingleConnection

public boolean isSingleConnection(String tableName)

Return true if there is only one connection to the database. If true then some thread locks may be enabled when using batch tasks and auto-commit.

NOTE: to test the data-source to see if it gives out multiple connections, we request two connections to see if they are different. I guess that's the best that we can do.

Specified by:

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

setDataSource

public void setDataSource(DataSource dataSource)

setDatabaseType

public void setDatabaseType(com.j256.ormlite.db.DatabaseType databaseType)

setDatabaseUrl

public void setDatabaseUrl(String databaseUrl)