org.eclipse.persistence.internal.databaseaccess

Class DatasourceAccessor

java.lang.Object

org.eclipse.persistence.internal.databaseaccess.DatasourceAccessor

All Implemented Interfaces:

java.lang.Cloneable, Accessor

Direct Known Subclasses:

DatabaseAccessor, EISAccessor, XMLAccessor

public abstract class DatasourceAccessor
extends java.lang.Object
implements Accessor

INTERNAL: DatasourceAccessor is an abstract implementation of the Accessor interface providing common functionality to the concrete database and EIS accessors. It is responsible for connecting, transactions, call execution

Since:

OracleAS TopLink 10g (10.0.3) 05/28/2008-1.0M8 Andrei Ilitchev. - 224964: Provide support for Proxy Authentication through JPA. Added ConnectionCustomizer, also fixed postConnect/preDisconnect ExternalConnection calls so that they called in case of reads, too.

Author:

James

See Also:

Call, Login

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	READ_STATEMENTS_COUNT_PROPERTY
int	readStatementsCount Keep track of the number of the read statement that being executed.
static boolean	shouldCheckConnection Back-door to allow isConnect checks.
static java.lang.String	STOREDPROCEDURE_STATEMENTS_COUNT_PROPERTY
int	storedProcedureStatementsCount Keep track of the number of the storedprocedure statement that being executed.
static java.lang.String	WRITE_STATEMENTS_COUNT_PROPERTY
int	writeStatementsCount Keep track of the number of the write statement that being executed.

Constructor Summary

Constructors

Constructor and Description
DatasourceAccessor() Default Constructor.

Method Summary

Modifier and Type	Method and Description
void	beginTransaction(AbstractSession session) Begin a transaction on the database.
java.lang.Object	clone() Clone the accessor.
void	closeConnection() Close the accessor's connection.
void	closeJTSConnection() Called from beforeCompletion external transaction synchronization listener callback to close the external connection corresponding to the completing external transaction.
void	commitTransaction(AbstractSession session) Commit a transaction on the database.
void	connect(Login login, AbstractSession session) Connect to the datasource.
void	createCustomizer(AbstractSession session) Attempts to create ConnectionCustomizer.
void	decrementCallCount() Used for load balancing and external pooling.
void	disconnect(AbstractSession session) Disconnect from the datasource.
java.lang.Object	executeCall(Call call, AbstractRecord translationRow, AbstractSession session) Execute the call.
void	flushSelectCalls(AbstractSession session) Added as a result of Bug 2804663 - satisfy the Accessor interface implementation.
int	getCallCount() Used for load balancing and external pooling.
java.util.Vector	getColumnInfo(java.lang.String catalog, java.lang.String schema, java.lang.String tableName, java.lang.String columnName, AbstractSession session) Return column information for the specified database objects.
java.sql.Connection	getConnection() Helper method to return the JDBC connection for DatabaseAccessor.
java.lang.Object	getDatasourceConnection() Return the driver level connection.
DatasourcePlatform	getDatasourcePlatform() Return the platform.
Login	getLogin() Return the login
ConnectionPool	getPool() Return the associated connection pool this connection was obtained from.
int	getReadStatementsCount() Return the number of read statements.
SequencingCallback	getSequencingCallback(SequencingCallbackFactory sequencingCallbackFactory) Return sequencing callback.
int	getStoredProcedureStatementsCount() Return the number of stored procedure call.
java.util.Vector	getTableInfo(java.lang.String catalog, java.lang.String schema, java.lang.String tableName, java.lang.String[] types, AbstractSession session) Return table information for the specified database objects.
int	getWriteStatementsCount() Return the number of write statements.
void	incrementCallCount(AbstractSession session) Used for load balancing and external pooling.
boolean	isConnected() Return true if the accessor is currently connected to a data source.
boolean	isInTransaction() Return the transaction status of the receiver.
boolean	isPossibleFailure()
boolean	isValid() Returns true if this Accessor can continue to be used.
void	reestablishConnection(AbstractSession session) PUBLIC: Reconnect to the database.
void	releaseCustomizer() Clear customizer if it's active and set it to null.
void	releaseCustomizer(AbstractSession session) Clear and remove customizer if its session is the same as the passed one; in case prevCustomizer exists set it as a new customizer.
void	reset() Reset statement count.
void	rollbackTransaction(AbstractSession session) Rollback the transaction on the datasource.
void	setDatasourcePlatform(DatasourcePlatform platform) Set the platform.
void	setIsValid(boolean isValid) This should be set to false if a communication failure occurred during a call execution.
void	setPool(ConnectionPool pool) Set the associated connection pool this connection was obtained from.
void	setPossibleFailure(boolean possibleFailure)
boolean	usesExternalConnectionPooling() Return true if some external connection pool is in use.
boolean	usesExternalTransactionController() Return true if some external transaction service is controlling transactions.
void	writesCompleted(AbstractSession session) This method will be called after a series of writes have been issued to mark where a particular set of writes has completed.

