Class BrokeredConnection

java.lang.Object

org.apache.derby.iapi.jdbc.BrokeredConnection

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper, EngineConnection

Direct Known Subclasses:

BrokeredConnection42

public class BrokeredConnection
extends Object
implements EngineConnection

This is a rudimentary connection that delegates EVERYTHING to Connection.

Field Summary

Fields

Modifier and Type	Field	Description
private String	connString
(package private) final BrokeredConnectionControl	control
protected boolean	isClosed
private boolean	stateAutoCommit
(package private) int	stateHoldability
private int	stateIsolationLevel	Maintain state as seen by this Connection handle, not the state of the underlying Connection it is attached to.
private boolean	stateReadOnly

Fields inherited from interface Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors

Constructor	Description
BrokeredConnection(BrokeredConnectionControl control)	//////////////////////////////////////////////////////////////////////

Method Summary

Modifier and Type	Method	Description
void	abort(Executor executor)
final void	addWarning(SQLWarning w)	Add a SQLWarning to this Connection object.
final void	clearWarnings()
final void	close()
final void	commit()
final Array	createArrayOf(String typeName, Object[] elements)
final Blob	createBlob()	Constructs an object that implements the Blob interface.
final Clob	createClob()	Constructs an object that implements the Clob interface.
final NClob	createNClob()
final SQLXML	createSQLXML()
final Statement	createStatement()
final Statement	createStatement(int resultSetType, int resultSetConcurrency)
final Statement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
final Struct	createStruct(String typeName, Object[] attributes)
final boolean	getAutoCommit()
final String	getCatalog()
final Properties	getClientInfo()	getClientInfo forwards to the real connection.
final String	getClientInfo(String name)	getClientInfo forwards to the real connection.
String	getCurrentSchemaName()	Obtain the name of the current schema.
final int	getHoldability()	Get the holdability for statements created by this connection when holdability is not passed in.
void	getIsolationUptoDate()	Isolation level state in BrokeredConnection can get out of sync if the isolation is set using SQL rather than JDBC.
Object	getLOBMapping(int key)	Get the LOB reference corresponding to the locator.
final DatabaseMetaData	getMetaData()
int	getNetworkTimeout()
final int	getPrepareIsolation()	get the isolation level that is currently being used to prepare statements (used for network server)
(package private) final EngineConnection	getRealConnection()	A little indirection for getting the real connection.
String	getSchema()	Get the name of the current schema.
final int	getTransactionIsolation()
Map<String,Class<?>>	getTypeMap()
final SQLWarning	getWarnings()
final boolean	isClosed()
boolean	isInGlobalTransaction()	Is this a global transaction
final boolean	isReadOnly()
final boolean	isValid(int timeout)	Checks if the connection has not been closed and is still valid.
final boolean	isWrapperFor(Class<?> iface)	Returns false unless iface is implemented.
final String	nativeSQL(String sql)
final BrokeredStatement	newBrokeredStatement(BrokeredStatementControl statementControl)
BrokeredCallableStatement	newBrokeredStatement(BrokeredStatementControl statementControl, String sql)
BrokeredPreparedStatement	newBrokeredStatement(BrokeredStatementControl statementControl, String sql, Object generatedKeys)
(package private) final SQLException	noCurrentConnection()	Generate an exception reporting that there is no current connection.
(package private) final void	notifyException(SQLException sqle)
final CallableStatement	prepareCall(String sql)
final CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency)
final CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
final PreparedStatement	prepareStatement(String sql)
final PreparedStatement	prepareStatement(String sql, int autoGeneratedKeys)
final PreparedStatement	prepareStatement(String sql, int[] columnIndexes)
final PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
final PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)	Prepare statement with explicit holdability.
final PreparedStatement	prepareStatement(String sql, String[] columnNames)
final void	releaseSavepoint(Savepoint savepoint)
void	resetFromPool()	Resets the connection before it is returned from a PooledConnection to a new application request (wrapped by a BrokeredConnection).
final void	rollback()
final void	rollback(Savepoint savepoint)
final void	setAutoCommit(boolean autoCommit)
final void	setCatalog(String catalog)
final void	setClientInfo(String name, String value)	setClientInfo forwards to the real connection.
final void	setClientInfo(Properties properties)	setClientInfo forwards to the real connection.
final void	setDrdaID(String drdaID)	set the DrdaId for this connection.
final void	setHoldability(int holdability)
void	setNetworkTimeout(Executor executor, int milliseconds)
final void	setPrepareIsolation(int level)	Set the internal isolation level to use for preparing statements.
final void	setReadOnly(boolean readOnly)
final Savepoint	setSavepoint()
final Savepoint	setSavepoint(String name)
void	setSchema(String schemaName)	Set the default schema for the Connection.
void	setState(boolean complete)	Set the state of the underlying connection according to the state of this connection's view of state.
final void	setTransactionIsolation(int level)
final void	setTypeMap(Map<String,Class<?>> map)
(package private) final int	statementHoldabilityCheck(int resultSetHoldability)	Check the result set holdability when creating a statement object.
void	syncState()	Sync up the state of the underlying connection with the state of this new handle.
String	toString()	Get the string representation for this connection.
final <T> T	unwrap(Class<T> iface)	Returns this if this class implements the interface.

