org.apache.derby.iapi.jdbc

Interface BrokeredConnectionControl

public interface BrokeredConnectionControl

Provides control over a BrokeredConnection

Method Summary

Modifier and Type	Method and Description
void	checkAutoCommit(boolean autoCommit) Allow control over setting auto commit mode.
void	checkClose() Check if the brokered connection can be closed.
void	checkCommit() Allow control over calling commit.
int	checkHoldCursors(int holdability, boolean downgrade) Can cursors be held across commits.
void	checkRollback() Allow control over calling rollback.
void	checkSavepoint() Allow control over creating a Savepoint (JDBC 3.0)
boolean	closingConnection() Close called on BrokeredConnection.
EngineConnection	getRealConnection() Return the real JDBC connection for the brokered connection.
boolean	isInGlobalTransaction() Is this a global transaction
boolean	isIsolationLevelSetUsingSQLorJDBC() Returns true if isolation level has been set using JDBC/SQL.
void	notifyException(java.sql.SQLException sqle) Notify the control class that a SQLException was thrown during a call on one of the brokered connection's methods.
void	onStatementClose(java.sql.PreparedStatement statement) Close called on the associated PreparedStatement object
void	onStatementErrorOccurred(java.sql.PreparedStatement statement, java.sql.SQLException sqle) Error occurred on associated PreparedStatement object
void	resetIsolationLevelFlag() Reset the isolation level flag used to keep state in BrokeredConnection.
java.sql.CallableStatement	wrapStatement(java.sql.CallableStatement realStatement, java.lang.String sql) Optionally wrap a CallableStatement with an CallableStatement.
java.sql.PreparedStatement	wrapStatement(java.sql.PreparedStatement realStatement, java.lang.String sql, java.lang.Object generateKeys) Optionally wrap a PreparedStatement with another PreparedStatement.
java.sql.Statement	wrapStatement(java.sql.Statement realStatement) Optionally wrap a Statement with another Statement.

Method Detail

getRealConnection

EngineConnection getRealConnection()
                            throws java.sql.SQLException

Return the real JDBC connection for the brokered connection.

Throws:

java.sql.SQLException

notifyException

void notifyException(java.sql.SQLException sqle)

Notify the control class that a SQLException was thrown during a call on one of the brokered connection's methods.

checkAutoCommit

void checkAutoCommit(boolean autoCommit)
              throws java.sql.SQLException

Allow control over setting auto commit mode.

Throws:

java.sql.SQLException

checkSavepoint

void checkSavepoint()
             throws java.sql.SQLException

Allow control over creating a Savepoint (JDBC 3.0)

Throws:

java.sql.SQLException

checkRollback

void checkRollback()
            throws java.sql.SQLException

Allow control over calling rollback.

Throws:

java.sql.SQLException

checkCommit

void checkCommit()
          throws java.sql.SQLException

Allow control over calling commit.

Throws:

java.sql.SQLException

checkClose

void checkClose()
         throws java.sql.SQLException

Check if the brokered connection can be closed.

Throws:

java.sql.SQLException - if it is not allowed to call close on the brokered connection

checkHoldCursors

int checkHoldCursors(int holdability,
                     boolean downgrade)
              throws java.sql.SQLException

Can cursors be held across commits.

Parameters:

downgrade - true to downgrade the holdability, false to throw an exception.

Throws:

java.sql.SQLException

isIsolationLevelSetUsingSQLorJDBC

boolean isIsolationLevelSetUsingSQLorJDBC()
                                   throws java.sql.SQLException

Returns true if isolation level has been set using JDBC/SQL.

Throws:

java.sql.SQLException

resetIsolationLevelFlag

void resetIsolationLevelFlag()
                      throws java.sql.SQLException

Reset the isolation level flag used to keep state in BrokeredConnection. It will get set to true when isolation level is set using JDBC/SQL. It will get reset to false at the start and the end of a global transaction.

Throws:

java.sql.SQLException

isInGlobalTransaction

boolean isInGlobalTransaction()

Is this a global transaction

Returns:

true if this is a global XA transaction

closingConnection

boolean closingConnection()
                   throws java.sql.SQLException

Close called on BrokeredConnection. If this call returns true then getRealConnection().close() will be called.

Throws:

java.sql.SQLException

wrapStatement

java.sql.Statement wrapStatement(java.sql.Statement realStatement)
                          throws java.sql.SQLException

Optionally wrap a Statement with another Statement.

Throws:

java.sql.SQLException

wrapStatement

java.sql.PreparedStatement wrapStatement(java.sql.PreparedStatement realStatement,
                                         java.lang.String sql,
                                         java.lang.Object generateKeys)
                                  throws java.sql.SQLException

Optionally wrap a PreparedStatement with another PreparedStatement.

Throws:

java.sql.SQLException

wrapStatement

java.sql.CallableStatement wrapStatement(java.sql.CallableStatement realStatement,
                                         java.lang.String sql)
                                  throws java.sql.SQLException

Optionally wrap a CallableStatement with an CallableStatement.

Throws:

java.sql.SQLException

onStatementClose

void onStatementClose(java.sql.PreparedStatement statement)

Close called on the associated PreparedStatement object

Parameters:

statement - PreparedStatement object on which the close event occurred

onStatementErrorOccurred

void onStatementErrorOccurred(java.sql.PreparedStatement statement,
                              java.sql.SQLException sqle)

Error occurred on associated PreparedStatement object

Parameters:

statement - PreparedStatement object on which the error occured

sqle - The SQLExeption that caused the error