Accessors must implement the following behavior:
org.eclipse.persistence.internal.sessions.AbstractSession , Call
| Modifier and Type | Method and Description |
|---|---|
| public void | |
| public Object | |
| public void | |
| public void | closeJTSConnection()
Called from beforeCompletion external transaction synchronization listener callback to close the external connection corresponding to the completing external transaction. |
| public void | |
| public void | connect(Login login, AbstractSession session)
Connect to the data store using the configuration information in the login. |
| public void | |
| public void | |
| public void | |
| public Object | Returns: a row, a collection of rows, a row count, or a cursorExecute the call. |
| public void | |
| public int | |
| public Vector | getColumnInfo(String catalog, String schema, String tableName, String columnName, AbstractSession session)
Return the column metadata for the specified selection criteria. |
| public Vector | getColumnInfo(String tableName, String columnName, AbstractSession session)
Return the column metadata for the specified
selection criteria limited to the context of the current |
| public Connection | |
| public Object | getDatasourceConnection()
Return the driver level connection, this will need to be cast to the implementation class for the data access type being used. |
| public ConnectionPool | |
| public SequencingCallback | getSequencingCallback(SequencingCallbackFactory sequencingCallbackFactory)
Return sequencing callback. |
| public Vector | getTableInfo(String catalog, String schema, String tableName, String[] types, AbstractSession session)
Return the table metadata for the specified selection criteria. |
| public Vector | getTableInfo(String tableName, String[] types, AbstractSession session)
Return the table metadata for the specified
selection criteria limited to the context of the current |
| public void | |
| public boolean | |
| public boolean | |
| public boolean | |
| public void | |
| public void | |
| 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. |
| public void | |
| public void | |
| public void | setIsValid(boolean isValid)
This should be set to false if a communication failure occurred durring a call execution. |
| public void | |
| public boolean | |
| public boolean | usesExternalTransactionController()
Return whether the accessor uses an external transaction controller (e.g. JTS). |
| 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. |
| beginTransaction | back to summary |
|---|---|
| public void beginTransaction(AbstractSession session) throws DatabaseException Begin a transaction on the data store. | |
| clone | back to summary |
|---|---|
| public Object clone() Return a clone of the accessor. | |
| closeConnection | back to summary |
|---|---|
| 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. | |
| closeJTSConnection | back to summary |
|---|---|
| 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. | |
| commitTransaction | back to summary |
|---|---|
| public void commitTransaction(AbstractSession session) throws DatabaseException Commit a transaction on the data store. | |
| connect | back to summary |
|---|---|
| public void connect(Login login, AbstractSession session) throws DatabaseException Connect to the data store using the configuration information in the login. | |
| createCustomizer | back to summary |
|---|---|
| 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. | |
| decrementCallCount | back to summary |
|---|---|
| public void decrementCallCount() Decrement the number of calls in progress. Used for external pooling. | |
| disconnect | back to summary |
|---|---|
| public void disconnect(AbstractSession session) throws DatabaseException Disconnect from the data store. | |
| executeCall | back to summary |
|---|---|
| public Object executeCall(Call call, AbstractRecord translationRow, AbstractSession session) throws DatabaseException Execute the call. The actual behavior of the execution depends on the type of call. The call may be parameterized where the arguments are in the translation row. The row will be empty if there are no parameters.
| |
| flushSelectCalls | back to summary |
|---|---|
| public void flushSelectCalls(AbstractSession session) Execute any deferred select calls. This method will generally be called after one or more select calls have been collected in a LOBValueWriter (to be executed after all insert calls are executed). Bug 2804663. | |
| getCallCount | back to summary |
|---|---|
| public int getCallCount() Return the number of calls currently in progress. Used for load balancing and external pooling. | |
| getColumnInfo | back to summary |
|---|---|
| public Vector Return the column metadata for the specified selection criteria. | |
| getColumnInfo | back to summary |
|---|---|
| public Vector Return the column metadata for the specified
selection criteria limited to the context of the current | |
| getConnection | back to summary |
|---|---|
| public Connection getConnection() Return the JDBC connection for relational accessors. This will fail for non-relational accessors. | |
| getDatasourceConnection | back to summary |
|---|---|
| public Object getDatasourceConnection() Return the driver level connection, this will need to be cast to the implementation class for the data access type being used. | |
| getPool | back to summary |
|---|---|
| public ConnectionPool getPool() Return the associated connection pool this connection was obtained from. | |
| getSequencingCallback | back to summary |
|---|---|
| public SequencingCallback getSequencingCallback(SequencingCallbackFactory sequencingCallbackFactory) Return sequencing callback. | |
| getTableInfo | back to summary |
|---|---|
| public Vector Return the table metadata for the specified selection criteria. | |
| getTableInfo | back to summary |
|---|---|
| public Vector Return the table metadata for the specified
selection criteria limited to the context of the current | |
| incrementCallCount | back to summary |
|---|---|
| public void incrementCallCount(AbstractSession session) Increment the number of calls in progress. Used for external pooling. | |
| isConnected | back to summary |
|---|---|
| public boolean isConnected() Return whether the accessor is connected to the data store. | |
| isInTransaction | back to summary |
|---|---|
| public boolean isInTransaction() Return whether the accessor is in transaction. | |
| isValid | back to summary |
|---|---|
| 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. | |
| reestablishConnection | back to summary |
|---|---|
| public void reestablishConnection(AbstractSession session) throws DatabaseException Reconnect to the database. This can be used if the connection was temporarily disconnected or if it timed out. | |
| releaseCustomizer | back to summary |
|---|---|
| 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. | |
| releaseCustomizer | back to summary |
|---|---|
| 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. | |
| reset | back to summary |
|---|---|
| public void reset() Reset the accessor before being released. | |
| rollbackTransaction | back to summary |
|---|---|
| public void rollbackTransaction(AbstractSession session) throws DatabaseException Roll back a transaction on the data store. | |
| setIsValid | back to summary |
|---|---|
| public void setIsValid(boolean isValid) This should be set to false if a communication failure occurred durring a call execution. In the case of an invalid accessor the Accessor will not be returned to the pool. | |
| setPool | back to summary |
|---|---|
| public void setPool(ConnectionPool pool) Set the associated connection pool this connection was obtained from. | |
| usesExternalConnectionPooling | back to summary |
|---|---|
| public boolean usesExternalConnectionPooling() Return whether the accessor uses external connection pooling. | |
| usesExternalTransactionController | back to summary |
|---|---|
| public boolean usesExternalTransactionController() Return whether the accessor uses an external transaction controller (e.g. JTS). | |
| writesCompleted | back to summary |
|---|---|
| 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 | |