Methods inherited from class Object

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

Methods inherited from interface Connection

beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid

Field Details

stateHoldability

int stateHoldability

control

final BrokeredConnectionControl control

isClosed

protected boolean isClosed

connString

private String connString

stateIsolationLevel

private int stateIsolationLevel

Maintain state as seen by this Connection handle, not the state of the underlying Connection it is attached to.

stateReadOnly

private boolean stateReadOnly

stateAutoCommit

private boolean stateAutoCommit

Constructor Details

BrokeredConnection

public BrokeredConnection(BrokeredConnectionControl control)
                   throws SQLException

//////////////////////////////////////////////////////////////////////

Throws:

SQLException

Method Details

setAutoCommit

public final void setAutoCommit(boolean autoCommit)
                         throws SQLException

Specified by:

setAutoCommit in interface Connection

Throws:

SQLException

getAutoCommit

public final boolean getAutoCommit()
                            throws SQLException

Specified by:

getAutoCommit in interface Connection

Throws:

SQLException

createStatement

public final Statement createStatement()
                                throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareStatement

public final PreparedStatement prepareStatement(String sql)
                                         throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareCall

public final CallableStatement prepareCall(String sql)
                                    throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

nativeSQL

public final String nativeSQL(String sql)
                       throws SQLException

Specified by:

nativeSQL in interface Connection

Throws:

SQLException

commit

public final void commit()
                  throws SQLException

Specified by:

commit in interface Connection

Throws:

SQLException

rollback

public final void rollback()
                    throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

close

public final void close()
                 throws SQLException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Throws:

SQLException

isClosed

public final boolean isClosed()
                       throws SQLException

Specified by:

isClosed in interface Connection

Throws:

SQLException

getWarnings

public final SQLWarning getWarnings()
                             throws SQLException

Specified by:

getWarnings in interface Connection

Throws:

SQLException

clearWarnings

public final void clearWarnings()
                         throws SQLException

Specified by:

clearWarnings in interface Connection

Throws:

SQLException

getMetaData

public final DatabaseMetaData getMetaData()
                                   throws SQLException

Specified by:

getMetaData in interface Connection

Throws:

SQLException

setReadOnly

public final void setReadOnly(boolean readOnly)
                       throws SQLException

Specified by:

setReadOnly in interface Connection

Throws:

SQLException

isReadOnly

public final boolean isReadOnly()
                         throws SQLException

Specified by:

isReadOnly in interface Connection

Throws:

SQLException

setCatalog

public final void setCatalog(String catalog)
                      throws SQLException

Specified by:

setCatalog in interface Connection

Throws:

SQLException

getCatalog

public final String getCatalog()
                        throws SQLException

Specified by:

getCatalog in interface Connection

Throws:

SQLException

