AS400JDBCConnectionRedirect (JTOpen 20.0.7 API)

java.lang.Object
- com.ibm.as400.access.AS400JDBCConnection
- - com.ibm.as400.access.AS400JDBCConnectionRedirect

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper
```
public class AS400JDBCConnectionRedirect
extends AS400JDBCConnection
```
The AS400JDBCConnectionRedirect class provide a level of indirection above AS400JDBCConnections. The goal is to be able to switch to use an alternative server if the existing server becomes unavailable. This class is only used if enableClientAffinitiesList is set to 1.

Field Summary

Fields
Modifier and Type Field Description

static int SEAMLESS_RETRY_COUNT
- Fields inherited from class com.ibm.as400.access.AS400JDBCConnection
  inFinalizer_
- Fields inherited from interface java.sql.Connection
  TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Fields
Modifier and Type	Field	Description
`static int`	`SEAMLESS_RETRY_COUNT`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`abort(Executor executor)`	Terminates an open connection.
`void`	`cancel(int id)`
`void`	`checkAccess(JDSQLStatement sqlStatement)`
`void`	`checkCancel()`
`boolean`	`checkHoldabilityConstants(int holdability)`
`void`	`checkOpen()`
`void`	`clearWarnings()`	Clears all warnings that have been reported for the connection.
`void`	`close()`	Releases the connection's resources immediately instead of waiting for them to be automatically released.
`void`	`commit()`	Commits all changes made since the previous commit or rollback and releases any database locks currently held by the connection.
`int`	`correctResultSetType(int resultSetType, int resultSetConcurrency)`
`Array`	`createArrayOf(String typeName, Object[] elements)`	Factory method for creating Array objects.
`Blob`	`createBlob()`	Constructs an object that implements the `Blob` interface.
`Clob`	`createClob()`	Constructs an object that implements the `Clob` interface.
`NClob`	`createNClob()`	Constructs an object that implements the `NClob` interface.
`SQLXML`	`createSQLXML()`	Constructs an object that implements the `SQLXML` interface.
`Statement`	`createStatement()`	Creates a Statement object for executing SQL statements without parameters.
`Statement`	`createStatement(int resultSetType, int resultSetConcurrency)`	Creates a Statement object for executing SQL statements without parameters.
`Statement`	`createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)`	Creates a Statement object for executing SQL statements without parameters.
`Struct`	`createStruct(String typeName, Object[] attributes)`	Factory method for creating Struct objects.
`void`	`debug(com.ibm.as400.access.DBBaseRequestDS request)`
`void`	`debug(com.ibm.as400.access.DBReplyRequestedDS reply)`
`boolean`	`doUpdateDeleteBlocking()`
`void`	`dumpStatementCreationLocation()`
`void`	`finalize()`
`com.ibm.as400.access.AS400Impl`	`getAS400()`
`boolean`	`getAutoCommit()`	Returns the auto-commit state.
`String`	`getCatalog()`	Returns the catalog name.
`boolean`	`getCheckStatementHoldability()`
`Properties`	`getClientInfo()`	Returns a list containing the name and current value of each client info property supported by the driver.
`String`	`getClientInfo(String name)`	Returns the value of the client info property specified by name.
`int`	`getConcurrentAccessResolution()`	This method returns the concurrent access resolution setting.
`ConvTable`	`getConverter()`
`ConvTable`	`getConverter(int ccsid)`
`int`	`getDataCompression()`
`String`	`getDefaultSchema()`
`String`	`getDefaultSchema(boolean returnRawValue)`
`int`	`getHoldability()`	Returns the holdability of ResultSets created from this connection.
`int`	`getID()`
`int`	`getInternalHoldability()`
`String`	`getLastServerSQLState()`
`int`	`getMaximumBlockedInputRows()`
`DatabaseMetaData`	`getMetaData()`	Returns the DatabaseMetaData object that describes the connection's tables, supported SQL grammar, stored procedures, capabilities and more.
`boolean`	`getMustSpecifyForUpdate()`
`int`	`getNetworkTimeout()`	Retrieves the number of milliseconds the driver will wait for a database request to complete.
`ConvTable`	`getPackageCCSID_Converter()`
`JDProperties`	`getProperties()`	Returns the connection properties.
`boolean`	`getReadOnly()`
`String[]`	`getReconnectURLs()`	Returns a String array containing the URLs that are used when to reconnect to a system when the "enableClientAffinities" property is set.
`String`	`getSchema()`	Retrieves this `Connection` object's current schema name.
`int`	`getServerFunctionalLevel()`
`String`	`getServerJobIdentifier()`	Returns the job identifier of the host server job corresponding to this connection.
`AS400`	`getSystem()`	Returns the system object which is managing the connection to the system.
`int`	`getTransactionIsolation()`	Returns the transaction isolation level.
`com.ibm.as400.access.JDTransactionManager`	`getTransactionManager()`
`Map`	`getTypeMap()`	Returns the type map.
`int`	`getUnusedId(int resultSetType)`
`String`	`getURL()`
`String`	`getUserName()`
`String[]`	`getValidWrappedList()`
`int`	`getVRM()`
`SQLWarning`	`getWarnings()`	Returns the first warning reported for the connection.
`void`	`handleAbort()`
`boolean`	`ignoreWarning(String sqlState)`
`boolean`	`ignoreWarning(SQLWarning warning)`
`boolean`	`isClosed()`	Indicates if the connection is closed.
`boolean`	`isCursorNameUsed(String cursorName)`
`boolean`	`isQueryTimeoutMechanismCancel()`
`boolean`	`isReadOnly()`	Indicates if the connection is in read-only mode.
`boolean`	`isReadOnlyAccordingToProperties()`
`boolean`	`isValid(int timeout)`	Returns true if the connection has not been closed and is still valid.
`boolean`	`isWrapperFor(Class<?> iface)`	Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
`String`	`makeGeneratedKeySelectStatement(String sql)`
`String`	`makeGeneratedKeySelectStatement(String sql, int[] columnIndexes, String[] columnNames)`
`void`	`markCursorsClosed(boolean isRollback)`
`void`	`markStatementsClosed()`
`String`	`nativeSQL(String sql)`	Returns the native form of an SQL statement without executing it.
`void`	`notifyClose(AS400JDBCStatement statement, int id)`
`void`	`postWarning(int id, int errorCode, int returnCode)`
`void`	`postWarningSQLState(String sqlState)`
`CallableStatement`	`prepareCall(String sql)`	Precompiles an SQL stored procedure call with optional input and output parameters and stores it in a CallableStatement object.
`CallableStatement`	`prepareCall(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.
`CallableStatement`	`prepareCall(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.
`PreparedStatement`	`prepareStatement(String sql)`	Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`PreparedStatement`	`prepareStatement(String sql, int autoGeneratedKeys)`	Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`PreparedStatement`	`prepareStatement(String sql, int[] columnIndexes)`	Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`PreparedStatement`	`prepareStatement(String sql, int resultSetType, int resultSetConcurrency)`	Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`PreparedStatement`	`prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)`	Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`PreparedStatement`	`prepareStatement(String sql, String[] columnNames)`	Precompiles an SQL statement with optional input parameters and stores it in a PreparedStatement object.
`void`	`processSavepointRequest(String savepointStatement)`
`void`	`pseudoClose()`
`com.ibm.as400.access.DBReplyRequestedDS`	`receiveMoreData()`
`void`	`releaseSavepoint(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(Savepoint savepoint)`	Undoes all changes made after the specified Savepoint was set.
`void`	`send(com.ibm.as400.access.DBBaseRequestDS request)`
`void`	`send(com.ibm.as400.access.DBBaseRequestDS request, int id)`
`void`	`send(com.ibm.as400.access.DBBaseRequestDS request, int id, boolean leavePending)`
`void`	`sendAndHold(com.ibm.as400.access.DBBaseRequestDS request, int id)`
`com.ibm.as400.access.DBReplyRequestedDS`	`sendAndMultiReceive(com.ibm.as400.access.DBBaseRequestDS request)`
`com.ibm.as400.access.DBReplyRequestedDS`	`sendAndReceive(com.ibm.as400.access.DBBaseRequestDS request)`
`com.ibm.as400.access.DBReplyRequestedDS`	`sendAndReceive(com.ibm.as400.access.DBBaseRequestDS request, int id)`
`void`	`setAutoCommit(boolean autoCommit)`	Sets the auto-commit mode.
`void`	`setCatalog(String catalog)`	This method is not supported.
`void`	`setCheckStatementHoldability(boolean check)`
`void`	`setClientInfo(String name, String value)`	Sets the value of the client info property specified by name to the value specified by value.
`void`	`setClientInfo(Properties properties)`	Sets the value of the connection's client info properties.
`void`	`setConcurrentAccessResolution(int concurrentAccessResolution)`	This method sets concurrent access resolution.
`void`	`setDB2eWLMCorrelator(byte[] bytes)`	Sets the eWLM Correlator.
`void`	`setDBHostServerTrace(boolean trace)`	Starts or stops the Database Host Server trace for this connection.
`void`	`setDisableCompression(boolean disableCompression_)`
`void`	`setDRDA(boolean drda)`
`void`	`setHoldability(int holdability)`	Sets the holdability of ResultSets created from this connection.
`void`	`setLastServerSQLState(String lastSqlState)`
`void`	`setNetworkTimeout(int timeout)`	Sets the maximum period a Connection or objects created from the Connection will wait for the database to reply to any one request.
`void`	`setNetworkTimeout(Executor executor, int milliseconds)`	Sets the maximum period a Connection or objects created from the Connection will wait for the database to reply to any one request.
`void`	`setProperties(JDDataSourceURL dataSourceUrl, JDProperties properties, AS400 as400)`
`void`	`setProperties(JDDataSourceURL dataSourceUrl, JDProperties properties, com.ibm.as400.access.AS400Impl as400)`
`void`	`setProperties(JDDataSourceURL dataSourceUrl, JDProperties properties, com.ibm.as400.access.AS400Impl as400, boolean newServer, boolean skipSignonServer)`
`void`	`setReadOnly(boolean readOnly)`	Sets the read-only mode.
`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 named savepoint in the current transaction and returns the new Savepoint object that represents it.
`Savepoint`	`setSavepoint(String name, int id)`
`void`	`setSchema(String schema)`	Sets the given schema name to access.
`void`	`setServerAttributes()`
`void`	`setSystem(AS400 as400)`
`void`	`setTransactionIsolation(int level)`	Sets the transaction isolation level.
`void`	`setTypeMap(Map typeMap)`	Sets the type map to be used for distinct and structured types.
`void`	`setupVariableFieldCompression()`
`boolean`	`testDataTruncation(AS400JDBCStatement statementWarningObject, AS400JDBCResultSet resultSetWarningObject, int parameterIndex, boolean isParameter, com.ibm.as400.access.SQLData data, JDSQLStatement sqlStatement)`
`String`	`toString()`	Returns the connection's catalog name.
`<T> T`	`unwrap(Class<T> iface)`	Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.
`boolean`	`useExtendedFormats()`
`boolean`	`useVariableFieldCompression()`
`boolean`	`useVariableFieldInsertCompression()`

Methods inherited from class com.ibm.as400.access.AS400JDBCConnection
setInFinalizer

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.sql.Connection
beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid

Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap

Field Detail
- SEAMLESS_RETRY_COUNT
```
public static final int SEAMLESS_RETRY_COUNT
```
  See Also:
  
  Constant Field Values

Method Detail

cancel

public void cancel(int id)
            throws SQLException

Throws:: SQLException

checkAccess

public void checkAccess(JDSQLStatement sqlStatement)
                 throws SQLException

Throws:: SQLException

checkCancel
```
public void checkCancel()
```

checkHoldabilityConstants

public boolean checkHoldabilityConstants(int holdability)

checkOpen

public void checkOpen()
               throws SQLException

Throws:: SQLException

clearWarnings
```
public void clearWarnings()
                   throws SQLException
```
Description copied from class: AS400JDBCConnection

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 Connection

Specified by:

clearWarnings in class AS400JDBCConnection

Throws:

SQLException - If an error occurs.

close
```
public void close()
           throws SQLException
```
Description copied from class: AS400JDBCConnection

Releases the connection's resources immediately instead of waiting for them to be automatically released. This rolls back any active transactions, closes all statements that are running in the context of the connection, and disconnects from the IBM i system.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Specified by:

close in class AS400JDBCConnection

Throws:

SQLException - If an error occurs.

handleAbort
```
public void handleAbort()
```

commit
```
public void commit()
            throws SQLException
```
Description copied from class: AS400JDBCConnection

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.
This method can not be called when the connection is part of a distributed transaction. See AS400JDBCXAResource for more information.

Specified by:

commit in interface Connection

Specified by:

commit in class AS400JDBCConnection

Throws:

SQLException - If the connection is not open or an error occurs.

setCheckStatementHoldability

public void setCheckStatementHoldability(boolean check)

correctResultSetType

public int correctResultSetType(int resultSetType,
                                int resultSetConcurrency)
                         throws SQLException

Throws:: SQLException

createStatement
```
public Statement createStatement()
                          throws SQLException
```
Description copied from class: AS400JDBCConnection

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 Connection

Specified by:

createStatement in class AS400JDBCConnection

Returns:

The statement object.

Throws:

SQLException - If the connection is not open, the maximum number of statements for this connection has been reached, or an error occurs.

createStatement
```
public Statement createStatement(int resultSetType,
                                 int resultSetConcurrency)
                          throws SQLException
```
Description copied from class: AS400JDBCConnection

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 Connection

Specified by:

createStatement in class AS400JDBCConnection

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:

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 occurs.

createStatement
```
public Statement createStatement(int resultSetType,
                                 int resultSetConcurrency,
                                 int resultSetHoldability)
                          throws SQLException
```
Description copied from class: AS400JDBCConnection

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 IBM i. If connecting to OS/400 V5R1 or earlier, the value for resultSetHoldability will be ignored.
Specified by:

createStatement in interface Connection

Specified by:

createStatement in class AS400JDBCConnection

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:

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.

debug

public void debug(com.ibm.as400.access.DBBaseRequestDS request)

debug

public void debug(com.ibm.as400.access.DBReplyRequestedDS reply)

getAS400

public com.ibm.as400.access.AS400Impl getAS400()
                                        throws SQLException

Throws:: SQLException

getAutoCommit
```
public boolean getAutoCommit()
                      throws SQLException
```
Description copied from class: AS400JDBCConnection

Returns the auto-commit state.

Specified by:

getAutoCommit in interface Connection

Specified by:

getAutoCommit in class AS400JDBCConnection

Returns:

true if the connection is in auto-commit mode; false otherwise.

Throws:

SQLException - If the connection is not open.

getCatalog
```
public String getCatalog()
                  throws SQLException
```
Description copied from class: AS400JDBCConnection

Returns the catalog name.

Specified by:

getCatalog in interface Connection

Specified by:

getCatalog in class AS400JDBCConnection

Returns:

The catalog name.

Throws:

SQLException - If the connection is not open.

getConcurrentAccessResolution
```
public int getConcurrentAccessResolution()
```
Description copied from class: AS400JDBCConnection

This method returns the concurrent access resolution setting. This method has no effect on IBM i V6R1 or earlier. The possible values for this property are AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET, AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED, AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME and AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS, with the property defaulting to AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET. Setting this property to default exhibits the default behavior on the servers i.e., the semantic applied for read transactions to avoid locks will be determined by the server. AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED specifies that driver will flow USE CURRENTLY COMMITTED to server. Whether CURRENTLY COMMITTED will actually be in effect is ultimately determined by server. AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME specifies that driver will flow WAIT FOR OUTCOME to server. This will disable the CURRENTLY COMMITTED behavior at the server, if enabled, and the server will wait for the commit or rollback of data in the process of being updated. AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS specifies that driver will flow SKIP LOCKS to server. This directs the database manager to skip records in the case of record lock conflicts.

Specified by:

getConcurrentAccessResolution in class AS400JDBCConnection

Returns:

The concurrent access resolution setting. Possible return valuse: AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET, AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED, AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME, or AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS

getConverter

public ConvTable getConverter(int ccsid)
                       throws SQLException

Throws:: SQLException

getDataCompression
```
public int getDataCompression()
```

getDefaultSchema

public String getDefaultSchema()
                        throws SQLException

Throws:: SQLException

getDefaultSchema

public String getDefaultSchema(boolean returnRawValue)
                        throws SQLException

Throws:: SQLException

getHoldability
```
public int getHoldability()
                   throws SQLException
```
Description copied from class: AS400JDBCConnection

Returns the holdability of ResultSets created from this connection.
Specified by:

getHoldability in interface Connection

Specified by:

getHoldability in class AS400JDBCConnection

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 IBM i. If connecting to OS/400 V5R1 or earlier, the value specified on this method will be ignored and the default holdability will be the value of #2.
Throws:

SQLException - If the connection is not open.

getID
```
public int getID()
```

getInternalHoldability
```
public int getInternalHoldability()
```

getMetaData
```
public DatabaseMetaData getMetaData()
                             throws SQLException
```
Description copied from class: AS400JDBCConnection

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

Specified by:

getMetaData in interface Connection

Specified by:

getMetaData in class AS400JDBCConnection

Returns:

The metadata object.

Throws:

SQLException - If an error occurs.

getProperties
```
public JDProperties getProperties()
                           throws SQLException
```
Description copied from class: AS400JDBCConnection

Returns the connection properties.

Specified by:

getProperties in class AS400JDBCConnection

Returns:

The connection properties.

Throws:

SQLException - If a database error occurs.

getServerJobIdentifier
```
public String getServerJobIdentifier()
```
Description copied from class: AS400JDBCConnection
Returns the job identifier of the host server job corresponding to this connection. Every JDBC connection is associated with a host server job on the IBM i system. 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 to AS400JDBCConnection in order to call this method:
```
    String serverJobIdentifier = ((AS400JDBCConnection)connection).getServerJobIdentifier();
    
```
Specified by:

getServerJobIdentifier in class AS400JDBCConnection

Returns:

The server job identifier, or null if not known.

getServerFunctionalLevel
```
public int getServerFunctionalLevel()
```

getSystem
```
public AS400 getSystem()
```
Description copied from class: AS400JDBCConnection
Returns the system object which is managing the connection to the system.
Note: Since this method is not defined in the JDBC Connection interface, you typically need to cast a Connection object to AS400JDBCConnection in order to call this method:
```
    AS400 system = ((AS400JDBCConnection)connection).getSystem();
    
```
Specified by:

getSystem in class AS400JDBCConnection

Returns:

The system.

getTransactionIsolation
```
public int getTransactionIsolation()
                            throws SQLException
```
Description copied from class: AS400JDBCConnection

Returns the transaction isolation level.
Specified by:

getTransactionIsolation in interface Connection

Specified by:

getTransactionIsolation in class AS400JDBCConnection

Returns:
The transaction isolation level. Possible values are:
- TRANSACTION_NONE
- TRANSACTION_READ_UNCOMMITTED
- TRANSACTION_READ_COMMITTED
- TRANSACTION_REPEATABLE_READ
Throws:

SQLException - If the connection is not open.

getTransactionManager

public com.ibm.as400.access.JDTransactionManager getTransactionManager()

getTypeMap
```
public Map getTypeMap()
               throws SQLException
```
Description copied from class: AS400JDBCConnection

Returns the type map.
This driver does not support the type map.

Specified by:

getTypeMap in interface Connection

Specified by:

getTypeMap in class AS400JDBCConnection

Returns:

The type map.

Throws:

SQLException - This exception is always thrown.

getUnusedId

public int getUnusedId(int resultSetType)
                throws SQLException

Throws:: SQLException

getMustSpecifyForUpdate

public boolean getMustSpecifyForUpdate()

getURL

public String getURL()
              throws SQLException

Throws:: SQLException

getUserName

public String getUserName()
                   throws SQLException

Throws:: SQLException

getVRM

public int getVRM()
           throws SQLException

Throws:: SQLException

getWarnings
```
public SQLWarning getWarnings()
                       throws SQLException
```
Description copied from class: AS400JDBCConnection

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

Specified by:

getWarnings in interface Connection

Specified by:

getWarnings in class AS400JDBCConnection

Returns:

The first warning or null if no warnings have been reported.

Throws:

SQLException - If an error occurs.

isCursorNameUsed

public boolean isCursorNameUsed(String cursorName)
                         throws SQLException

Throws:: SQLException

isClosed
```
public boolean isClosed()
                 throws SQLException
```
Description copied from class: AS400JDBCConnection

Indicates if the connection is closed.

Specified by:

isClosed in interface Connection

Specified by:

isClosed in class AS400JDBCConnection

Returns:

true if the connection is closed; false otherwise.

Throws:

SQLException - If an error occurs.

isReadOnly
```
public boolean isReadOnly()
                   throws SQLException
```
Description copied from class: AS400JDBCConnection

Indicates if the connection is in read-only mode.

Specified by:

isReadOnly in interface Connection

Specified by:

isReadOnly in class AS400JDBCConnection

Returns:

true if the connection is in read-only mode; false otherwise.

Throws:

SQLException - If the connection is not open.

isReadOnlyAccordingToProperties

public boolean isReadOnlyAccordingToProperties()
                                        throws SQLException

Throws:: SQLException

markCursorsClosed

public void markCursorsClosed(boolean isRollback)
                       throws SQLException

Throws:: SQLException

markStatementsClosed
```
public void markStatementsClosed()
```

makeGeneratedKeySelectStatement

public String makeGeneratedKeySelectStatement(String sql,
                                              int[] columnIndexes,
                                              String[] columnNames)
                                       throws SQLException

Throws:: SQLException

makeGeneratedKeySelectStatement

public String makeGeneratedKeySelectStatement(String sql)
                                       throws SQLException

Throws:: SQLException

nativeSQL
```
public String nativeSQL(String sql)
                 throws SQLException
```
Description copied from class: AS400JDBCConnection

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 for IBM i SQL grammar prior to executing them.

Specified by:

nativeSQL in interface Connection

Specified by:

nativeSQL in class AS400JDBCConnection

Parameters:

sql - The SQL statement in terms of the JDBC SQL grammar.

Returns:

The translated SQL statement in the native DB2 for IBM i SQL grammar.

Throws:

SQLException - If the SQL statement has a syntax error.

notifyClose

public void notifyClose(AS400JDBCStatement statement,
                        int id)
                 throws SQLException

Throws:: SQLException

postWarningSQLState

public void postWarningSQLState(String sqlState)
                         throws SQLException

Throws:: SQLException

postWarning

public void postWarning(int id,
                        int errorCode,
                        int returnCode)
                 throws SQLException

Throws:: SQLException

prepareCall
```
public CallableStatement prepareCall(String sql)
                              throws SQLException
```
Description copied from class: AS400JDBCConnection

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 Connection

Specified by:

prepareCall in class AS400JDBCConnection

Parameters:

sql - The SQL stored procedure call.

Returns:

The callable statement object.

Throws:

SQLException - If the connection is not open, the maximum number of statements for this connection has been reached, or an error occurs.

prepareCall
```
public CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency)
                              throws SQLException
