|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.sapjcosupport.jdbc.SapConnection
Implements an SQL connection for SAP.
Field Summary |
Fields inherited from interface java.sql.Connection |
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE |
Constructor Summary | |
SapConnection(com.sap.mw.jco.JCO.Client nativeConnection,
com.sap.mw.jco.IRepository functionRepository)
|
Method Summary | |
void |
clearWarnings()
Clears all warnings reported for this SapConnection object.
|
void |
close()
Releases a SapConnection's database and JDBC resources immediately instead of waiting for them to be automatically released. |
void |
commit()
Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the SapConnection. |
Statement |
createStatement()
Creates a SapQLStatement object for sending
SQL statements to the database.
|
Statement |
createStatement(int resultSetType,
int resultSetConcurrency)
Creates a SapQLStatement object that will generate
ResultSet objects with the given type and concurrency.
|
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 void |
finalize()
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |
boolean |
getAutoCommit()
Gets the current auto-commit state. |
String |
getCatalog()
Returns the Connection's current catalog name. |
com.sap.mw.jco.IRepository |
getFunctionRepository()
|
int |
getHoldability()
Retrieves the current holdability of ResultSet objects
created using this Connection object. |
DatabaseMetaData |
getMetaData()
Gets the metadata regarding this connection's database. |
com.sap.mw.jco.JCO.Client |
getNativeConnection()
|
int |
getTransactionIsolation()
Gets this SapConnection's current transaction isolation level. |
Map |
getTypeMap()
Gets the type map object associated with this connection. |
SQLWarning |
getWarnings()
Returns the first warning reported by calls on this SapConnection. |
boolean |
isClosed()
Tests to see if a SapConnection is closed. |
boolean |
isReadOnly()
Tests to see if the connection is in read-only mode. |
String |
nativeSQL(String sql)
Converts the given SQL statement into the system's native SQL grammar. |
CallableStatement |
prepareCall(String sql)
Creates a CallableStatement object for calling
database stored procedures.
|
CallableStatement |
prepareCall(String sql,
int resultSetType,
int resultSetConcurrency)
Creates a CallableStatement object that will generate
ResultSet objects with the given type and concurrency.
|
CallableStatement |
prepareCall(String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability)
Creates a CallableStatement object that will generate
ResultSet objects with the given type and concurrency.
|
PreparedStatement |
prepareStatement(String sql)
Creates a PreparedStatement object for sending
parameterized SQL statements to the database.
|
PreparedStatement |
prepareStatement(String sql,
int autoGeneratedKeys)
Creates a default PreparedStatement object that has
the capability to retrieve auto-generated keys. |
PreparedStatement |
prepareStatement(String sql,
int[] columnIndexes)
Creates a default PreparedStatement object capable
of returning the auto-generated keys designated by the given array.
|
PreparedStatement |
prepareStatement(String sql,
int resultSetType,
int resultSetConcurrency)
Creates a PreparedStatement object that will generate
ResultSet objects with the given type and concurrency.
|
PreparedStatement |
prepareStatement(String sql,
int resultSetType,
int resultSetConcurrency,
int resultSetHoldability)
Creates a PreparedStatement object that will generate
ResultSet objects with the given type, concurrency,
and holdability.
|
PreparedStatement |
prepareStatement(String sql,
String[] columnNames)
Creates a default PreparedStatement object capable
of returning the auto-generated keys designated by the given array.
|
void |
releaseSavepoint(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 SapConnection. |
void |
rollback(Savepoint savepoint)
Undoes all changes made after the given Savepoint object
was set.
|
void |
setAutoCommit(boolean autoCommit)
Sets this connection's auto-commit mode. |
void |
setCatalog(String catalog)
Sets a catalog name in order to select a subspace of this SapConnection's database in which to work. |
void |
setHoldability(int holdability)
Changes the holdability of ResultSet objects
created using this Connection object to the given
holdability. |
void |
setReadOnly(boolean readOnly)
Puts this connection in read-only mode as a hint to enable database optimizations. |
Savepoint |
setSavepoint()
Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it. |
Savepoint |
setSavepoint(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)
Attempts to change the transaction isolation level to the one given. |
void |
setTypeMap(Map map)
Installs the given type map as the type map for this connection. |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SapConnection(com.sap.mw.jco.JCO.Client nativeConnection, com.sap.mw.jco.IRepository functionRepository)
Method Detail |
public com.sap.mw.jco.JCO.Client getNativeConnection()
public com.sap.mw.jco.IRepository getFunctionRepository()
public Statement createStatement() throws SQLException
SapQLStatement
object for sending
SQL statements to the database.
SQL statements without parameters are normally
executed using SapQLStatement objects. If the same SQL statement
is executed many times, it is more efficient to use a
PreparedStatement
object.
Result sets created using the returned SapQLStatement
object will by default have forward-only type and read-only concurrency.
createStatement
in interface Connection
SQLException
- if a database access error occurspublic PreparedStatement prepareStatement(String sql) throws SQLException
PreparedStatement
object for sending
parameterized SQL statements to the database.
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.
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
is
executed. This has no direct effect on users; however, it does
affect which method throws certain SQLExceptions.
Result sets created using the returned PreparedStatement will have forward-only type and read-only concurrency, by default.
prepareStatement
in interface Connection
sql
- a SQL statement that may contain one or more '?' IN
parameter placeholders
SQLException
- if a database access error occurspublic CallableStatement prepareCall(String sql) throws SQLException
CallableStatement
object for calling
database stored procedures.
The CallableStatement
object provides
methods for setting up its IN and OUT parameters, and
methods for executing the call to a stored procedure.
Note: This method is optimized for handling stored
procedure call statements. Some drivers may send the call
statement to the database when the method prepareCall
is done; others
may wait until the CallableStatement
object
is executed. This has no
direct effect on users; however, it does affect which method
throws certain SQLExceptions.
Result sets created using the returned CallableStatement will have forward-only type and read-only concurrency, by default.
prepareCall
in interface Connection
sql
- a SQL statement that may contain one or more '?'
parameter placeholders. Typically this statement is a JDBC
function call escape string.
SQLException
- if a database access error occurspublic String nativeSQL(String sql) throws SQLException
nativeSQL
in interface Connection
sql
- a SQL statement that may contain one or more '?'
parameter placeholders
SQLException
- if a database access error occurspublic void setAutoCommit(boolean autoCommit) throws SQLException
commit
or the method 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. In these cases the commit occurs when all results and output parameter values have been retrieved.
setAutoCommit
in interface Connection
autoCommit
- true enables auto-commit; false disables
auto-commit.
SQLException
- if a database access error occurspublic boolean getAutoCommit() throws SQLException
getAutoCommit
in interface Connection
SQLException
- if a database access error occurssetAutoCommit(boolean)
public void commit() throws SQLException
commit
in interface Connection
SQLException
- if a database access error occurssetAutoCommit(boolean)
public void rollback() throws SQLException
rollback
in interface Connection
SQLException
- if a database access error occurssetAutoCommit(boolean)
public void close() throws SQLException
Note: A Connection is automatically closed when it is garbage collected. Certain fatal errors also result in a closed Connection.
close
in interface Connection
SQLException
- if a database access error occursprotected void finalize() throws Throwable
finalize
method to dispose of
system resources or to perform other cleanup.
The general contract of finalize is that it is invoked if and when the JavaTM virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.
The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.
The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.
After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.
The finalize method is never invoked more than once by a Java virtual machine for any given object.
Any exception thrown by the finalize
method causes
the finalization of this object to be halted, but is otherwise
ignored.
Throwable
- the Exception
raised by this methodpublic boolean isClosed() throws SQLException
isClosed
in interface Connection
SQLException
- if a database access error occurspublic DatabaseMetaData getMetaData() throws SQLException
getMetaData
in interface Connection
SQLException
- if a database access error occurspublic void setReadOnly(boolean readOnly) throws SQLException
Note: This method cannot be called while in the middle of a transaction.
setReadOnly
in interface Connection
readOnly
- true enables read-only mode; false disables
read-only mode.
SQLException
- if a database access error occurspublic boolean isReadOnly() throws SQLException
isReadOnly
in interface Connection
SQLException
- if a database access error occurspublic void setCatalog(String catalog) throws SQLException
setCatalog
in interface Connection
SQLException
- if a database access error occurspublic String getCatalog() throws SQLException
getCatalog
in interface Connection
SQLException
- if a database access error occurspublic void setTransactionIsolation(int level) throws SQLException
Connection
are the possible transaction isolation levels.
Note: This method cannot be called while in the middle of a transaction.
setTransactionIsolation
in interface Connection
level
- one of the TRANSACTION_* isolation values with the
exception of TRANSACTION_NONE; some databases may not support
other values
SQLException
- if a database access error occursDatabaseMetaData.supportsTransactionIsolationLevel(int)
public int getTransactionIsolation() throws SQLException
getTransactionIsolation
in interface Connection
SQLException
- if a database access error occurspublic SQLWarning getWarnings() throws SQLException
Note: Subsequent warnings will be chained to this SQLWarning.
getWarnings
in interface Connection
SQLException
- if a database access error occurspublic void clearWarnings() throws SQLException
SapConnection
object.
After a call to this method, the method getWarnings
returns null until a new warning is
reported for this SapConnection.
clearWarnings
in interface Connection
SQLException
- if a database access error occurspublic Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException
SapQLStatement
object that will generate
ResultSet
objects with the given type and concurrency.
This method is the same as the createStatement
method
above, but it allows the default result set
type and result set concurrency type to be overridden.
createStatement
in interface Connection
resultSetType
- a result set type; see ResultSet.TYPE_XXXresultSetConcurrency
- a concurrency type; see ResultSet.CONCUR_XXX
SQLException
- if a database access error occurspublic PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
PreparedStatement
object that will generate
ResultSet
objects with the given type and concurrency.
This method is the same as the prepareStatement
method
above, but it allows the default result set
type and result set concurrency type to be overridden.
prepareStatement
in interface Connection
resultSetType
- a result set type; see ResultSet.TYPE_XXXresultSetConcurrency
- a concurrency type; see ResultSet.CONCUR_XXX
SQLException
- if a database access error occurspublic CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
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 and result set concurrency type to be overridden.
prepareCall
in interface Connection
resultSetType
- a result set type; see ResultSet.TYPE_XXXresultSetConcurrency
- a concurrency type; see ResultSet.CONCUR_XXX
SQLException
- if a database access error occurspublic Map getTypeMap() throws SQLException
getTypeMap
in interface Connection
java.util.Map
object associated
with this SapConnection
object
SQLException
public void setTypeMap(Map map) throws SQLException
setTypeMap
in interface Connection
map
- the java.util.Map
object to install
as the replacement for this SapConnection
object's default type map
SQLException
public int getHoldability() throws SQLException
ResultSet
objects
created using this Connection
object.
getHoldability
in interface Connection
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
SQLException
- if a database access occurssetHoldability(int)
,
ResultSet
public void setHoldability(int holdability) throws SQLException
ResultSet
objects
created using this Connection
object to the given
holdability.
setHoldability
in interface Connection
holdability
- a ResultSet
holdability constant; one of
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
SQLException
- if a database access occurs, the given parameter
is not a ResultSet
constant indicating holdability,
or the given holdability is not supportedgetHoldability()
,
ResultSet
public Savepoint setSavepoint() throws SQLException
Savepoint
object that represents it.
setSavepoint
in interface Connection
Savepoint
object
SQLException
- if a database access error occurs
or this Connection
object is currently in
auto-commit modeSavepoint
public void releaseSavepoint(Savepoint savepoint) throws SQLException
Savepoint
object from the current
transaction. Any reference to the savepoint after it have been removed
will cause an SQLException
to be thrown.
releaseSavepoint
in interface Connection
savepoint
- the Savepoint
object to be removed
SQLException
- if a database access error occurs or
the given Savepoint
object is not a valid
savepoint in the current transactionpublic void rollback(Savepoint savepoint) throws SQLException
Savepoint
object
was set.
This method should be used only when auto-commit has been disabled.
rollback
in interface Connection
savepoint
- the Savepoint
object to roll back to
SQLException
- if a database access error occurs,
the Savepoint
object is no longer valid,
or this Connection
object is currently in
auto-commit modeSavepoint
,
rollback()
public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
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.
createStatement
in interface Connection
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
Statement
object that will generate
ResultSet
objects with the given type,
concurrency, and holdability
SQLException
- if a database access error occurs
or the given parameters are not ResultSet
constants indicating type, concurrency, and holdabilityResultSet
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
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.
prepareCall
in interface Connection
sql
- a String
object that is the SQL statement to
be sent to the database; may contain on or more ? parametersresultSetType
- 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
CallableStatement
object, containing the
pre-compiled SQL statement, that will generate
ResultSet
objects with the given type,
concurrency, and holdability
SQLException
- if a database access error occurs
or the given parameters are not ResultSet
constants indicating type, concurrency, and holdabilityResultSet
public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException
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
.
prepareStatement
in interface Connection
sql
- an SQL statement that may contain one or more '?' IN
parameter placeholdersautoGeneratedKeys
- a flag indicating whether auto-generated keys
should be returned; one of
Statement.RETURN_GENERATED_KEYS
or
Statement.NO_GENERATED_KEYS
PreparedStatement
object, containing the
pre-compiled SQL statement, that will have the capability of
returning auto-generated keys
SQLException
- if a database access error occurs
or the given parameter is not a Statement
constant indicating whether auto-generated keys should be
returnedpublic PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
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.
prepareStatement
in interface Connection
sql
- a String
object that is the SQL statement to
be sent to the database; may contain one or more ? IN
parametersresultSetType
- 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
PreparedStatement
object, containing the
pre-compiled SQL statement, that will generate
ResultSet
objects with the given type,
concurrency, and holdability
SQLException
- if a database access error occurs
or the given parameters are not ResultSet
constants indicating type, concurrency, and holdabilityResultSet
public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException
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
.
prepareStatement
in interface Connection
sql
- an SQL statement that may contain one or more '?' IN
parameter placeholderscolumnIndexes
- an array of column indexes indicating the columns
that should be returned from the inserted row or rows
PreparedStatement
object, containing the
pre-compiled statement, that is capable of returning the
auto-generated keys designated by the given array of column
indexes
SQLException
- if a database access error occurspublic Savepoint setSavepoint(String name) throws SQLException
Savepoint
object that represents it.
setSavepoint
in interface Connection
name
- a String
containing the name of the savepoint
Savepoint
object
SQLException
- if a database access error occurs
or this Connection
object is currently in
auto-commit modeSavepoint
public PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException
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
.
prepareStatement
in interface Connection
sql
- an SQL statement that may contain one or more '?' IN
parameter placeholderscolumnNames
- an array of column names indicating the columns
that should be returned from the inserted row or rows
PreparedStatement
object, containing the
pre-compiled statement, that is capable of returning the
auto-generated keys designated by the given array of column
names
SQLException
- if a database access error occurs
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |