com.j256.ormlite.misc

Class WrappedConnectionSource

java.lang.Object

com.j256.ormlite.misc.WrappedConnectionSource

All Implemented Interfaces:

ConnectionSource, AutoCloseable

public class WrappedConnectionSource
extends Object
implements ConnectionSource

Wrapped connection source that uses proxy objects to track database connections and compiled statements. We use this to insure that everything is closed appropriately.

Author:

graywatson

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectionSource	cs
protected static Logger	logger
protected boolean	nextForceOkay

Constructor Summary

Constructors

Constructor and Description
WrappedConnectionSource(ConnectionSource cs)

Method Summary

Modifier and Type	Method and Description
void	clearSpecialConnection(DatabaseConnection connection) Clear the saved connection.
void	close()
void	closeQuietly() Close any outstanding database connections.
void	forceOkay() Used if we want to forcefully close a connection source without throwing errors.
int	getConnectionCount()
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	isEverythingClosed()
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 proxy) Release a database connection previously returned by ConnectionSource.getReadOnlyConnection(String) or ConnectionSource.getReadWriteConnection(String).
boolean	saveSpecialConnection(DatabaseConnection connection) Save this connection and return it for all calls to ConnectionSource.getReadOnlyConnection(String) and ConnectionSource.getReadWriteConnection(String) unless the ConnectionSource.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.
void	setDatabaseType(DatabaseType databaseType)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final Logger logger

cs

protected final ConnectionSource cs

nextForceOkay

protected boolean nextForceOkay

Constructor Detail

WrappedConnectionSource

public WrappedConnectionSource(ConnectionSource cs)

Method Detail

getReadOnlyConnection

public DatabaseConnection getReadOnlyConnection(String tableName)
                                         throws SQLException

Description copied from interface: ConnectionSource

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

Specified by:

getReadOnlyConnection in interface ConnectionSource

Throws:

SQLException

getReadWriteConnection

public DatabaseConnection getReadWriteConnection(String tableName)
                                          throws SQLException

Description copied from interface: ConnectionSource

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

Specified by:

getReadWriteConnection in interface ConnectionSource

Throws:

SQLException

releaseConnection

public void releaseConnection(DatabaseConnection proxy)
                       throws SQLException

Description copied from interface: ConnectionSource

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

Specified by:

releaseConnection in interface ConnectionSource

Throws:

SQLException

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

closeQuietly

public void closeQuietly()

Description copied from interface: ConnectionSource

Close any outstanding database connections.

Specified by:

closeQuietly in interface ConnectionSource

forceOkay

public void forceOkay()

Used if we want to forcefully close a connection source without throwing errors.

isEverythingClosed

public boolean isEverythingClosed()

saveSpecialConnection

public boolean saveSpecialConnection(DatabaseConnection connection)
                              throws SQLException

Description copied from interface: ConnectionSource

Save this connection and return it for all calls to ConnectionSource.getReadOnlyConnection(String) and ConnectionSource.getReadWriteConnection(String) unless the ConnectionSource.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.

Specified by:

saveSpecialConnection in interface ConnectionSource

Returns:

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

Throws:

SQLException

clearSpecialConnection

public void clearSpecialConnection(DatabaseConnection connection)

Description copied from interface: ConnectionSource

Clear the saved connection.

Specified by:

clearSpecialConnection in interface ConnectionSource

getSpecialConnection

public DatabaseConnection getSpecialConnection(String tableName)

Description copied from interface: ConnectionSource

Return the currently saved connection or null if none.

Specified by:

getSpecialConnection in interface ConnectionSource

getDatabaseType

public DatabaseType getDatabaseType()

Description copied from interface: ConnectionSource

Return the DatabaseTypre associated with this connection.

Specified by:

getDatabaseType in interface ConnectionSource

isOpen

public boolean isOpen(String tableName)

Description copied from interface: ConnectionSource

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

Specified by:

isOpen in interface ConnectionSource

isSingleConnection

public boolean isSingleConnection(String tableName)

Description copied from interface: ConnectionSource

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.

Specified by:

isSingleConnection in interface ConnectionSource

setDatabaseType

public void setDatabaseType(DatabaseType databaseType)

getConnectionCount

public int getConnectionCount()