Methods inherited from class java.lang.Object

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

Field Detail

storedProcedureStatementsCount

public int storedProcedureStatementsCount

Keep track of the number of the storedprocedure statement that being executed.

readStatementsCount

public int readStatementsCount

Keep track of the number of the read statement that being executed.

writeStatementsCount

public int writeStatementsCount

Keep track of the number of the write statement that being executed.

READ_STATEMENTS_COUNT_PROPERTY

public static final java.lang.String READ_STATEMENTS_COUNT_PROPERTY

See Also:

Constant Field Values

WRITE_STATEMENTS_COUNT_PROPERTY

public static final java.lang.String WRITE_STATEMENTS_COUNT_PROPERTY

See Also:

Constant Field Values

STOREDPROCEDURE_STATEMENTS_COUNT_PROPERTY

public static final java.lang.String STOREDPROCEDURE_STATEMENTS_COUNT_PROPERTY

See Also:

Constant Field Values

shouldCheckConnection

public static boolean shouldCheckConnection

Back-door to allow isConnect checks. Since we now support fail-over and retry, removing old isConnected usage which can cause major performance issues (on Sybase), and minor ones in general.

Constructor Detail

DatasourceAccessor

public DatasourceAccessor()

Default Constructor.

Method Detail

clone

public java.lang.Object clone()

Clone the accessor.

Specified by:

clone in interface Accessor

Overrides:

clone in class java.lang.Object

closeJTSConnection

public void closeJTSConnection()

Called from beforeCompletion external transaction synchronization listener callback to close the external connection corresponding to the completing external transaction. Final sql calls could be sent through the connection by this method before it closes the connection.

Specified by:

closeJTSConnection in interface Accessor

setIsValid

public void setIsValid(boolean isValid)

This should be set to false if a communication failure occurred during a call execution. In the case of an invalid accessor the Accessor will not be returned to the pool.

Specified by:

setIsValid in interface Accessor

isInTransaction

public boolean isInTransaction()

Return the transaction status of the receiver.

Specified by:

isInTransaction in interface Accessor

isValid

public boolean isValid()

Returns true if this Accessor can continue to be used. This will be false if a communication failure occurred during a call execution. In the case of an invalid accessor the Accessor will not be returned to the pool.

Specified by:

isValid in interface Accessor

isPossibleFailure

public boolean isPossibleFailure()

setPossibleFailure

public void setPossibleFailure(boolean possibleFailure)

usesExternalConnectionPooling

public boolean usesExternalConnectionPooling()

Return true if some external connection pool is in use.

Specified by:

usesExternalConnectionPooling in interface Accessor

beginTransaction

public void beginTransaction(AbstractSession session)
                      throws DatabaseException

Begin a transaction on the database. If not using managed transaction begin a local transaction.

Specified by:

beginTransaction in interface Accessor

Throws:

DatabaseException

decrementCallCount

public void decrementCallCount()

Used for load balancing and external pooling.

Specified by:

decrementCallCount in interface Accessor

incrementCallCount

public void incrementCallCount(AbstractSession session)

Used for load balancing and external pooling.

Specified by:

incrementCallCount in interface Accessor

reset

public void reset()

Reset statement count.

Specified by:

reset in interface Accessor

getCallCount

public int getCallCount()

Used for load balancing and external pooling.

Specified by:

getCallCount in interface Accessor

commitTransaction

public void commitTransaction(AbstractSession session)
                       throws DatabaseException

Commit a transaction on the database. If using non-managed transaction commit the local transaction.

Specified by:

commitTransaction in interface Accessor

Throws:

DatabaseException

connect

public void connect(Login login,
                    AbstractSession session)
             throws DatabaseException

Connect to the datasource. Through using a CCI ConnectionFactory. Catch exceptions and re-throw as EclipseLink exceptions.

Specified by:

connect in interface Accessor

Throws:

DatabaseException

getLogin

public Login getLogin()

Return the login

disconnect

public void disconnect(AbstractSession session)
                throws DatabaseException

Disconnect from the datasource.

Specified by:

disconnect in interface Accessor

Throws:

DatabaseException

closeConnection

public void closeConnection()

Close the accessor's connection. This is used only for external connection pooling when it is intended for the connection to be reconnected in the future.

Specified by:

closeConnection in interface Accessor

executeCall

public java.lang.Object executeCall(Call call,
                                    AbstractRecord translationRow,
                                    AbstractSession session)
                             throws DatabaseException

Execute the call.

Specified by:

executeCall in interface Accessor

Returns:

depending of the type either the row count, row or vector of rows.

Throws:

DatabaseException

reestablishConnection

public void reestablishConnection(AbstractSession session)
                           throws DatabaseException

PUBLIC: Reconnect to the database. This can be used if the connection was disconnected or timedout. This ensures that the security is checked as it is public. Because the messages can take a long time to build, pre-check whether messages should be logged.

Specified by:

reestablishConnection in interface Accessor

Throws:

DatabaseException

getDatasourcePlatform

public DatasourcePlatform getDatasourcePlatform()

Return the platform.

setDatasourcePlatform

public void setDatasourcePlatform(DatasourcePlatform platform)

Set the platform. This should be set to the session's platform, not the connections which may not be configured correctly.

getDatasourceConnection

public java.lang.Object getDatasourceConnection()

Return the driver level connection.

Specified by:

getDatasourceConnection in interface Accessor

getConnection

public java.sql.Connection getConnection()

Helper method to return the JDBC connection for DatabaseAccessor. Was going to deprecate this, but since most clients are JDBC this is useful.

Specified by:

getConnection in interface Accessor

getColumnInfo

public java.util.Vector getColumnInfo(java.lang.String catalog,
                                      java.lang.String schema,
                                      java.lang.String tableName,
                                      java.lang.String columnName,
                                      AbstractSession session)
                               throws DatabaseException

Return column information for the specified database objects.

Specified by:

getColumnInfo in interface Accessor

Throws:

DatabaseException

getReadStatementsCount

public int getReadStatementsCount()

Return the number of read statements.

getWriteStatementsCount

public int getWriteStatementsCount()

Return the number of write statements.

getStoredProcedureStatementsCount

public int getStoredProcedureStatementsCount()

Return the number of stored procedure call.

getTableInfo

public java.util.Vector getTableInfo(java.lang.String catalog,
                                     java.lang.String schema,
                                     java.lang.String tableName,
                                     java.lang.String[] types,
                                     AbstractSession session)
                              throws DatabaseException

Return table information for the specified database objects.

Specified by:

getTableInfo in interface Accessor

Throws:

DatabaseException

rollbackTransaction

public void rollbackTransaction(AbstractSession session)
                         throws DatabaseException

Rollback the transaction on the datasource. If not using managed transaction rollback the local transaction.

Specified by:

rollbackTransaction in interface Accessor

Throws:

DatabaseException

usesExternalTransactionController

public boolean usesExternalTransactionController()

Return true if some external transaction service is controlling transactions.

Specified by:

usesExternalTransactionController in interface Accessor

isConnected

public boolean isConnected()

Return true if the accessor is currently connected to a data source. Return false otherwise.

Specified by:

isConnected in interface Accessor

flushSelectCalls

public void flushSelectCalls(AbstractSession session)

Added as a result of Bug 2804663 - satisfy the Accessor interface implementation.

Specified by:

flushSelectCalls in interface Accessor

See Also:

org.eclipse.persistence.internal.helper.LOBValueWriter#buildAndExecuteCallForLocator(DatabaseCall,Session,Accessor)

writesCompleted

public void writesCompleted(AbstractSession session)

This method will be called after a series of writes have been issued to mark where a particular set of writes has completed. It will be called from commitTransaction and may be called from writeChanges. Its main purpose is to ensure that the batched statements have been executed

Specified by:

writesCompleted in interface Accessor

getSequencingCallback

public SequencingCallback getSequencingCallback(SequencingCallbackFactory sequencingCallbackFactory)

Return sequencing callback.

Specified by:

getSequencingCallback in interface Accessor

createCustomizer

public void createCustomizer(AbstractSession session)

Attempts to create ConnectionCustomizer. If created the customizer is cached by the accessor. Called by the owner of accessor (DatabaseSession, ServerSession through ConnectionPool) just once, typically right after the accessor is created. Also called by ClientSession when it acquires write accessor. If accessor already has a customizer set by ConnectionPool then ClientSession's customizer compared with the existing one and if they are not equal (don't produce identical customization) then the new customizer set onto accessor, caching the old customizer so that it could be restored later.

Specified by:

createCustomizer in interface Accessor

releaseCustomizer

public void releaseCustomizer()

Clear customizer if it's active and set it to null. Called by the same object that has created customizer (DatabaseSession, ConnectionPool) when the latter is no longer required, typically before releasing the accessor. Ignored if there's no customizer.

Specified by:

releaseCustomizer in interface Accessor

releaseCustomizer

public void releaseCustomizer(AbstractSession session)

Clear and remove customizer if its session is the same as the passed one; in case prevCustomizer exists set it as a new customizer. Called when ClientSession releases write accessor: if the customizer was created by the ClientSession it's removed, and the previous customizer (that ConnectionPool had set) is brought back; otherwise the customizer (created by ConnectionPool) is kept. Ignored if there's no customizer.

Specified by:

releaseCustomizer in interface Accessor

getPool

public ConnectionPool getPool()

Return the associated connection pool this connection was obtained from.

Specified by:

getPool in interface Accessor

setPool

public void setPool(ConnectionPool pool)

Set the associated connection pool this connection was obtained from.

Specified by:

setPool in interface Accessor