org.objectweb.cjdbc.driver
Class Connection

java.lang.Object
  org.objectweb.cjdbc.driver.Connection

All Implemented Interfaces:

java.sql.Connection

public class Connection

extends java.lang.Object

implements java.sql.Connection

This Connection class implements a virtual connection that is just used to store the needed information when the real connection will have to be established by the Controller to execute a query.

This code has been inspired from the PostgreSQL JDBC driver by Peter T. Mount.

Version:

1.0

Author:

Emmanuel Cecchet, Julie Marguerite , Vadim Kassin, Duncan Smith, Nicolas Modrzyk

Field Summary

protected boolean	autoCommit Commit mode of the connection (true= automatic).
protected Driver	driver Driver that created us.
protected java.sql.SQLWarning	firstWarning List of Warnings for this connection.
protected boolean	isClosed Status of the connection.
protected int	isolationLevel Isolation level.
private static int	MAX_RECONNECT_ATTEMPTS
protected DatabaseMetaData	metaData Meta-data of C-JDBC connections.
protected boolean	needSqlSkeleton Does the controller require the SQL skeleton?
private int	objectsOnStream
protected boolean	readOnly Is the connection in read-only mode ?
private int	reconnectRetries
protected java.net.Socket	socket Connection with the controller.
protected java.io.ObjectInputStream	socketInput Socket input stream.
protected java.io.ObjectOutputStream	socketOutput Socket output stream.
private static int	STREAM_GC_LIMIT
protected int	transactionId transaction identifier.
protected java.lang.String	url C-JDBC URL of the database.
protected VirtualDatabaseUser	vdbUser Virtual database user used for this connection.

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Connection()
Creates a new Connection instance.

Connection(Driver driver, java.net.Socket socket, java.io.ObjectInputStream in, java.io.ObjectOutputStream out, java.lang.String url, VirtualDatabaseUser virtualDatabaseUser, boolean sqlSkeletonNeeded)
Creates a new Connection instance.

Method Summary

void	clearWarnings() After this call, getWarnings() returns null until a new warning is reported for this connection.
void	close() Releases the connection.
void	commit() Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection.
java.sql.Statement	createStatement() SQL statements without parameters are normally executed using Statement objects.
java.sql.Statement	createStatement(int resultSetType, int resultSetConcurrency) SQL statements without parameters are normally executed using Statement objects.
java.sql.Statement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.
protected java.sql.ResultSet	execReadRequest(SelectRequest request) Performs a read request and return the reply.
java.sql.ResultSet	execReadStoredProcedure(StoredProcedure proc) Call a stored procedure that returns a ResultSet.
protected int	execWriteRequest(AbstractWriteRequest request) Performs a write request and return the number of rows affected.
protected java.sql.ResultSet	execWriteRequestWithKeys(AbstractWriteRequest request) Performs a write request and return the number of rows affected.
protected int	execWriteStoredProcedure(StoredProcedure proc) Call a stored procedure that performs an update.
protected void	finalize()
boolean	getAutoCommit() Gets the current auto-commit state.
java.lang.String	getCatalog() C-JDBC does NOT handle catalogs.
protected java.sql.ResultSet	getColumns(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern, java.lang.String columnNamePattern)
java.lang.String	getControllerVersionNumber() Get the C-JDBC controller version number.
int	getHoldability() Retrieves the current holdability of ResultSet objects created using this Connection object.
java.sql.DatabaseMetaData	getMetaData() A connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, etc.
java.lang.String	getPassword() Gets the password used to login to the database.
protected java.sql.ResultSet	getPrimaryKeys(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern)
protected java.sql.ResultSet	getProcedureColumns(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedureNamePattern, java.lang.String columnNamePattern)
protected java.sql.ResultSet	getProcedures(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String procedureNamePattern)
protected java.sql.ResultSet	getTables(java.lang.String catalog, java.lang.String schemaPattern, java.lang.String tableNamePattern, java.lang.String[] types)
int	getTransactionIsolation() Gets this Connection's current transaction isolation mode.
java.util.Map	getTypeMap() C-JDBC does NOT support type map.
java.lang.String	getURL() Gets the C-JDBC URL of the database of the connection.
java.lang.String	getUserName() Gets the user name used to login to the database.
java.sql.SQLWarning	getWarnings() The first warning reported by calls on this connection is returned.
boolean	isClosed() Returns true if the connection is closed (no real meaning from C-JDBC point of view)
boolean	isReadOnly() Tests to see if the connection is in read only Mode.
java.lang.String	nativeSQL(java.lang.String query) As we can't know for sure which database will execute this request (now or later), we can't translate it in the native query language of the underlying DBMS.
java.sql.CallableStatement	prepareCall(java.lang.String sql) Creates a CallableStatement that contains sql and produces a ResultSet that is TYPE_SCROLL_INSENSITIVE and CONCUR_READ_ONLY.
java.sql.CallableStatement	prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency) Stored procedure call are not yet supported by C-JDBC.
java.sql.CallableStatement	prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
java.sql.PreparedStatement	prepareStatement(java.lang.String sql) A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object.
java.sql.PreparedStatement	prepareStatement(java.lang.String sql, int autoGeneratedKeys) Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys.
java.sql.PreparedStatement	prepareStatement(java.lang.String sql, int[] columnIndexes) Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
java.sql.PreparedStatement	prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency) A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object.
java.sql.PreparedStatement	prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.
java.sql.PreparedStatement	prepareStatement(java.lang.String sql, java.lang.String[] columnNames) Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
private void	reconnect()
void	releaseSavepoint(java.sql.Savepoint savepoint) Removes the given Savepoint object from the current transaction.
void	rollback() Drops all changes made since the previous commit/rollback and releases any database locks currently held by this connection.
void	rollback(java.sql.Savepoint savepoint) Undoes all changes made after the given Savepoint object was set.
void	setAutoCommit(boolean autoCommit) If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions.
void	setCatalog(java.lang.String catalog) C-JDBC does NOT support catalogs.
protected void	setConnectionParametersOnRequest(AbstractRequest request) Set the login, transaction id and autocommit mode on this request.
void	setHoldability(int holdability) Changes the holdability of ResultSet objects created using this Connection object to the given holdability.
void	setReadOnly(boolean readOnly) You can put a connection in read-only mode as a hint to enable database optimizations Note: setReadOnly cannot be called while in the middle of a transaction
java.sql.Savepoint	setSavepoint() Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.
java.sql.Savepoint	setSavepoint(java.lang.String name) Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.
void	setTransactionIsolation(int level) You can call this method to try to change the transaction isolation level using one of the TRANSACTION_* values.
void	setTypeMap(java.util.Map map) C-JDBC does NOT support type map.