setTransactionIsolation

public final void setTransactionIsolation(int level)
                                   throws SQLException

Specified by:

setTransactionIsolation in interface Connection

Throws:

SQLException

getTransactionIsolation

public final int getTransactionIsolation()
                                  throws SQLException

Specified by:

getTransactionIsolation in interface Connection

Throws:

SQLException

createStatement

public final Statement createStatement(int resultSetType,
 int resultSetConcurrency)
                                throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareStatement

public final PreparedStatement prepareStatement(String sql,
 int resultSetType,
 int resultSetConcurrency)
                                         throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareCall

public final CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency)
                                    throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

getTypeMap

public Map<String,Class<?>> getTypeMap()
                                throws SQLException

Specified by:

getTypeMap in interface Connection

Throws:

SQLException

setTypeMap

public final void setTypeMap(Map<String,Class<?>> map)
                      throws SQLException

Specified by:

setTypeMap in interface Connection

Throws:

SQLException

createStatement

public final Statement createStatement(int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                                throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareCall

public final CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                                    throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

setSavepoint

public final Savepoint setSavepoint()
                             throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

setSavepoint

public final Savepoint setSavepoint(String name)
                             throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

rollback

public final void rollback(Savepoint savepoint)
                    throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

releaseSavepoint

public final void releaseSavepoint(Savepoint savepoint)
                            throws SQLException

Specified by:

releaseSavepoint in interface Connection

Throws:

SQLException

setHoldability

public final void setHoldability(int holdability)
                          throws SQLException

Specified by:

setHoldability in interface Connection

Throws:

SQLException

prepareStatement

public final PreparedStatement prepareStatement(String sql,
 int autoGeneratedKeys)
                                         throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public final PreparedStatement prepareStatement(String sql,
 int[] columnIndexes)
                                         throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public final PreparedStatement prepareStatement(String sql,
 String[] columnNames)
                                         throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

noCurrentConnection

final SQLException noCurrentConnection()

Generate an exception reporting that there is no current connection.

Returns:

a no-current-connection exception

getRealConnection

final EngineConnection getRealConnection()
                                  throws SQLException

A little indirection for getting the real connection.

Returns:

the current connection

Throws:

SQLException

notifyException

final void notifyException(SQLException sqle)

syncState

public void syncState()
               throws SQLException

Sync up the state of the underlying connection with the state of this new handle.

Throws:

SQLException

getIsolationUptoDate

public void getIsolationUptoDate()
                          throws SQLException

Isolation level state in BrokeredConnection can get out of sync if the isolation is set using SQL rather than JDBC. In order to ensure correct state level information, this method is called at the start and end of a global transaction.

Throws:

SQLException

setState

public void setState(boolean complete)
              throws SQLException

Set the state of the underlying connection according to the state of this connection's view of state.

Parameters:

complete - If true set the complete state of the underlying Connection, otherwise set only the Connection related state (ie. the non-transaction specific state).

Throws:

SQLException

newBrokeredStatement

public final BrokeredStatement newBrokeredStatement(BrokeredStatementControl statementControl)
                                             throws SQLException

Throws:

SQLException

newBrokeredStatement

public BrokeredPreparedStatement newBrokeredStatement(BrokeredStatementControl statementControl,
 String sql,
 Object generatedKeys)
                                               throws SQLException

Throws:

SQLException

newBrokeredStatement

public BrokeredCallableStatement newBrokeredStatement(BrokeredStatementControl statementControl,
 String sql)
                                               throws SQLException

Throws:

SQLException

setDrdaID

public final void setDrdaID(String drdaID)

set the DrdaId for this connection. The drdaID prints with the statement text to the errror log

Specified by:

setDrdaID in interface EngineConnection

Parameters:

drdaID - drdaID to be used for this connection

isInGlobalTransaction

public boolean isInGlobalTransaction()

Description copied from interface: EngineConnection

Is this a global transaction

Specified by:

isInGlobalTransaction in interface EngineConnection

Returns:

true if this is a global XA transaction

See Also:

• EngineConnection.isInGlobalTransaction()

setPrepareIsolation

public final void setPrepareIsolation(int level)
                               throws SQLException

Set the internal isolation level to use for preparing statements. Subsequent prepares will use this isoalation level

Specified by:

setPrepareIsolation in interface EngineConnection

Parameters:

level - - internal isolation level

Throws:

SQLException - See EmbedConnection#setPrepareIsolation

getPrepareIsolation

public final int getPrepareIsolation()
                              throws SQLException

get the isolation level that is currently being used to prepare statements (used for network server)

Specified by:

getPrepareIsolation in interface EngineConnection

Returns:

current prepare isolation level See EmbedConnection#getPrepareIsolation

Throws:

SQLException

addWarning

public final void addWarning(SQLWarning w)
                      throws SQLException

Add a SQLWarning to this Connection object.

Specified by:

addWarning in interface EngineConnection

Parameters:

w - Warning to be added, will be chained to any existing warnings.

Throws:

SQLException

toString

public String toString()

Get the string representation for this connection. Return the class name/hash code and various debug information.

Overrides:

toString in class Object

Returns:

unique string representation for this connection

prepareStatement

public final PreparedStatement prepareStatement(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                                         throws SQLException

Prepare statement with explicit holdability.

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

getHoldability

public final int getHoldability()
                         throws SQLException

Get the holdability for statements created by this connection when holdability is not passed in.

Specified by:

getHoldability in interface Connection

Throws:

SQLException

createArrayOf

public final Array createArrayOf(String typeName,
 Object[] elements)
                          throws SQLException

Specified by:

createArrayOf in interface Connection

Throws:

SQLException

createBlob

public final Blob createBlob()
                      throws SQLException

Constructs an object that implements the Blob interface. The object returned initially contains no data. The setBinaryStream and setBytes methods of the Blob interface may be used to add data to the Blob.

Specified by:

createBlob in interface Connection

Returns:

An object that implements the Blob interface

Throws:

SQLException - if an object that implements the Blob interface can not be constructed, this method is called on a closed connection or a database access error occurs.

createClob

public final Clob createClob()
                      throws SQLException

Constructs an object that implements the Clob interface. The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the Clob interface may be used to add data to the Clob.

Specified by:

createClob in interface Connection

Returns:

An object that implements the Clob interface

Throws:

SQLException - if an object that implements the Clob interface can not be constructed, this method is called on a closed connection or a database access error occurs.

createNClob

public final NClob createNClob()
                        throws SQLException

Specified by:

createNClob in interface Connection

Throws:

SQLException

createSQLXML

public final SQLXML createSQLXML()
                          throws SQLException

Specified by:

createSQLXML in interface Connection

Throws:

SQLException

createStruct

public final Struct createStruct(String typeName,
 Object[] attributes)
                          throws SQLException

Specified by:

createStruct in interface Connection

Throws:

SQLException

isValid

public final boolean isValid(int timeout)
                      throws SQLException

Checks if the connection has not been closed and is still valid. The validity is checked by running a simple query against the database.

Specified by:

isValid in interface Connection

Parameters:

timeout - The time in seconds to wait for the database operation used to validate the connection to complete. If the timeout period expires before the operation completes, this method returns false. A value of 0 indicates a timeout is not applied to the database operation.

Returns:

true if the connection is valid, false otherwise

Throws:

SQLException - if the call on the physical connection throws an exception.

setClientInfo

public final void setClientInfo(String name,
 String value)
                         throws SQLClientInfoException

setClientInfo forwards to the real connection.

Specified by:

setClientInfo in interface Connection

Parameters:

name - the property key String

value - the property value String

Throws:

SQLClientInfoException - if the property is not supported or the real connection could not be obtained.

setClientInfo

public final void setClientInfo(Properties properties)
                         throws SQLClientInfoException

setClientInfo forwards to the real connection. If the call to getRealConnection fails the resulting SQLException is wrapped in a SQLClientInfoException to satisfy the specified signature.

Specified by:

setClientInfo in interface Connection

Parameters:

properties - a Properties object with the properties to set.

Throws:

SQLClientInfoException - if the properties are not supported or the real connection could not be obtained.

getClientInfo

public final String getClientInfo(String name)
                           throws SQLException

getClientInfo forwards to the real connection.

Specified by:

getClientInfo in interface Connection

Parameters:

name - a String that is the property key to get.

Returns:

a String that is returned from the real connection.

Throws:

SQLException - if a database access error occurs.

getClientInfo

public final Properties getClientInfo()
                               throws SQLException

getClientInfo forwards to the real connection.

Specified by:

getClientInfo in interface Connection

Returns:

a Properties object from the real connection.

Throws:

SQLException - if a database access error occurs.

isWrapperFor

public final boolean isWrapperFor(Class<?> iface)
                           throws SQLException

Returns false unless iface is implemented.

Specified by:

isWrapperFor in interface Wrapper

Parameters:

iface - a Class defining an interface.

Returns:

true if this implements the interface or directly or indirectly wraps an object that does.

Throws:

SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.

unwrap

public final <T> T unwrap(Class<T> iface)
                   throws SQLException

Returns this if this class implements the interface.

Specified by:

unwrap in interface Wrapper

Parameters:

iface - a Class defining an interface

Returns:

an object that implements the interface

Throws:

SQLException - if no object if found that implements the interface

statementHoldabilityCheck

final int statementHoldabilityCheck(int resultSetHoldability)
                             throws SQLException

Check the result set holdability when creating a statement object. Section 16.1.3.1 of JDBC 4.0 (proposed final draft) says the driver may change the holdabilty and add a SQLWarning to the Connection object. This work-in-progress implementation throws an exception to match the old behaviour just as part of incremental development.

Throws:

SQLException

getLOBMapping

public Object getLOBMapping(int key)
                     throws SQLException

Get the LOB reference corresponding to the locator.

Specified by:

getLOBMapping in interface EngineConnection

Parameters:

key - the integer that represents the LOB locator value.

Returns:

the LOB Object corresponding to this locator.

Throws:

SQLException

getCurrentSchemaName

public String getCurrentSchemaName()
                            throws SQLException

Obtain the name of the current schema. Not part of the java.sql.Connection interface, but is accessible through the EngineConnection interface, so that the NetworkServer can get at the current schema for piggy-backing

Specified by:

getCurrentSchemaName in interface EngineConnection

Returns:

the current schema name

Throws:

SQLException

resetFromPool

public void resetFromPool()
                   throws SQLException

Description copied from interface: EngineConnection

Resets the connection before it is returned from a PooledConnection to a new application request (wrapped by a BrokeredConnection).

Note that resetting the transaction isolation level is not performed as part of this method. Temporary tables, IDENTITY_VAL_LOCAL and current schema are reset.

Specified by:

resetFromPool in interface EngineConnection

Throws:

SQLException

See Also:

• EngineConnection

getSchema

public String getSchema()
                 throws SQLException

Get the name of the current schema.

Specified by:

getSchema in interface Connection

Specified by:

getSchema in interface EngineConnection

Throws:

SQLException

setSchema

public void setSchema(String schemaName)
               throws SQLException

Set the default schema for the Connection.

Specified by:

setSchema in interface Connection

Specified by:

setSchema in interface EngineConnection

Throws:

SQLException

abort

public void abort(Executor executor)
           throws SQLException

Specified by:

abort in interface Connection

Specified by:

abort in interface EngineConnection

Throws:

SQLException

getNetworkTimeout

public int getNetworkTimeout()
                      throws SQLException

Specified by:

getNetworkTimeout in interface Connection

Specified by:

getNetworkTimeout in interface EngineConnection

Throws:

SQLException

setNetworkTimeout

public void setNetworkTimeout(Executor executor,
 int milliseconds)
                       throws SQLException

Specified by:

setNetworkTimeout in interface Connection

Specified by:

setNetworkTimeout in interface EngineConnection

Throws:

SQLException