com.j256.ormlite.support

Interface ConnectionSource

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BaseConnectionSource, WrappedConnectionSource

public interface ConnectionSource
extends AutoCloseable

A reduction of the SQL DataSource so we can implement its functionality outside of JDBC.

Author:

graywatson

Method Summary

Modifier and Type	Method and Description
void	clearSpecialConnection(DatabaseConnection connection) Clear the saved connection.
void	closeQuietly() Close any outstanding database connections.
DatabaseType	getDatabaseType() Return the DatabaseTypre associated with this connection.
DatabaseConnection	getReadOnlyConnection(String tableName) Return a database connection suitable for read-only operations.
DatabaseConnection	getReadWriteConnection(String tableName) Return a database connection suitable for read or write operations.
DatabaseConnection	getSpecialConnection(String tableName) Return the currently saved connection or null if none.
boolean	isOpen(String tableName) Return true if the connection source is open.
boolean	isSingleConnection(String tableName) Return true if there is only one connection to the database being used by this connection-sourse.
void	releaseConnection(DatabaseConnection connection) Release a database connection previously returned by getReadOnlyConnection(String) or getReadWriteConnection(String).
boolean	saveSpecialConnection(DatabaseConnection connection) Save this connection and return it for all calls to getReadOnlyConnection(String) and getReadWriteConnection(String) unless the clearSpecialConnection(DatabaseConnection) method is called, all This is used by the transaction mechanism since since all operations within a transaction must operate on the same connection.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getReadOnlyConnection

DatabaseConnection getReadOnlyConnection(String tableName)
                                  throws SQLException

Return a database connection suitable for read-only operations. After you are done, you should call releaseConnection(DatabaseConnection).

Throws:

SQLException

getReadWriteConnection

DatabaseConnection getReadWriteConnection(String tableName)
                                   throws SQLException

Return a database connection suitable for read or write operations. After you are done, you should call releaseConnection(DatabaseConnection).

Throws:

SQLException

releaseConnection

void releaseConnection(DatabaseConnection connection)
                throws SQLException

Release a database connection previously returned by getReadOnlyConnection(String) or getReadWriteConnection(String).

Throws:

SQLException

saveSpecialConnection

boolean saveSpecialConnection(DatabaseConnection connection)
                       throws SQLException

Save this connection and return it for all calls to getReadOnlyConnection(String) and getReadWriteConnection(String) unless the clearSpecialConnection(DatabaseConnection) method is called, all This is used by the transaction mechanism since since all operations within a transaction must operate on the same connection. It is also used by the Android code during initialization.

NOTE: This should be a read-write connection since transactions and Android need it to be so.

NOTE: Saving a connection is usually accomplished using ThreadLocals so multiple threads should not be using connections in this scenario.

Returns:

True if the connection was saved or false if we were already inside of a saved connection.

Throws:

SQLException

clearSpecialConnection

void clearSpecialConnection(DatabaseConnection connection)

Clear the saved connection.

getSpecialConnection

DatabaseConnection getSpecialConnection(String tableName)

Return the currently saved connection or null if none.

closeQuietly

void closeQuietly()

Close any outstanding database connections.

getDatabaseType

DatabaseType getDatabaseType()

Return the DatabaseTypre associated with this connection.

isOpen

boolean isOpen(String tableName)

Return true if the connection source is open. Once AutoCloseable.close() has been called, this should return false.

isSingleConnection

boolean isSingleConnection(String tableName)

Return true if there is only one connection to the database being used by this connection-sourse. If true then some synchronization will be enabled when using batch tasks. The user will also need to synchronize around some of the transaction and auto-commit calls.