Methods inherited from class java.lang.Object

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

Field Detail

autoCommit

protected boolean autoCommit

Commit mode of the connection (true= automatic).

isClosed

protected boolean isClosed

Status of the connection.

readOnly

protected boolean readOnly

Is the connection in read-only mode ?

isolationLevel

protected int isolationLevel

Isolation level.

transactionId

protected int transactionId

transaction identifier.

needSqlSkeleton

protected boolean needSqlSkeleton

Does the controller require the SQL skeleton?

firstWarning

protected java.sql.SQLWarning firstWarning

List of Warnings for this connection.

metaData

protected DatabaseMetaData metaData

Meta-data of C-JDBC connections.

driver

protected Driver driver

Driver that created us.

url

protected java.lang.String url

C-JDBC URL of the database.

vdbUser

protected VirtualDatabaseUser vdbUser

Virtual database user used for this connection.

socket

protected java.net.Socket socket

Connection with the controller.

socketInput

protected java.io.ObjectInputStream socketInput

Socket input stream.

socketOutput

protected java.io.ObjectOutputStream socketOutput

Socket output stream.

STREAM_GC_LIMIT

private static final int STREAM_GC_LIMIT

See Also:

Constant Field Values

objectsOnStream

private int objectsOnStream

reconnectRetries

private int reconnectRetries

MAX_RECONNECT_ATTEMPTS

private static final int MAX_RECONNECT_ATTEMPTS

See Also:

Constant Field Values

Constructor Detail

Connection

public Connection()

Creates a new Connection instance.

Connection

public Connection(Driver driver,
                  java.net.Socket socket,
                  java.io.ObjectInputStream in,
                  java.io.ObjectOutputStream out,
                  java.lang.String url,
                  VirtualDatabaseUser virtualDatabaseUser,
                  boolean sqlSkeletonNeeded)

Creates a new Connection instance.

Parameters:

driver - calling driver

socket - connection with the controller

in - socket input stream

out - socket output stream

url - C-JDBC URL of the database