```
Description copied from class: AS400JDBCConnection

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.
Specified by:

prepareCall in interface Connection

Specified by:

prepareCall in class AS400JDBCConnection

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:

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 CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency,
                                     int resultSetHoldability)
                              throws SQLException
```
Description copied from class: AS400JDBCConnection

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.
Full functionality of this method requires support in OS/400 V5R2 or IBM i. If connecting to OS/400 V5R1 or earlier, the value for resultSetHoldability will be ignored.
Specified by:

prepareCall in interface Connection

Specified by:

prepareCall in class AS400JDBCConnection

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:

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 valid, or an error occurs.

prepareStatement
```
public PreparedStatement prepareStatement(String sql)
                                   throws SQLException
```
Description copied from class: AS400JDBCConnection

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 Connection

Specified by:

prepareStatement in class AS400JDBCConnection

Parameters:

sql - The SQL statement.

Returns:

The prepared statement object.

Throws:

SQLException - If the connection is not open, the maximum number of statements for this connection has been reached, or an error occurs.

prepareStatement
```
public PreparedStatement prepareStatement(String sql,
                                          int autoGeneratedKeys)
                                   throws SQLException
```
Description copied from class: AS400JDBCConnection

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 IBM i. If connecting to OS/400 V5R1 or earlier, 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 Connection

Specified by:

prepareStatement in class AS400JDBCConnection

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:

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

prepareStatement
```
public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency)
                                   throws SQLException
```
Description copied from class: AS400JDBCConnection

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 holdability ResultSet.CLOSE_CURSORS_AT_COMMIT.
Specified by:

prepareStatement in interface Connection

Specified by:

prepareStatement in class AS400JDBCConnection

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:

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 PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
                                   throws SQLException
```
Description copied from class: AS400JDBCConnection

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 Connection

Specified by:

prepareStatement in class AS400JDBCConnection

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:

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 valid, or an error occurs.

prepareStatement
```
public PreparedStatement prepareStatement(String sql,
                                          int[] columnIndexes)
                                   throws SQLException
```
Description copied from class: AS400JDBCConnection

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 when connecting to IBM i V5R4 or earlier systems.

Specified by:

prepareStatement in interface Connection

Specified by:

prepareStatement in class AS400JDBCConnection

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:

The prepared statement object.

Throws:

SQLException - - If connecting to IBM i V5R4 or earlier systems, the connection is not open, the maximum number of statements for this connection has been reached, or an error occurs.

prepareStatement
```
public PreparedStatement prepareStatement(String sql,
                                          String[] columnNames)
                                   throws SQLException
```
Description copied from class: AS400JDBCConnection

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 when connecting to IBM i V5R4 or earlier systems.

Specified by:

prepareStatement in interface Connection

Specified by:

prepareStatement in class AS400JDBCConnection

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:

The prepared statement object.

Throws:

SQLException - - If connecting to IBM i V5R4 or earlier systems, the connection is not open, the maximum number of statements for this connection has been reached, or an error occurs.

processSavepointRequest

public void processSavepointRequest(String savepointStatement)
                             throws SQLException

Throws:: SQLException

pseudoClose

public void pseudoClose()
                 throws SQLException

Throws:: SQLException

releaseSavepoint
```
public void releaseSavepoint(Savepoint savepoint)
                      throws SQLException
```
Description copied from class: AS400JDBCConnection

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 Connection

Specified by:

releaseSavepoint in class AS400JDBCConnection

Parameters:

savepoint - the savepoint to be removed.

Throws:

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

rollback
```
public void rollback()
              throws SQLException
```
Description copied from class: AS400JDBCConnection

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.
This method can not be called when the connection is part of a distributed transaction. See AS400JDBCXAResource for more information.

Specified by:

rollback in interface Connection

Specified by:

rollback in class AS400JDBCConnection

Throws:

SQLException - If the connection is not open or an error occurs.

rollback
```
public void rollback(Savepoint savepoint)
              throws SQLException
```
Description copied from class: AS400JDBCConnection

Undoes all changes made after the specified Savepoint was set.

Specified by:

rollback in interface Connection

Specified by:

rollback in class AS400JDBCConnection

Parameters:

savepoint - the savepoint to be rolled back to.

Throws:

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

send

public void send(com.ibm.as400.access.DBBaseRequestDS request)
          throws SQLException

Throws:: SQLException

send

public void send(com.ibm.as400.access.DBBaseRequestDS request,
                 int id)
          throws SQLException

Throws:: SQLException

send

public void send(com.ibm.as400.access.DBBaseRequestDS request,
                 int id,
                 boolean leavePending)
          throws SQLException

Throws:: SQLException

sendAndHold

public void sendAndHold(com.ibm.as400.access.DBBaseRequestDS request,
                        int id)
                 throws SQLException

Throws:: SQLException

sendAndReceive

public com.ibm.as400.access.DBReplyRequestedDS sendAndReceive(com.ibm.as400.access.DBBaseRequestDS request)
                                                       throws SQLException

Throws:: SQLException

sendAndReceive

public com.ibm.as400.access.DBReplyRequestedDS sendAndReceive(com.ibm.as400.access.DBBaseRequestDS request,
                                                              int id)
                                                       throws SQLException

Throws:: SQLException

sendAndMultiReceive

public com.ibm.as400.access.DBReplyRequestedDS sendAndMultiReceive(com.ibm.as400.access.DBBaseRequestDS request)
                                                            throws SQLException

Throws:: SQLException

receiveMoreData

public com.ibm.as400.access.DBReplyRequestedDS receiveMoreData()
                                                        throws SQLException

Throws:: SQLException

setAutoCommit
```
public void setAutoCommit(boolean autoCommit)
                   throws SQLException
```
Description copied from class: AS400JDBCConnection

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.
The auto-commit mode is always false when the connection is part of a distributed transaction. See AS400JDBCXAResource for more information.

Specified by:

setAutoCommit in interface Connection

Specified by:

setAutoCommit in class AS400JDBCConnection

Parameters:

autoCommit - true to turn on auto-commit mode, false to turn it off.

Throws:

SQLException - If the connection is not open or an error occurs.

setCatalog
```
public void setCatalog(String catalog)
                throws SQLException
```
Description copied from class: AS400JDBCConnection

This method is not supported.

Specified by:

setCatalog in interface Connection

Specified by:

setCatalog in class AS400JDBCConnection

Throws:

SQLException - If the connection is not open.

setConcurrentAccessResolution
```
public void setConcurrentAccessResolution(int concurrentAccessResolution)
                                   throws SQLException
```
Description copied from class: AS400JDBCConnection

This method sets concurrent access resolution. This method overrides the setting of ConcurrentAccessResolution on the datasource or connection URL properties. This changes the setting for this connection only. This method has no effect on IBM i V6R1 or earlier. The possible values for this property are AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET, AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED, AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME and AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS, with the property defaulting to AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET. Setting this property to default exhibits the default behavior on the servers i.e., the semantic applied for read transactions to avoid locks will be determined by the server. AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED specifies that driver will flow USE CURRENTLY COMMITTED to server. Whether CURRENTLY COMMITTED will actually be in effect is ultimately determined by server. AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME specifies that driver will flow WAIT FOR OUTCOME to server. This will disable the CURRENTLY COMMITTED behavior at the server, if enabled, and the server will wait for the commit or rollback of data in the process of being updated. AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS specifies that driver will flow SKIP LOCKS to server. This directs the database manager to skip records in the case of record lock conflicts.

Specified by:

setConcurrentAccessResolution in class AS400JDBCConnection

Parameters:

concurrentAccessResolution - The current access resolution setting. Possible valuse: AS400JDBCDataSource.CONCURRENTACCESS_NOT_SET, AS400JDBCDataSource.CONCURRENTACCESS_USE_CURRENTLY_COMMITTED, AS400JDBCDataSource.CONCURRENTACCESS_WAIT_FOR_OUTCOME, or AS400JDBCDataSource.CONCURRENTACCESS_SKIP_LOCKS

Throws:

SQLException - If a database error occurs.

setDB2eWLMCorrelator
```
public void setDB2eWLMCorrelator(byte[] bytes)
                          throws SQLException
```
Description copied from class: AS400JDBCConnection

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 IBM i V5R3 or later systems. This request is ignored when running to OS/400 V5R2 or earlier systems.

Specified by:

setDB2eWLMCorrelator in class AS400JDBCConnection

Parameters:

bytes - The eWLM correlator value

Throws:

SQLException - If a database error occurs.

setDRDA

public void setDRDA(boolean drda)
             throws SQLException

Throws:: SQLException

setHoldability
```
public void setHoldability(int holdability)
                    throws SQLException
```
Description copied from class: AS400JDBCConnection

Sets the holdability of ResultSets created from this connection.
Full functionality of this method requires OS/400 V5R2 or IBM i. If connecting to OS/400 V5R1 or earlier, all cursors for the connection will be changed to the value of the variable holdability.

Specified by:

setHoldability in interface Connection

Specified by:

setHoldability in class AS400JDBCConnection

Parameters:

holdability - The cursor holdability. Valid values are ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT.

Throws:

SQLException - If the connection is not open or the value passed in is not valid.

setProperties

public void setProperties(JDDataSourceURL dataSourceUrl,
                          JDProperties properties,
                          AS400 as400)
                   throws SQLException

Throws:: SQLException

setProperties

public void setProperties(JDDataSourceURL dataSourceUrl,
                          JDProperties properties,
                          com.ibm.as400.access.AS400Impl as400)
                   throws SQLException

Throws:: SQLException

ignoreWarning

public boolean ignoreWarning(String sqlState)

ignoreWarning

public boolean ignoreWarning(SQLWarning warning)

setProperties

public void setProperties(JDDataSourceURL dataSourceUrl,
                          JDProperties properties,
                          com.ibm.as400.access.AS400Impl as400,
                          boolean newServer,
                          boolean skipSignonServer)
                   throws SQLException

Throws:: SQLException

setReadOnly
```
public void setReadOnly(boolean readOnly)
                 throws SQLException
```
Description copied from class: AS400JDBCConnection

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.
This method can not be called when the connection is part of a distributed transaction. See AS400JDBCXAResource for more information.

Specified by:

setReadOnly in interface Connection

Specified by:

setReadOnly in class AS400JDBCConnection

Throws:

SQLException - If the connection is not open, a transaction is active, or the "access" property is set to "read only".

setSavepoint
```
public Savepoint setSavepoint()
                       throws SQLException
```
Description copied from class: AS400JDBCConnection
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 IBM i. An exception is thrown if connecting to OS/400 V5R1 or earlier.
- 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 Connection

Specified by:

setSavepoint in class AS400JDBCConnection

Returns:

The new Savepoint object.

Throws:

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

setSavepoint
```
public Savepoint setSavepoint(String name)
                       throws SQLException
```
Description copied from class: AS400JDBCConnection
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 IBM i. An exception is thrown if connecting to OS/400 V5R1 or earlier.
- 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 Connection

Specified by:

setSavepoint in class AS400JDBCConnection

Parameters:

name - A String containing the name of the savepoint

Returns:

The new Savepoint object.

Throws:

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

setSavepoint

public Savepoint setSavepoint(String name,
                              int id)
                       throws SQLException

Throws:: SQLException

setServerAttributes

public void setServerAttributes()
                         throws SQLException

Throws:: SQLException

setSystem

public void setSystem(AS400 as400)
               throws SQLException

Throws:: SQLException

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws SQLException

Description copied from class: AS400JDBCConnection

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

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

IBM i 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 Connection

Specified by:

setTransactionIsolation in class AS400JDBCConnection

Parameters:

level - The transaction isolation level. Possible values are:

TRANSACTION_READ_UNCOMMITTED
TRANSACTION_READ_COMMITTED
TRANSACTION_REPEATABLE_READ
TRANSACTION_SERIALIZABLE

Throws:

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

setTypeMap
```
public void setTypeMap(Map typeMap)
                throws SQLException
```
Description copied from class: AS400JDBCConnection

Sets the type map to be used for distinct and structured types.
Note: Distinct types are supported by DB2 for IBM i, 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 for IBM i. Consequently, this driver does not support the type map.

Specified by:

setTypeMap in interface Connection

Specified by:

setTypeMap in class AS400JDBCConnection

Parameters:

typeMap - The type map.

Throws:

SQLException - This exception is always thrown.

useExtendedFormats

public boolean useExtendedFormats()
                           throws SQLException

Throws:: SQLException

getValidWrappedList
```
public String[] getValidWrappedList()
```

setClientInfo
```
public void setClientInfo(String name,
                          String value)
                   throws SQLClientInfoException
```
Description copied from class: AS400JDBCConnection
Sets the value of the client info property specified by name to the value specified by value.
Applications may use the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver and the maximum length that may be specified for each property.
The driver stores the value specified in a suitable location in the database. For example in a special register, session parameter, or system table column. For efficiency the driver may defer setting the value in the database until the next time a statement is executed or prepared. Other than storing the client information in the appropriate place in the database, these methods shall not alter the behavior of the connection in anyway. The values supplied to these methods are used for accounting, diagnostics and debugging purposes only.
The driver shall generate a warning if the client info name specified is not recognized by the driver.
If the value specified to this method is greater than the maximum length for the property the driver may either truncate the value and generate a warning or generate a SQLException. If the driver generates a SQLException, the value specified was not set on the connection.
The following client info properties are supported in Toobox for Java.
- ApplicationName - The name of the application currently utilizing the connection
- ClientUser - The name of the user that the application using the connection is performing work for. This may not be the same as the user name that was used in establishing the connection.
- ClientHostname - The hostname of the computer the application using the connection is running on.
- ClientAccounting - Client accounting information.
- ClientProgramID - The client program identification.
Specified by:

setClientInfo in interface Connection

Specified by:

setClientInfo in class AS400JDBCConnection

Parameters:

name - The name of the client info property to set

value - The value to set the client info property to. If the value is null, the current value of the specified property is cleared.

Throws:

SQLClientInfoException - if the database returns an error while setting the client info value on the database server.

setClientInfo
```
public void setClientInfo(Properties properties)
                   throws SQLClientInfoException
```
Description copied from class: AS400JDBCConnection
Sets the value of the connection's client info properties. The Properties object contains the names and values of the client info properties to be set. The set of client info properties contained in the properties list replaces the current set of client info properties on the connection. If a property that is currently set on the connection is not present in the properties list, that property is cleared. Specifying an empty properties list will clear all of the properties on the connection. See setClientInfo (String, String) for more information.
If an error occurs in setting any of the client info properties, a ClientInfoException is thrown. The ClientInfoException contains information indicating which client info properties were not set. The state of the client information is unknown because some databases do not allow multiple client info properties to be set atomically. For those databases, one or more properties may have been set before the error occurred.
The following client info properties are supported in Toobox for Java.
- ApplicationName - The name of the application currently utilizing the connection
- ClientUser - The name of the user that the application using the connection is performing work for. This may not be the same as the user name that was used in establishing the connection.
- ClientHostname - The hostname of the computer the application using the connection is running on.
- ClientAccounting - Client accounting information.
- ClientProgramID - The client program identification.
Specified by:

setClientInfo in interface Connection

Specified by:

setClientInfo in class AS400JDBCConnection

Parameters:

properties - the list of client info properties to set

Throws:

SQLClientInfoException - If there is a problem with the Client Info. if the database returns an error while setting the clientInfo values on the database

getClientInfo
```
public String getClientInfo(String name)
                     throws SQLException
```
Description copied from class: AS400JDBCConnection
Returns the value of the client info property specified by name. This method may return null if the specified client info property has not been set and does not have a default value. This method will also return null if the specified client info property name is not supported by the driver.
Applications may use the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver.
The following client info properties are supported in Toobox for Java.
- ApplicationName - The name of the application currently utilizing the connection
- ClientUser - The name of the user that the application using the connection is performing work for. This may not be the same as the user name that was used in establishing the connection.
- ClientHostname - The hostname of the computer the application using the connection is running on.
- ClientAccounting - Client accounting information.
- ClientProgramID - The client program identification.
Specified by:

getClientInfo in interface Connection

Specified by:

getClientInfo in class AS400JDBCConnection

Parameters:

name - The name of the client info property to retrieve

Returns:

The value of the client info property specified

Throws:

SQLException - if the database returns an error when fetching the client info value from the database.
see java.sql.DatabaseMetaData#getClientInfoProperties

getClientInfo
```
public Properties getClientInfo()
                         throws SQLException
```
Description copied from class: AS400JDBCConnection
Returns a list containing the name and current value of each client info property supported by the driver. The value of a client info property may be null if the property has not been set and does not have a default value.
The following client info properties are supported in Toobox for Java.
- ApplicationName - The name of the application currently utilizing the connection
- ClientUser - The name of the user that the application using the connection is performing work for. This may not be the same as the user name that was used in establishing the connection.
- ClientHostname - The hostname of the computer the application using the connection is running on.
- ClientAccounting - Client accounting information.
- ClientProgramID - The client program identification.
Specified by:

getClientInfo in interface Connection

Specified by:

getClientInfo in class AS400JDBCConnection

Returns:

A Properties object that contains the name and current value of each of the client info properties supported by the driver.

Throws:

SQLException - if the database returns an error when fetching the client info values from the database

createClob
```
public Clob createClob()
                throws SQLException
```
Description copied from class: AS400JDBCConnection

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

Specified by:

createClob in interface Connection

Specified by:

createClob in class AS400JDBCConnection

Returns:

An object that implements the Clob interface

Throws:

SQLException - if an object that implements the Clob interface can not be constructed.

createBlob
```
public Blob createBlob()
                throws SQLException
```
Description copied from class: AS400JDBCConnection

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

Specified by:

createBlob in interface Connection

Specified by:

createBlob in class AS400JDBCConnection

Returns:

An object that implements the Blob interface

Throws:

SQLException - if an object that implements the Blob interface can not be constructed

createArrayOf
```
public Array createArrayOf(String typeName,
                           Object[] elements)
                    throws SQLException
```
Description copied from class: AS400JDBCConnection

Factory method for creating Array objects.

Specified by:

createArrayOf in interface Connection

Specified by:

createArrayOf in class AS400JDBCConnection

Parameters:

typeName - the SQL name of the type the elements of the array map to. The typeName is a database-specific name which may be the name of a built-in type, a user-defined type or a standard SQL type supported by this database. This is the value returned by Array.getBaseTypeName For Toolbox, the typeName will correspond to a typename in java.sql.Types.

elements - the elements that populate the returned object

Returns:

an Array object whose elements map to the specified SQL type

Throws:

SQLException - if a database error occurs, the typeName is null or this method is called on a closed connection

createStruct
```
public Struct createStruct(String typeName,
                           Object[] attributes)
                    throws SQLException
```
Description copied from class: AS400JDBCConnection

Factory method for creating Struct objects.

Specified by:

createStruct in interface Connection

Specified by:

createStruct in class AS400JDBCConnection

Parameters:

typeName - the SQL type name of the SQL structured type that this Struct object maps to. The typeName is the name of a user-defined type that has been defined for this database. It is the value returned by Struct.getSQLTypeName.

attributes - the attributes that populate the returned object

Returns:

a Struct object that maps to the given SQL type and is populated with the given attributes

Throws:

SQLException - if a database error occurs, the typeName is null or this method is called on a closed connection

setDBHostServerTrace
```
public void setDBHostServerTrace(boolean trace)
```
Description copied from class: AS400JDBCConnection

Starts or stops the Database Host Server trace for this connection. Note: This method is only supported when running to IBM i V5R3 or later and is ignored if you specified to turn on database host server tracing using the 'server trace' connection property.

Specified by:

setDBHostServerTrace in class AS400JDBCConnection

Parameters:

trace - true to start database host server tracing, false to end it.

doUpdateDeleteBlocking
```
public boolean doUpdateDeleteBlocking()
```
Specified by:

doUpdateDeleteBlocking in class AS400JDBCConnection

getMaximumBlockedInputRows
```
public int getMaximumBlockedInputRows()
```
Specified by:

getMaximumBlockedInputRows in class AS400JDBCConnection

getSchema
```
public String getSchema()
                 throws SQLException
```
Description copied from class: AS400JDBCConnection

Retrieves this Connection object's current schema name.

Specified by:

getSchema in interface Connection

Specified by:

getSchema in class AS400JDBCConnection

Returns:

the current schema name or null if there is none

Throws:

SQLException - if a database access error occurs or this method is called on a closed connection

setNetworkTimeout
```
public void setNetworkTimeout(int timeout)
                       throws SQLException
```
Description copied from class: AS400JDBCConnection

Sets the maximum period a Connection or objects created from the Connection will wait for the database to reply to any one request. If any request remains unanswered, the waiting method will return with a SQLException, and the Connection or objects created from the Connection will be marked as closed. Any subsequent use of the objects, with the exception of the close, isClosed or Connection.isValid methods, will result in a SQLException.
In the JTOpen JDBC driver, this is implemented by setting the SoTimeout of the underlying socket.
Currently, setting the network timeout is only supported when the "thread used" property is false.
When the driver determines that the setNetworkTimeout timeout value has expired, the JDBC driver marks the connection closed and releases any resources held by the connection.
This method checks to see that there is an SQLPermission object before allowing the method to proceed. If a SecurityManager exists and its checkPermission method denies calling setNetworkTimeout, this method throws a java.lang.SecurityException.

Specified by:

setNetworkTimeout in class AS400JDBCConnection

Parameters:

timeout - - The time in milliseconds to wait for the database operation to complete. If the JDBC driver does not support milliseconds, the JDBC driver will round the value up to the nearest second. If the timeout period expires before the operation completes, a SQLException will be thrown. A value of 0 indicates that there is not timeout for database operations.

Throws:

SQLException - If a database error occurs.

See Also:

SecurityManager.checkPermission(java.security.Permission), Statement.setQueryTimeout(int), AS400JDBCConnection.getNetworkTimeout(), AS400JDBCConnection.abort(java.util.concurrent.Executor), Executor

getNetworkTimeout
```
public int getNetworkTimeout()
                      throws SQLException
```
Description copied from class: AS400JDBCConnection

Retrieves the number of milliseconds the driver will wait for a database request to complete. If the limit is exceeded, a SQLException is thrown.

Specified by:

getNetworkTimeout in interface Connection

Specified by:

getNetworkTimeout in class AS400JDBCConnection

Returns:

The current timeout limit in milliseconds; zero means there is no limit

Throws:

SQLException - - if a database access error occurs or this method is called on a closed Connection

See Also:

AS400JDBCConnection.setNetworkTimeout(java.util.concurrent.Executor, int)

setSchema
```
public void setSchema(String schema)
               throws SQLException
```
Description copied from class: AS400JDBCConnection

Sets the given schema name to access.
Calling setSchema has no effect on previously created or prepared Statement objects. For the toolbox driver, the DBMS prepare operation takes place immediately when the Connection method prepareStatement or prepareCall is invoked. For maximum portability, setSchema should be called before a Statement is created or prepared.

Specified by:

setSchema in interface Connection

Specified by:

setSchema in class AS400JDBCConnection

Parameters:

schema - The name of the schema to use for the connection

Throws:

SQLException - If a database access error occurs or this method is called on a closed connection

isQueryTimeoutMechanismCancel

public boolean isQueryTimeoutMechanismCancel()

setupVariableFieldCompression

public void setupVariableFieldCompression()

useVariableFieldCompression

public boolean useVariableFieldCompression()

useVariableFieldInsertCompression

public boolean useVariableFieldInsertCompression()

setDisableCompression
```
public void setDisableCompression(boolean disableCompression_)
```
Specified by:

setDisableCompression in class AS400JDBCConnection

dumpStatementCreationLocation
```
public void dumpStatementCreationLocation()
```
Specified by:

dumpStatementCreationLocation in class AS400JDBCConnection

testDataTruncation

public boolean testDataTruncation(AS400JDBCStatement statementWarningObject,
                                  AS400JDBCResultSet resultSetWarningObject,
                                  int parameterIndex,
                                  boolean isParameter,
                                  com.ibm.as400.access.SQLData data,
                                  JDSQLStatement sqlStatement)
                           throws SQLException

Throws:: SQLException

getConverter
```
public ConvTable getConverter()
```

setLastServerSQLState

public void setLastServerSQLState(String lastSqlState)

getLastServerSQLState
```
public String getLastServerSQLState()
```

getPackageCCSID_Converter

public ConvTable getPackageCCSID_Converter()

finalize
```
public void finalize()
```
Overrides:

finalize in class Object

getReadOnly
```
public boolean getReadOnly()
```

getCheckStatementHoldability

public boolean getCheckStatementHoldability()

toString
```
public String toString()
```
Description copied from class: AS400JDBCConnection

Returns the connection's catalog name. This is the name of the IBM i system.

Specified by:

toString in class AS400JDBCConnection

Returns:

The catalog name.

getReconnectURLs
```
public String[] getReconnectURLs()
```
Description copied from class: AS400JDBCConnection

Returns a String array containing the URLs that are used when to reconnect to a system when the "enableClientAffinities" property is set. If the property is not set, then an empty array will be returned.

Specified by:

getReconnectURLs in class AS400JDBCConnection

Returns:

A String array containing the URLS used by "enableClientAffinities".

isValid
```
public boolean isValid(int timeout)
                throws SQLException
```
Description copied from class: AS400JDBCConnection

Returns true if the connection has not been closed and is still valid. The driver shall submit a query on the connection or use some other mechanism that positively verifies the connection is still valid when this method is called.
The query submitted by the driver to validate the connection shall be executed in the context of the current transaction.

Specified by:

isValid in interface Connection

Specified by:

isValid in class AS400JDBCConnection

Parameters:

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

Returns:

true if the connection is valid, false otherwise

Throws:

SQLException - if a database access error occurs.

createNClob
```
public NClob createNClob()
                  throws SQLException
```
Description copied from class: AS400JDBCConnection

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

Specified by:

createNClob in interface Connection

Specified by:

createNClob in class AS400JDBCConnection

Returns:

An object that implements the NClob interface

Throws:

SQLException - if an object that implements the NClob interface can not be constructed.

createSQLXML
```
public SQLXML createSQLXML()
                    throws SQLException
```
Description copied from class: AS400JDBCConnection

Constructs an object that implements the SQLXML interface. The object returned initially contains no data. The createXMLStreamWriter object and setString method of the SQLXML interface may be used to add data to the SQLXML object.

Specified by:

createSQLXML in interface Connection

Specified by:

createSQLXML in class AS400JDBCConnection

Returns:

An object that implements the SQLXML interface

Throws:

SQLException - if an object that implements the SQLXML interface can not be constructed

abort
```
public void abort(Executor executor)
           throws SQLException
```
Description copied from class: AS400JDBCConnection
Terminates an open connection. Calling abort results in:
- The connection marked as closed
- Closes any physical connection to the database
- Releases resources used by the connection
- Insures that any thread that is currently accessing the connection will either progress to completion or throw an SQLException.
Calling abort marks the connection closed and releases any resources. Calling abort on a closed connection is a no-op.
It is possible that the aborting and releasing of the resources that are held by the connection can take an extended period of time. When the abort method returns, the connection will have been marked as closed and the Executor that was passed as a parameter to abort may still be executing tasks to release resources.
This method checks to see that there is an SQLPermission object before allowing the method to proceed. If a SecurityManager exists and its checkPermission method denies calling abort, this method throws a java.lang.SecurityException.
Specified by:

abort in interface Connection

Specified by:

abort in class AS400JDBCConnection

Parameters:

executor - The Executor implementation which will be used by abort.

Throws:

SQLException - - if a database access error occurs or the executor is null

setNetworkTimeout
```
public void setNetworkTimeout(Executor executor,
                              int milliseconds)
                       throws SQLException
```
Description copied from class: AS400JDBCConnection

Sets the maximum period a Connection or objects created from the Connection will wait for the database to reply to any one request. If any request remains unanswered, the waiting method will return with a SQLException, and the Connection or objects created from the Connection will be marked as closed. Any subsequent use of the objects, with the exception of the close, isClosed or Connection.isValid methods, will result in a SQLException.
In the JTOpen JDBC driver, this is implemented by setting the SoTimeout of the underlying socket.
Currently, setting the network timeout is only supported when the "thread used" property is false.
Note: This method is intended to address a rare but serious condition where network partitions can cause threads issuing JDBC calls to hang uninterruptedly in socket reads, until the OS TCP-TIMEOUT (typically 10 minutes). This method is related to the abort() method which provides an administrator thread a means to free any such threads in cases where the JDBC connection is accessible to the administrator thread. The setNetworkTimeout method will cover cases where there is no administrator thread, or it has no access to the connection. This method is severe in it's effects, and should be given a high enough value so it is never triggered before any more normal timeouts, such as transaction timeouts.
JDBC driver implementations may also choose to support the setNetworkTimeout method to impose a limit on database response time, in environments where no network is present.
Drivers may internally implement some or all of their API calls with multiple internal driver-database transmissions, and it is left to the driver implementation to determine whether the limit will be applied always to the response to the API call, or to any single request made during the API call.
This method can be invoked more than once, such as to set a limit for an area of JDBC code, and to reset to the default on exit from this area. Invocation of this method has no impact on already outstanding requests.
The Statement.setQueryTimeout() timeout value is independent of the timeout value specified in setNetworkTimeout. If the query timeout expires before the network timeout then the statement execution will be canceled. If the network is still active the result will be that both the statement and connection are still usable. However if the network timeout expires before the query timeout or if the statement timeout fails due to network problems, the connection will be marked as closed, any resources held by the connection will be released and both the connection and statement will be unusable.
When the driver determines that the setNetworkTimeout timeout value has expired, the JDBC driver marks the connection closed and releases any resources held by the connection.
This method checks to see that there is an SQLPermission object before allowing the method to proceed. If a SecurityManager exists and its checkPermission method denies calling setNetworkTimeout, this method throws a java.lang.SecurityException.

Specified by:

setNetworkTimeout in interface Connection

Specified by:

setNetworkTimeout in class AS400JDBCConnection

Parameters:

executor - - The Executor implementation which will be used by setNetworkTimeout.

milliseconds - - The time in milliseconds to wait for the database operation to complete. If the JDBC driver does not support milliseconds, the JDBC driver will round the value up to the nearest second. If the timeout period expires before the operation completes, a SQLException will be thrown. A value of 0 indicates that there is not timeout for database operations.

Throws:

SQLException - - if a database access error occurs, this method is called on a closed connection, the executor is null, or the value specified for seconds is less than 0.

See Also:

SecurityManager.checkPermission(java.security.Permission), Statement.setQueryTimeout(int), AS400JDBCConnection.getNetworkTimeout(), AS400JDBCConnection.abort(java.util.concurrent.Executor), Executor

isWrapperFor
```
public boolean isWrapperFor(Class<?> iface)
                     throws SQLException
```
Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.

Specified by:

isWrapperFor in interface Wrapper

Parameters:

iface - a Class defining an interface.

Returns:

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

Throws:

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

unwrap
```
public <T> T unwrap(Class<T> iface)
             throws SQLException
```
Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

Specified by:

unwrap in interface Wrapper

Parameters:

iface - A Class defining an interface that the result must implement.

Returns:

an object that implements the interface. May be a proxy for the actual implementing object.

Throws:

SQLException - If a database error occurs. If no object found that implements the interface

Class AS400JDBCConnectionRedirect

Field Summary

Fields inherited from class com.ibm.as400.access.AS400JDBCConnection

Fields inherited from interface java.sql.Connection

Method Summary

Methods inherited from class com.ibm.as400.access.AS400JDBCConnection

Methods inherited from class java.lang.Object

Methods inherited from interface java.sql.Connection

Methods inherited from interface java.sql.Wrapper

Field Detail

SEAMLESS_RETRY_COUNT

Method Detail

cancel

checkAccess

checkCancel

checkHoldabilityConstants

checkOpen

clearWarnings

close

handleAbort

commit

setCheckStatementHoldability

correctResultSetType

createStatement

createStatement

createStatement

debug

debug

getAS400

getAutoCommit

getCatalog

getConcurrentAccessResolution

getConverter

getDataCompression

getDefaultSchema

getDefaultSchema

getHoldability

getID

getInternalHoldability

getMetaData

getProperties

getServerJobIdentifier

getServerFunctionalLevel

getSystem

getTransactionIsolation

getTransactionManager

getTypeMap

getUnusedId

getMustSpecifyForUpdate

getURL

getUserName

getVRM

getWarnings

isCursorNameUsed

isClosed

isReadOnly

isReadOnlyAccordingToProperties

markCursorsClosed

markStatementsClosed

makeGeneratedKeySelectStatement

makeGeneratedKeySelectStatement

nativeSQL

notifyClose

postWarningSQLState

postWarning

prepareCall

prepareCall

prepareCall

prepareStatement

prepareStatement

prepareStatement

prepareStatement

prepareStatement

prepareStatement

processSavepointRequest

pseudoClose

releaseSavepoint

rollback

rollback

send