AS400JDBCConnectionHandle

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.as400.access
Class AS400JDBCConnectionHandle

java.lang.Object
  |
  +--com.ibm.as400.access.AS400JDBCConnectionHandle

All Implemented Interfaces:: java.sql.Connection

public class AS400JDBCConnectionHandle
extends java.lang.Object
implements java.sql.Connection

The AS400JDBCConnectionHandle class represents an AS400JDBCConnection object that can be used in a AS400JDBCPooledConnection.

Creating a handle to a connection object allows the connection to be reused. The connection handle acts like a normal Connection object and should be closed after an application is done using it so it can be reused.

The following example obtains a connection handle to a pooled connection.


  // Create a data source for making the connection.
  AS400JDBCConnectionPoolDataSource dataSource = new AS400JDBCConnectionPoolDataSource("CheeseDataBase");
  datasource.setServerName("myAS400");
  datasource.setUser("Mickey Mouse");
  datasource.setPassword("IAMNORAT");

  // Get a PooledConnection and get the connection handle to the database.
  AS400JDBCPooledConnection pooledConnection = datasource.getPooledConnection();
  Connection connection = pooledConnection.getConnection();

  ... work with the handle as if it is a normal connection.

  // Close the connection handle to it make available again for reuse.
  connection.close();

Field Summary

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

void clearWarnings()
          Clears all warnings that have been reported for the connection.

void close()
          Closes the handle to the connection.

void commit()
          Commits all changes made since the previous commit or rollback and releases any database locks currently held by the connection.

java.sql.Statement createStatement()
          Creates a Statement object for executing SQL statements without parameters.

java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency)
          Creates a Statement object for executing SQL statements without parameters.

java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Creates a Statement object for executing SQL statements without parameters.

protected void finalize()
          Closes the connection if not explicitly closed by the caller.

boolean getAutoCommit()
          Returns the auto-commit state.

java.lang.String getCatalog()
          Returns the catalog name.

int getHoldability()
          Returns the holdability of ResultSets created from this connection.

java.sql.DatabaseMetaData getMetaData()
          Returns the DatabaseMetaData object that describes the connection's tables, supported SQL grammar, stored procedures, capabilities and more.

java.lang.String getServerJobIdentifier()
          Returns the job identifier of the host server job corresponding to this connection.

int getTransactionIsolation()
          Returns the transaction isolation level.

java.util.Map getTypeMap()
          Returns the type map.

java.sql.SQLWarning getWarnings()
          Returns the first warning reported for the connection.

void invalidate()
          Invalidates the connection.

boolean isClosed()
          Indicates if the connection is closed.

boolean isReadOnly()
          Indicates if the connection is in read-only mode.

java.lang.String nativeSQL(java.lang.String sql)
          Returns the native form of an SQL statement without executing it.

java.sql.CallableStatement prepareCall(java.lang.String sql)
          Precompiles an SQL stored procedure call with optional input and output parameters and stores it in a CallableStatement object.

java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency)
          Precompiles an SQL stored procedure call with optional input and output parameters and stores it in a CallableStatement object.

java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Precompiles an SQL stored procedure call with optional input and output parameters and stores it in a CallableStatement object.

java.sql.PreparedStatement prepareStatement(java.lang.String sql)
          Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.

java.sql.PreparedStatement prepareStatement(java.lang.String sql, int autoGeneratedKeys)
          Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.

java.sql.PreparedStatement prepareStatement(java.lang.String sql, int[] columnIndexes)
          Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.

java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency)
          Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.

java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.

java.sql.PreparedStatement prepareStatement(java.lang.String sql, java.lang.String[] columnNames)
          Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.

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 or rollback and releases any database locks currently held by the connection.

void rollback(java.sql.Savepoint savepoint)
          Undoes all changes made after the specified Savepoint was set.

void setAutoCommit(boolean autoCommit)
          Sets the auto-commit mode.

void setCatalog(java.lang.String catalog)
          This method is not supported.

void setDB2eWLMCorrelator(byte[] bytes)
          Sets the eWLM Correlator.

void setHoldability(int holdability)
          Sets the holdability of ResultSets created from this connection.

void setReadOnly(boolean readOnly)
          Sets the read-only mode.

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 named savepoint in the current transaction and returns the new Savepoint object that represents it.

void setTransactionIsolation(int level)
          Sets the transaction isolation level.

void setTypeMap(java.util.Map typeMap)
          Sets the type map to be used for distinct and structured types.

java.lang.String toString()
          Returns the connection's catalog name.

Methods inherited from class java.lang.Object

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

Method Detail

clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException

Clears all warnings that have been reported for the connection. After this call, getWarnings() returns null until a new warning is reported for the connection.

Specified by:: clearWarnings in interface java.sql.Connection

Throws:: java.sql.SQLException - If an error occurs.

close

public void close()
           throws java.sql.SQLException

Closes the handle to the connection. This does not close the underlying physical connection to the database. The handle is set to an unuseable state.

Specified by:: close in interface java.sql.Connection

Throws:: java.sql.SQLException - If an error occurs.

commit

public void commit()
            throws java.sql.SQLException

Commits all changes made since the previous commit or rollback and releases any database locks currently held by the connection. This has no effect when the connection is in auto-commit mode.

Specified by:: commit in interface java.sql.Connection

Throws:: java.sql.SQLException - If the connection is not open or an error occurs.

createStatement

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

Creates a Statement object for executing SQL statements without parameters. If the same SQL statement is executed many times, it is more efficient to use prepareStatement().

Result sets created using the statement will be type ResultSet.TYPE_FORWARD_ONLY and concurrency ResultSet.CONCUR_READ_ONLY.

Specified by:: createStatement in interface java.sql.Connection

Returns:: The statement object.
Throws:: java.sql.SQLException - If the connection is not open, the maximum number of statements for this connection has been reached, or an error occured.

createStatement

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

Creates a Statement object for executing SQL statements without parameters. If the same SQL statement is executed many times, it is more efficient to use prepareStatement().

Specified by:: createStatement in interface java.sql.Connection

Parameters:

resultSetType - The result set type. Valid values are:

ResultSet.TYPE_FORWARD_ONLY
ResultSet.TYPE_SCROLL_INSENSITIVE
ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - The result set concurrency. Valid values are:

ResultSet.CONCUR_READ_ONLY
ResultSet.CONCUR_UPDATABLE

Returns:

The statement object.

Throws:

java.sql.SQLException - If the connection is not open, the maximum number of statements for this connection has been reached, the result type or currency is not supported, or an error occured.

createStatement

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

Creates a Statement object for executing SQL statements without parameters. If the same SQL statement is executed many times, it is more efficient to use prepareStatement().

Full functionality of this method requires support in OS/400 V5R2 or later. If connecting to a V5R1 or earlier version of OS/400, the value for resultSetHoldability will be ignored.

Specified by:: createStatement in interface java.sql.Connection

Parameters:

resultSetType - The result set type. Valid values are:

ResultSet.TYPE_FORWARD_ONLY
ResultSet.TYPE_SCROLL_INSENSITIVE
ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - The result set concurrency. Valid values are:

ResultSet.CONCUR_READ_ONLY
ResultSet.CONCUR_UPDATABLE

resultSetHoldability - The result set holdability. Valid values are:

ResultSet.HOLD_CURSORS_OVER_COMMIT
ResultSet.CLOSE_CURSORS_AT_COMMIT

Returns:

The statement object.

Throws:

java.sql.SQLException - If the connection is not open, the maximum number of statements for this connection has been reached, the result type, currency, or holdability is not supported, or an error occurs.

Since:

Modification 5

finalize

protected void finalize()
                 throws java.lang.Throwable

Closes the connection if not explicitly closed by the caller.

Overrides:: finalize in class java.lang.Object

Throws:: java.lang.Throwable - If an error occurs.

getAutoCommit

public boolean getAutoCommit()
                      throws java.sql.SQLException

Returns the auto-commit state.

Specified by:: getAutoCommit in interface java.sql.Connection

Returns:: true if the connection is in auto-commit mode; false otherwise.
Throws:: java.sql.SQLException - If the connection is not open.

getCatalog

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

Returns the catalog name.

Specified by:: getCatalog in interface java.sql.Connection

Returns:: The catalog name.
Throws:: java.sql.SQLException - If the connection is not open.

getHoldability

public int getHoldability()
                   throws java.sql.SQLException

Returns the holdability of ResultSets created from this connection.

Specified by:: getHoldability in interface java.sql.Connection

Returns:

The cursor holdability. Valid values are ResultSet.HOLD_CURSORS_OVER_COMMIT and ResultSet.CLOSE_CURSORS_AT_COMMIT. The holdability is derived in this order of precedence:

1. The holdability specified using the method setHoldability(int) if this method was called.
2. The value of the cursor hold driver property.

Full functionality of #1 requires support in OS/400 V5R2 or later. If connecting to a V5R1 or earlier version of OS/400, the value specified on this method will be ignored and the default holdability will be the value of #2.

Throws:

java.sql.SQLException - If the connection is not open.

Since:

Modification 5

getMetaData

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

Returns the DatabaseMetaData object that describes the connection's tables, supported SQL grammar, stored procedures, capabilities and more.

Specified by:: getMetaData in interface java.sql.Connection

Returns:: The metadata object.
Throws:: java.sql.SQLException - If an error occurs.

getServerJobIdentifier

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

Returns the job identifier of the host server job corresponding to this connection. Every JDBC connection is associated with an OS/400 host server job on the server. The format is:

10 character job name
10 character user name
6 character job number

Note: Since this method is not defined in the JDBC Connection interface, you typically need to cast a Connection object returned from PooledConnection.getConnection() to an AS400JDBCConnectionHandle in order to call this method:

  String serverJobIdentifier = ((AS400JDBCConnectionHandle)connection).getServerJobIdentifier();

Returns:: The server job identifier, or null if not known.
Throws:: java.sql.SQLException - If the connection is not open.

getTransactionIsolation

public int getTransactionIsolation()
                            throws java.sql.SQLException

Returns the transaction isolation level.

Specified by:: getTransactionIsolation in interface java.sql.Connection

Returns:

The transaction isolation level. Possible values are:

TRANSACTION_NONE
TRANSACTION_READ_UNCOMMITTED
TRANSACTION_READ_COMMITTED
TRANSACTION_REPEATABLE_READ

Throws:

java.sql.SQLException - If the connection is not open.

getTypeMap

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

Returns the type map.

This driver does not support the type map.

Specified by:: getTypeMap in interface java.sql.Connection

Returns:: The type map.
Throws:: java.sql.SQLException - This exception is always thrown.

getWarnings

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

Returns the first warning reported for the connection. Subsequent warnings may be chained to this warning.

Specified by:: getWarnings in interface java.sql.Connection

Returns:: The first warning or null if no warnings have been reported.
Throws:: java.sql.SQLException - If an error occurs.

invalidate

public void invalidate()

Invalidates the connection.

isClosed

public boolean isClosed()
                 throws java.sql.SQLException

Indicates if the connection is closed.

Specified by:: isClosed in interface java.sql.Connection

Returns:: true if the connection is closed; false otherwise.
Throws:: java.sql.SQLException - If an error occurs.

isReadOnly

public boolean isReadOnly()
                   throws java.sql.SQLException

Indicates if the connection is in read-only mode.

Specified by:: isReadOnly in interface java.sql.Connection

Returns:: true if the connection is in read-only mode; false otherwise.
Throws:: java.sql.SQLException - If the connection is not open.

nativeSQL

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

Returns the native form of an SQL statement without executing it. The JDBC driver converts all SQL statements from the JDBC SQL grammar into the native DB2 UDB for iSeries SQL grammar prior to executing them.

Specified by:: nativeSQL in interface java.sql.Connection

Parameters:: sql - The SQL statement in terms of the JDBC SQL grammar.
Returns:: The translated SQL statement in the native DB2 UDB for iSeries SQL grammar.
Throws:: java.sql.SQLException - If the SQL statement has a syntax error.

prepareCall

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

Precompiles an SQL stored procedure call with optional input and output parameters and stores it in a CallableStatement object. This object can be used to efficiently call the SQL stored procedure multiple times.

Result sets created using the statement will be type ResultSet.TYPE_FORWARD_ONLY and concurrency ResultSet.CONCUR_READ_ONLY.

Specified by:: prepareCall in interface java.sql.Connection

Parameters:: sql - The SQL stored procedure call.
Returns:: The callable statement object.
Throws:: java.sql.SQLException - If the connection is not open, the maximum number of statements for this connection has been reached, or an error occurs.

prepareCall

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

Specified by:: prepareCall in interface java.sql.Connection

Parameters:

sql - The SQL statement.

resultSetType - The result set type. Valid values are:

ResultSet.TYPE_FORWARD_ONLY
ResultSet.TYPE_SCROLL_INSENSITIVE
ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - The result set concurrency. Valid values are:

ResultSet.CONCUR_READ_ONLY
ResultSet.CONCUR_UPDATABLE

Returns:

The prepared statement object.

Throws:

java.sql.SQLException - If the connection is not open, the maximum number of statements for this connection has been reached, the result type or currency is not valid, or an error occurs.

prepareCall

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

Full functionality of this method requires support in OS/400 V5R2 or later. If connecting to a V5R1 or earlier version of OS/400, the value for resultSetHoldability will be ignored.

Specified by:: prepareCall in interface java.sql.Connection

Parameters:

sql - The SQL statement.

resultSetType - The result set type. Valid values are:

ResultSet.TYPE_FORWARD_ONLY
ResultSet.TYPE_SCROLL_INSENSITIVE
ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - The result set concurrency. Valid values are:

ResultSet.CONCUR_READ_ONLY
ResultSet.CONCUR_UPDATABLE

resultSetHoldability - The result set holdability. Valid values are:

ResultSet.HOLD_CURSORS_OVER_COMMIT
ResultSet.CLOSE_CURSORS_AT_COMMIT

Returns:

The prepared statement object.

Throws:

Since:

Modification 5

prepareStatement

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

Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. This object can be used to efficiently execute this SQL statement multiple times.

Result sets created using the statement will be type ResultSet.TYPE_FORWARD_ONLY and concurrency ResultSet.CONCUR_READ_ONLY.

Specified by:: prepareStatement in interface java.sql.Connection

Parameters:: sql - The SQL statement.
Returns:: The prepared statement object.
Throws:: java.sql.SQLException - If the connection is not open, the maximum number of statements for this connection has been reached, or an error occurs.

prepareStatement

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

Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. This object can be used to efficiently execute this SQL statement multiple times.

This method requires OS/400 V5R2 or later. If connecting to a V5R1 or earlier version of OS/400, an exception will be thrown.

Result sets created using the statement will be type ResultSet.TYPE_FORWARD_ONLY and concurrency ResultSet.CONCUR_READ_ONLY.

Specified by:: prepareStatement in interface java.sql.Connection

Parameters:

sql - The SQL statement.

autoGeneratedKeys - Whether to return auto generated keys. Valid values are:

Statement.RETURN_GENERATED_KEYS
Statement.NO_GENERATED_KEYS

Returns:

The prepared statement object.

Throws:

java.sql.SQLException - If the connection is not open, the maximum number of statements for this connection has been reached, if connecting to a V5R1 or earlier version of OS/400, or an error occurs.

Since:

Modification 5

prepareStatement

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

Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. This object can be used to efficiently execute this SQL statement multiple times.

This method is not supported. An SQLException is always thrown.

Specified by:: prepareStatement in interface java.sql.Connection

Parameters:: sql - The SQL statement.; columnIndexes - An array of column indexes indicating the columns that should be returned from the inserted row or rows.
Returns:: An SQLException is always thrown. This method is not supported.
Throws:: java.sql.SQLException - - Always thrown because the Toolbox JDBC driver does does not support this method.
Since:: Modification 5

prepareStatement

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

Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. This object can be used to efficiently execute this SQL statement multiple times.

Specified by:: prepareStatement in interface java.sql.Connection

Parameters:

sql - The SQL statement.

resultSetType - The result set type. Valid values are:

ResultSet.TYPE_FORWARD_ONLY
ResultSet.TYPE_SCROLL_INSENSITIVE
ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - The result set concurrency. Valid values are:

ResultSet.CONCUR_READ_ONLY
ResultSet.CONCUR_UPDATABLE

Returns:

The prepared statement object.

Throws:

java.sql.SQLException - If the connection is not open, the maximum number of statements for this connection has been reached, the result type or currency is not valid, or an error occurs.

prepareStatement

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

Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. This object can be used to efficiently execute this SQL statement multiple times.

Specified by:: prepareStatement in interface java.sql.Connection

Parameters:

sql - The SQL statement.

resultSetType - The result set type. Valid values are:

ResultSet.TYPE_FORWARD_ONLY
ResultSet.TYPE_SCROLL_INSENSITIVE
ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - The result set concurrency. Valid values are:

ResultSet.CONCUR_READ_ONLY
ResultSet.CONCUR_UPDATABLE

resultSetHoldability - The result set holdability. Valid values are:

ResultSet.HOLD_CURSORS_OVER_COMMIT
ResultSet.CLOSE_CURSORS_AT_COMMIT

Returns:

The prepared statement object.

Throws:

prepareStatement

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

Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object. This object can be used to efficiently execute this SQL statement multiple times.

This method is not supported. An SQLException is always thrown.

Specified by:: prepareStatement in interface java.sql.Connection

Parameters:: sql - The SQL statement.; columnNames - An array of column names indicating the columns that should be returned from the inserted row or rows.
Returns:: An SQLException is always thrown. This method is not supported.
Throws:: java.sql.SQLException - - Always thrown because the Toolbox JDBC driver does does not support this method.
Since:: Modification 5

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 has been removed will cause an SQLException to be thrown.

Specified by:: releaseSavepoint in interface java.sql.Connection

Parameters:: savepoint - the savepoint to be removed.
Throws:: java.sql.SQLException - if a database access error occurs or the given Savepoint is not a valid savepoint in the current transaction.
Since:: Modification 5

rollback

public void rollback()
              throws java.sql.SQLException

Drops all changes made since the previous commit or rollback and releases any database locks currently held by the connection. This has no effect when the connection is in auto-commit mode.

Specified by:: rollback in interface java.sql.Connection

Throws:: java.sql.SQLException - If the connection is not open or an error occurs.

rollback

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

Undoes all changes made after the specified Savepoint was set.

Specified by:: rollback in interface java.sql.Connection

Parameters:: savepoint - the savepoint to be rolled back to.
Throws:: java.sql.SQLException - if a database access error occurs, the Savepoint is no longer valid, or this Connection is currently in auto-commit mode.
Since:: Modification 5

setAutoCommit

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

Sets the auto-commit mode. If the connection is in auto-commit mode, then all of its SQL statements are executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by either a commit or rollback.

By default, the connection is in auto-commit mode. The commit occurs when the statement execution completes or the next statement execute occurs, whichever comes first. In the case of statements returning a result set, the statement execution completes when the last row of the result set has been retrieved or the result set 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 parameter values have been retrieved.

Specified by:: setAutoCommit in interface java.sql.Connection

Parameters:: autoCommit - true to turn on auto-commit mode, false to turn it off.
Throws:: java.sql.SQLException - If the connection is not open or an error occurs.

setDB2eWLMCorrelator

public void setDB2eWLMCorrelator(byte[] bytes)
                          throws java.sql.SQLException

Sets the eWLM Correlator. It is assumed a valid correlator value is used. If the value is null, all ARM/eWLM implementation will be turned off. eWLM correlators require OS/400 V5R3 or later servers. This request is ignored when running to OS/400 V5R2 or earlier servers.

Parameters:: bytes - The eWLM correlator value; java.sql.SQLException

setCatalog

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

This method is not supported.

Specified by:: setCatalog in interface java.sql.Connection

Throws:: java.sql.SQLException - If the connection is not open.

setHoldability

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

Sets the holdability of ResultSets created from this connection.

Full functionality of this method requires OS/400 V5R2 or later. If connecting to a V5R1 or earlier version of OS/400, all cursors for the connection will be changed to the value of the variable holdability.

Specified by:: setHoldability in interface java.sql.Connection

Parameters:: holdability - The cursor holdability. Valid values are ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT.
Throws:: java.sql.SQLException - If the connection is not open or the value passed in is not valid.
Since:: Modification 5

setReadOnly

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

Sets the read-only mode. This will provide read-only access to the database. Read-only mode can be useful by enabling certain database optimizations. If the caller specified "read only" or "read call" for the "access" property, then the read-only mode cannot be set to false. The read-only mode cannot be changed while in the middle of a transaction.

Specified by:: setReadOnly in interface java.sql.Connection

Parameters:: readOnly - true to set the connection to read-only mode; false to set the connection to read-write mode.
Throws:: java.sql.SQLException - If the connection is not open, a transaction is active, or the "access" property is set to "read only".

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.

Named savepoints must be unique. A savepoint name cannot be reused until the savepoint is released, committed, or rolled back.
Savepoints are valid only if autocommit is off. An exception is thrown if autocommit is enabled.
Savepoints are not valid across XA connections. An exception is thrown if the connection is an XA connection.
Savepoints require OS/400 V5R2 or later. An exception is thrown if connecting to a V5R1 or earlier version of OS/400.
If the connection option is set to keep cursors open after a traditional rollback, cursors will remain open after a rollback to a savepoint.

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:: Modification 5

setSavepoint

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

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

Named savepoints must be unique. A savepoint name cannot be reused until the savepoint is released, committed, or rolled back.
Savepoints are valid only if autocommit is off. An exception is thrown if autocommit is enabled.
Savepoints are not valid across XA connections. An exception is thrown if the connection is an XA connection.
Savepoints require OS/400 V5R2 or later. An exception is thrown if connecting to a V5R1 or earlier version of OS/400.
If the connection option is set to keep cursors open after a traditional rollback, cursors will remain open after a rollback to a savepoint.

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:: Modification 5

setTransactionIsolation

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

Sets the transaction isolation level. The transaction isolation level cannot be changed while in the middle of a transaction.

JDBC and DB2 UDB for iSeries use different terminology for transaction isolation levels. The following table provides a terminology mapping:

AS/400 or iSeries isolation level JDBC transaction isolation level

*CHG TRANSACTION_READ_UNCOMMITTED

*CS TRANSACTION_READ_COMMITTED

*ALL TRANSACTION_READ_REPEATABLE_READ

*RR TRANSACTION_SERIALIZABLE

AS/400 or iSeries isolation level	JDBC transaction isolation level
*CHG	TRANSACTION_READ_UNCOMMITTED
*CS	TRANSACTION_READ_COMMITTED
*ALL	TRANSACTION_READ_REPEATABLE_READ
*RR	TRANSACTION_SERIALIZABLE

Specified by:: setTransactionIsolation in interface java.sql.Connection

Parameters:

level - The transaction isolation level. Possible values are:

TRANSACTION_READ_UNCOMMITTED
TRANSACTION_READ_COMMITTED
TRANSACTION_REPEATABLE_READ
TRANSACTION_SERIALIZABLE

Throws:

java.sql.SQLException - If the connection is not open, the input level is not valid or unsupported, or a transaction is active.

setTypeMap

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

Sets the type map to be used for distinct and structured types.

Note: Distinct types are supported by DB2 UDB for iSeries, but are not externalized by the IBM Toolbox for Java JDBC driver. In other words, distinct types behave as if they are the underlying type. Structured types are not supported by DB2 UDB for iSeries. Consequently, this driver does not support the type map.

Specified by:: setTypeMap in interface java.sql.Connection

Parameters:: typeMap - The type map.
Throws:: java.sql.SQLException - This exception is always thrown.

toString

public java.lang.String toString()

Returns the connection's catalog name. This is the name of the server.

Overrides:: toString in class java.lang.Object

Returns:: The catalog name.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Method Summary
`void`	`clearWarnings()` Clears all warnings that have been reported for the connection.
`void`	`close()` Closes the handle to the connection.
`void`	`commit()` Commits all changes made since the previous commit or rollback and releases any database locks currently held by the connection.
`java.sql.Statement`	`createStatement()` Creates a Statement object for executing SQL statements without parameters.
`java.sql.Statement`	`createStatement(int resultSetType, int resultSetConcurrency)` Creates a Statement object for executing SQL statements without parameters.
`java.sql.Statement`	`createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)` Creates a Statement object for executing SQL statements without parameters.
`protected void`	`finalize()` Closes the connection if not explicitly closed by the caller.
`boolean`	`getAutoCommit()` Returns the auto-commit state.
`java.lang.String`	`getCatalog()` Returns the catalog name.
`int`	`getHoldability()` Returns the holdability of ResultSets created from this connection.
`java.sql.DatabaseMetaData`	`getMetaData()` Returns the DatabaseMetaData object that describes the connection's tables, supported SQL grammar, stored procedures, capabilities and more.
`java.lang.String`	`getServerJobIdentifier()` Returns the job identifier of the host server job corresponding to this connection.
`int`	`getTransactionIsolation()` Returns the transaction isolation level.
`java.util.Map`	`getTypeMap()` Returns the type map.
`java.sql.SQLWarning`	`getWarnings()` Returns the first warning reported for the connection.
`void`	`invalidate()` Invalidates the connection.
`boolean`	`isClosed()` Indicates if the connection is closed.
`boolean`	`isReadOnly()` Indicates if the connection is in read-only mode.
`java.lang.String`	`nativeSQL(java.lang.String sql)` Returns the native form of an SQL statement without executing it.
`java.sql.CallableStatement`	`prepareCall(java.lang.String sql)` Precompiles an SQL stored procedure call with optional input and output parameters and stores it in a CallableStatement object.
`java.sql.CallableStatement`	`prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency)` Precompiles an SQL stored procedure call with optional input and output parameters and stores it in a CallableStatement object.
`java.sql.CallableStatement`	`prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)` Precompiles an SQL stored procedure call with optional input and output parameters and stores it in a CallableStatement object.
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql)` Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql, int autoGeneratedKeys)` Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql, int[] columnIndexes)` Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency)` Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)` Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql, java.lang.String[] columnNames)` Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`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 or rollback and releases any database locks currently held by the connection.
`void`	`rollback(java.sql.Savepoint savepoint)` Undoes all changes made after the specified Savepoint was set.
`void`	`setAutoCommit(boolean autoCommit)` Sets the auto-commit mode.
`void`	`setCatalog(java.lang.String catalog)` This method is not supported.
`void`	`setDB2eWLMCorrelator(byte[] bytes)` Sets the eWLM Correlator.
`void`	`setHoldability(int holdability)` Sets the holdability of ResultSets created from this connection.
`void`	`setReadOnly(boolean readOnly)` Sets the read-only mode.
`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 named savepoint in the current transaction and returns the new Savepoint object that represents it.
`void`	`setTransactionIsolation(int level)` Sets the transaction isolation level.
`void`	`setTypeMap(java.util.Map typeMap)` Sets the type map to be used for distinct and structured types.
`java.lang.String`	`toString()` Returns the connection's catalog name.

com.ibm.as400.access Class AS400JDBCConnectionHandle

clearWarnings

close

commit

createStatement

createStatement

createStatement

finalize

getAutoCommit

getCatalog

getHoldability

getMetaData

getServerJobIdentifier

getTransactionIsolation

getTypeMap

getWarnings

invalidate

isClosed

isReadOnly

nativeSQL

prepareCall

prepareCall

prepareCall

prepareStatement

prepareStatement

prepareStatement

prepareStatement

prepareStatement

prepareStatement

releaseSavepoint

rollback

rollback

setAutoCommit

setDB2eWLMCorrelator

setCatalog

setHoldability

setReadOnly

setSavepoint

setSavepoint

setTransactionIsolation

setTypeMap

toString

com.ibm.as400.access
Class AS400JDBCConnectionHandle