virtualDatabaseUser - user login/password

sqlSkeletonNeeded - true if SQL skeletons must be sent to the controller

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Throws:

java.lang.Throwable

See Also:

Object.finalize()

getURL

public java.lang.String getURL()

Gets the C-JDBC URL of the database of the connection.

Returns:

value of url.

getUserName

public java.lang.String getUserName()

Gets the user name used to login to the database.

Returns:

login name

getPassword

public java.lang.String getPassword()

Gets the password used to login to the database.

Returns:

password

clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException

After this call, getWarnings() returns null until a new warning is reported for this connection.

Specified by:

clearWarnings in interface java.sql.Connection

Throws:

java.sql.SQLException - if a database access error occurs

close

public void close()
           throws java.sql.SQLException

Releases the connection. In fact, the connection is marked to be released but will be effectively closed by the ConnectionClosingThread if the connection has not been reused before.

Specified by:

close in interface java.sql.Connection

Throws:

java.sql.SQLException - if an error occurs

commit

public void commit()
            throws java.sql.SQLException

Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection. This method should only be used when auto-commit has been disabled. (If autoCommit==true, then we just return anyhow)

Specified by:

commit in interface java.sql.Connection

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

setAutoCommit(boolean)

createStatement

public java.sql.Statement createStatement()
                                   throws java.sql.SQLException

SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it is more efficient to use a PreparedStatement. The ResultSet will be TYPE_FORWARD_ONLY/CONCUR_READ_ONLY. *

Specified by:

createStatement in interface java.sql.Connection

Returns:

a new Statement object

Throws:

java.sql.SQLException - passed through from the constructor

createStatement

public java.sql.Statement createStatement(int resultSetType,
                                          int resultSetConcurrency)
                                   throws java.sql.SQLException

SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it is more efficient to use a PreparedStatement.

Specified by:

createStatement in interface java.sql.Connection

Parameters:

resultSetType - resultSetType to use

resultSetConcurrency - resultSetConcurrency to use

Returns:

a new Statement object

Throws:

java.sql.SQLException - passed through from the constructor

getAutoCommit

public boolean getAutoCommit()
                      throws java.sql.SQLException

Gets the current auto-commit state.

Specified by:

getAutoCommit in interface java.sql.Connection

Returns:

current state of the auto-commit mode

Throws:

java.sql.SQLException - (why?)

See Also:

setAutoCommit(boolean)

getCatalog

public java.lang.String getCatalog()
                            throws java.sql.SQLException

C-JDBC does NOT handle catalogs.

Specified by:

getCatalog in interface java.sql.Connection

Returns:

null

Throws:

java.sql.SQLException - if a database access error occurs

getMetaData

public java.sql.DatabaseMetaData getMetaData()
                                      throws java.sql.SQLException

A connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, etc. This information is made available through a DatabaseMetaData object.

Specified by:

getMetaData in interface java.sql.Connection

Returns:

a DatabaseMetaData object for this connection

Throws:

java.sql.SQLException - if a database access error occurs

getProcedures

protected java.sql.ResultSet getProcedures(java.lang.String catalog,
                                           java.lang.String schemaPattern,
                                           java.lang.String procedureNamePattern)
                                    throws java.sql.SQLException

Throws:

java.sql.SQLException

getProcedureColumns

protected java.sql.ResultSet getProcedureColumns(java.lang.String catalog,
                                                 java.lang.String schemaPattern,
                                                 java.lang.String procedureNamePattern,
                                                 java.lang.String columnNamePattern)
                                          throws java.sql.SQLException

Throws:

java.sql.SQLException

getTransactionIsolation

public int getTransactionIsolation()
                            throws java.sql.SQLException

Gets this Connection's current transaction isolation mode.

Specified by:

getTransactionIsolation in interface java.sql.Connection

Returns:

the current TRANSACTION_* mode value

Throws:

java.sql.SQLException - if a database access error occurs

getTypeMap

public java.util.Map getTypeMap()
                         throws java.sql.SQLException

C-JDBC does NOT support type map.

Specified by:

getTypeMap in interface java.sql.Connection

Returns:

an exception

Throws:

java.sql.SQLException - not supported

getWarnings

public java.sql.SQLWarning getWarnings()
                                throws java.sql.SQLException

The first warning reported by calls on this connection is returned. Note: Sebsequent warnings will be changed to this SQLWarning

Specified by:

getWarnings in interface java.sql.Connection

Returns:

the first SQLWarning or null

Throws:

java.sql.SQLException - if a database access error occurs

isClosed

public boolean isClosed()
                 throws java.sql.SQLException

Returns true if the connection is closed (no real meaning from C-JDBC point of view)

Specified by:

isClosed in interface java.sql.Connection

Returns:

true if connection has never been opened or close() has been called

Throws:

java.sql.SQLException - if an error occurs

isReadOnly

public boolean isReadOnly()
                   throws java.sql.SQLException

Tests to see if the connection is in read only Mode. Note that we cannot really put the database in read only mode, but we pretend we can by returning the value of the readOnly flag.

Specified by:

isReadOnly in interface java.sql.Connection

Returns:

true if the connection is read only

Throws:

java.sql.SQLException - if a database access error occurs

nativeSQL

public java.lang.String nativeSQL(java.lang.String query)
                           throws java.sql.SQLException

As we can't know for sure which database will execute this request (now or later), we can't translate it in the native query language of the underlying DBMS. Therefore the query is returned unchanged.

Specified by:

nativeSQL in interface java.sql.Connection

Parameters:

query - the query to change

Returns:

the original query

Throws:

java.sql.SQLException - never

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql)
                                       throws java.sql.SQLException

Creates a CallableStatement that contains sql and produces a ResultSet that is TYPE_SCROLL_INSENSITIVE and CONCUR_READ_ONLY.

Specified by:

prepareCall in interface java.sql.Connection

Parameters:

sql - SQL request

Returns:

nothing

Throws:

java.sql.SQLException - not supported

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency)
                                       throws java.sql.SQLException

Stored procedure call are not yet supported by C-JDBC.

Specified by:

prepareCall in interface java.sql.Connection

Parameters:

sql - a String value

resultSetType - an int value

resultSetConcurrency - an int value

Returns:

nothing

Throws:

java.sql.SQLException - not supported

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql)
                                            throws java.sql.SQLException

A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Specified by:

prepareStatement in interface java.sql.Connection

Parameters:

sql - a SQL statement that may contain one or more '?' IN * parameter placeholders

Returns:

a new PreparedStatement object containing the pre-compiled statement.

Throws:

java.sql.SQLException - if a database access error occurs.

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency)
                                            throws java.sql.SQLException

A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Specified by:

prepareStatement in interface java.sql.Connection

Parameters:

sql - a SQL statement that may contain one or more '?' IN

resultSetType - ResultSetType to use

resultSetConcurrency - ResultSetConcurrency to use

Returns:

a new PreparedStatement object

Throws:

java.sql.SQLException - passed through from the constructor

rollback

public void rollback()
              throws java.sql.SQLException

Drops all changes made since the previous commit/rollback and releases any database locks currently held by this connection.

Specified by:

rollback in interface java.sql.Connection

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

commit()

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws java.sql.SQLException

If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by either commit()or rollback(). By default, new connections are in auto-commit mode. The commit occurs when the statement completes or the next execute occurs, whichever comes first. In the case of statements returning a ResultSet, the statement completes when the last row of the ResultSet has been retrieved or the ResultSet has been closed. In advanced cases, a single statement may return multiple results as well as output parameter values. Here the commit occurs when all results and output param values have been retrieved.

Specified by:

setAutoCommit in interface java.sql.Connection

Parameters:

autoCommit - true enables auto-commit; false disables it

Throws:

java.sql.SQLException - if a database access error occurs

setCatalog

public void setCatalog(java.lang.String catalog)
                throws java.sql.SQLException

C-JDBC does NOT support catalogs. Therefore this method is empty and does not do anything.

Specified by:

setCatalog in interface java.sql.Connection

Parameters:

catalog - a String value

Throws:

java.sql.SQLException - not supported

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws java.sql.SQLException

You can put a connection in read-only mode as a hint to enable database optimizations

Note: setReadOnly cannot be called while in the middle of a transaction

Specified by:

setReadOnly in interface java.sql.Connection

Parameters:

readOnly - true enables read-only mode; false disables it

Throws:

java.sql.SQLException - if a database access error occurs

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws java.sql.SQLException

You can call this method to try to change the transaction isolation level using one of the TRANSACTION_* values.

Note: this method cannot be called while in the middle of a transaction.

Specified by:

setTransactionIsolation in interface java.sql.Connection

Parameters:

level - one of the TRANSACTION_* isolation values with * the exception of TRANSACTION_NONE; some databases may * not support other values

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

DatabaseMetaData.supportsTransactionIsolationLevel(int)

setTypeMap

public void setTypeMap(java.util.Map map)
                throws java.sql.SQLException

C-JDBC does NOT support type map.

Specified by:

setTypeMap in interface java.sql.Connection

Parameters:

map - ignored

Throws:

java.sql.SQLException - not supported

setConnectionParametersOnRequest

protected void setConnectionParametersOnRequest(AbstractRequest request)

Set the login, transaction id and autocommit mode on this request.

Parameters:

request - The request to set

execReadRequest

protected java.sql.ResultSet execReadRequest(SelectRequest request)
                                      throws java.sql.SQLException

Performs a read request and return the reply.

Parameters:

request - the read request to execute

Returns:

a java.sql.ResultSet value

Throws:

java.sql.SQLException - if an error occurs

reconnect

private void reconnect()
                throws java.sql.SQLException

Throws:

java.sql.SQLException

execWriteRequest

protected int execWriteRequest(AbstractWriteRequest request)
                        throws java.sql.SQLException

Performs a write request and return the number of rows affected.

Parameters:

request - the write request to execute

Returns:

number of rows affected

Throws:

java.sql.SQLException - if an error occurs

execWriteRequestWithKeys

protected java.sql.ResultSet execWriteRequestWithKeys(AbstractWriteRequest request)
                                               throws java.sql.SQLException

Performs a write request and return the number of rows affected.

Parameters:

request - the write request to execute

Returns:

auto generated keys

Throws:

java.sql.SQLException - if an error occurs

execReadStoredProcedure

public java.sql.ResultSet execReadStoredProcedure(StoredProcedure proc)
                                           throws java.sql.SQLException

Call a stored procedure that returns a ResultSet.

Parameters:

proc - the stored procedure call

Returns:

a java.sql.ResultSet value

Throws:

java.sql.SQLException - if an error occurs

execWriteStoredProcedure

protected int execWriteStoredProcedure(StoredProcedure proc)
                                throws java.sql.SQLException

Call a stored procedure that performs an update.

Parameters:

proc - the stored procedure call

Returns:

number of rows affected

Throws:

java.sql.SQLException - if an error occurs

getColumns

protected java.sql.ResultSet getColumns(java.lang.String catalog,
                                        java.lang.String schemaPattern,
                                        java.lang.String tableNamePattern,
                                        java.lang.String columnNamePattern)
                                 throws java.sql.SQLException

Throws:

java.sql.SQLException

getPrimaryKeys

protected java.sql.ResultSet getPrimaryKeys(java.lang.String catalog,
                                            java.lang.String schemaPattern,
                                            java.lang.String tableNamePattern)
                                     throws java.sql.SQLException

Throws:

java.sql.SQLException

See Also:

java.sql.DatabaseMetadata#getPrimaryKeys

getTables

protected java.sql.ResultSet getTables(java.lang.String catalog,
                                       java.lang.String schemaPattern,
                                       java.lang.String tableNamePattern,
                                       java.lang.String[] types)
                                throws java.sql.SQLException

Throws:

java.sql.SQLException

See Also:

DatabaseMetaData.getTables(String, String, String, String[])

getControllerVersionNumber

public java.lang.String getControllerVersionNumber()
                                            throws java.sql.SQLException

Get the C-JDBC controller version number.

Returns:

a String containing the controller version

Throws:

java.sql.SQLException - if an error occurs

setHoldability

public void setHoldability(int holdability)
                    throws java.sql.SQLException

Changes the holdability of ResultSet objects created using this Connection object to the given holdability.

Specified by:

setHoldability in interface java.sql.Connection

Parameters:

holdability - a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Throws:

java.sql.SQLException - if a database access occurs, the given parameter is not a ResultSet constant indicating holdability, or the given holdability is not supported

Since:

JDK 1.4

See Also:

getHoldability(), ResultSet

getHoldability

public int getHoldability()
                   throws java.sql.SQLException

Retrieves the current holdability of ResultSet objects created using this Connection object.

Specified by:

getHoldability in interface java.sql.Connection

Returns:

the holdability, one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Throws:

java.sql.SQLException - if a database access occurs

Since:

JDK 1.4

See Also:

setHoldability(int), ResultSet

setSavepoint

public java.sql.Savepoint setSavepoint()
                                throws java.sql.SQLException

Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.

Specified by:

setSavepoint in interface java.sql.Connection

Returns:

the new Savepoint object

Throws:

java.sql.SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode

Since:

JDK 1.4

See Also:

Savepoint

setSavepoint

public java.sql.Savepoint setSavepoint(java.lang.String name)
                                throws java.sql.SQLException

Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.

Specified by:

setSavepoint in interface java.sql.Connection

Parameters:

name - a String containing the name of the savepoint

Returns:

the new Savepoint object

Throws:

java.sql.SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode

Since:

JDK 1.4

See Also:

Savepoint

rollback

public void rollback(java.sql.Savepoint savepoint)
              throws java.sql.SQLException

Undoes all changes made after the given Savepoint object was set.

This method should be used only when auto-commit has been disabled.

Specified by:

rollback in interface java.sql.Connection

Parameters:

savepoint - the Savepoint object to roll back to

Throws:

java.sql.SQLException - if a database access error occurs, the Savepoint object is no longer valid, or this Connection object is currently in auto-commit mode

Since:

JDK 1.4

See Also:

Savepoint, rollback()

releaseSavepoint

public void releaseSavepoint(java.sql.Savepoint savepoint)
                      throws java.sql.SQLException

Removes the given Savepoint object from the current transaction. Any reference to the savepoint after it have been removed will cause an SQLException to be thrown.

Specified by:

releaseSavepoint in interface java.sql.Connection

Parameters:

savepoint - the Savepoint object to be removed

Throws:

java.sql.SQLException - if a database access error occurs or the given Savepoint object is not a valid savepoint in the current transaction

Since:

JDK 1.4

createStatement

public java.sql.Statement createStatement(int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
                                   throws java.sql.SQLException

Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.

This method is the same as the createStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:

createStatement in interface java.sql.Connection

Parameters:

resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Returns:

a new Statement object that will generate ResultSet objects with the given type, concurrency, and holdability

Throws:

java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

Since:

JDK 1.4

See Also:

ResultSet

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency,
                                                   int resultSetHoldability)
                                            throws java.sql.SQLException

Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.

This method is the same as the prepareStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:

prepareStatement in interface java.sql.Connection

Parameters:

sql - a String object that is the SQL statement to be sent to the database; may contain one or more ? IN parameters

resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Returns:

a new PreparedStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability

Throws:

java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

Since:

JDK 1.4

See Also:

ResultSet

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency,
                                              int resultSetHoldability)
                                       throws java.sql.SQLException

Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type, result set concurrency type and holdability to be overridden.

Specified by:

prepareCall in interface java.sql.Connection

Parameters:

sql - a String object that is the SQL statement to be sent to the database; may contain on or more ? parameters

resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT

Returns:

a new CallableStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability

Throws:

java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability

Since:

JDK 1.4

See Also:

ResultSet

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int autoGeneratedKeys)
                                            throws java.sql.SQLException

Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys. The given constant tells the driver whether it should make auto-generated keys available for retrieval. This parameter is ignored if the SQL statement is not an INSERT statement.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:

prepareStatement in interface java.sql.Connection

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS

Returns:

a new PreparedStatement object, containing the pre-compiled SQL statement, that will have the capability of returning auto-generated keys

Throws:

java.sql.SQLException - if a database access error occurs or the given parameter is not a Statement constant indicating whether auto-generated keys should be returned

Since:

JDK 1.4

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int[] columnIndexes)
                                            throws java.sql.SQLException

Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. This array is ignored if the SQL statement is not an INSERT statement.

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:

prepareStatement in interface java.sql.Connection

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

columnIndexes - an array of column indexes indicating the columns that should be returned from the inserted row or rows

Returns:

a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column indexes

Throws:

java.sql.SQLException - if a database access error occurs

Since:

JDK 1.4

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   java.lang.String[] columnNames)
                                            throws java.sql.SQLException

Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the names of the columns in the target table that contain the auto-generated keys that should be returned. This array is ignored if the SQL statement is not an INSERT statement.

An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

Specified by:

prepareStatement in interface java.sql.Connection

Parameters:

sql - an SQL statement that may contain one or more '?' IN parameter placeholders

columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows

Returns:

a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column names

Throws:

java.sql.SQLException - if a database access error occurs

Since:

JDK 1.4