OracleConnectionWrapper

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle10g JDBC

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.jdbc
Class OracleConnectionWrapper

java.lang.Object
  oracle.jdbc.OracleConnectionWrapper

All Implemented Interfaces:: java.sql.Connection, OracleConnection

Direct Known Subclasses:: OracleConnection

public class OracleConnectionWrapper
extends java.lang.Object
implements OracleConnection

A simple implementation of a connection wrapper which may be nested to any depth.

Field Summary
`static java.lang.String`	`BUILD_DATE`
`static boolean`	`PRIVATE_TRACE`
`static boolean`	`TRACE`

Fields inherited from interface oracle.jdbc.OracleConnection

ABANDONED_CONNECTION_CALLBACK, ALL_CONNECTION_CALLBACKS, CACHE_SIZE_NOT_SET, CONNECTION_RELEASE_HIGH, CONNECTION_RELEASE_LOCKED, CONNECTION_RELEASE_LOW, DATABASE_CLOSED, DATABASE_NOTOK, DATABASE_OK, DATABASE_TIMEOUT, END_TO_END_ACTION_INDEX, END_TO_END_CLIENTID_INDEX, END_TO_END_ECID_INDEX, END_TO_END_MODULE_INDEX, END_TO_END_STATE_INDEX_MAX, INVALID_CONNECTION, PROXY_CERTIFICATE, PROXY_DISTINGUISHED_NAME, PROXY_ROLES, PROXY_SESSION, PROXY_USER_NAME, PROXY_USER_PASSWORD, PROXYTYPE_CERTIFICATE, PROXYTYPE_DISTINGUISHED_NAME, PROXYTYPE_USER_NAME, RELEASE_CONNECTION_CALLBACK

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary
`OracleConnectionWrapper()`
`OracleConnectionWrapper(OracleConnection toBeWrapped)` Construct an instance which wraps the arguement

Method Summary
`java.sql.Connection`	`_getPC()` Return the underlying physical connection if this is a logical connection.
`void`	`applyConnectionAttributes(java.util.Properties connAttr)` Applies the connection Attributes provided on the underlying PooledConnection.
`void`	`archive(int mode, int aseq, java.lang.String acstext)` Not implemented.
`void`	`clearWarnings()`
`void`	`close()`
`void`	`close(int opt)` If opt is OracleConnection.INVALID_CONNECTION : Closes the given Logical connection, as well the underlying PooledConnection without returning the connection to the cache when called with the parameter INVALID_CONNECTION.
`void`	`close(java.util.Properties connAttr)` Closes the given Logical connection, and returns the underlying PooledConnection to the implicit connection cache.
`void`	`commit()`
`java.sql.Statement`	`createStatement()`
`java.sql.Statement`	`createStatement(int resultSetType, int resultSetConcurrency)`
`java.sql.Statement`	`createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)`
`boolean`	`getAutoClose()` The driver is always in auto-close mode.
`boolean`	`getAutoCommit()`
`java.sql.CallableStatement`	`getCallWithKey(java.lang.String key)` getCallWithKey Searches the explicit cache for a match on key.
`java.lang.String`	`getCatalog()`
`java.util.Properties`	`getConnectionAttributes()` Returns the connection Attributes set on the underlying PooledConnection.
`int`	`getConnectionReleasePriority()` Returns the release priority set on the connection
`boolean`	`getCreateStatementAsRefCursor()` Retrieves the current setting of the `createStatementAsRefCursor` flag which you can set with the `setCreateStatementAsRefCursor` method.
`int`	`getDefaultExecuteBatch()` Retrieves the overall connection batch value of this connection.
`int`	`getDefaultRowPrefetch()` Retrieves the value of row prefetch for all statements associated with this connection and created after this value was set.
`java.lang.Object`	`getDescriptor(java.lang.String sql_name)` Gets a Descriptor object corresponding to a sql type.
`short`	`getEndToEndECIDSequenceNumber()` Gets the current end to end tracing context id sequence number.
`java.lang.String[]`	`getEndToEndMetrics()` Gets the values of the end-to-end metrics, if any.
`boolean`	`getExplicitCachingEnabled()` getExplicitCachingEnabled Returns true if the explicit cache is currently enabled, false otherwise.
`int`	`getHoldability()`
`boolean`	`getImplicitCachingEnabled()` getImplicitCachingEnabled Returns true if the implicit cache is currently enabled, false otherwise.
`boolean`	`getIncludeSynonyms()` Checks whether or not synonyms information is included in `DatabaseMetaData.getColumns`.
`java.lang.Object`	`getJavaObject(java.lang.String sql_name)`
`java.sql.DatabaseMetaData`	`getMetaData()`
`java.util.Properties`	`getProperties()` Determines the connection properties.
`boolean`	`getRemarksReporting()` Checks whether or not a call of `getTables` or `getColumns` of the `DatabaseMetaData` interface will report the `REMARKS` column.
`boolean`	`getRestrictGetTables()` Gets the restriction status of the returned data in `DatabaseMetaData.getTables`.
`java.lang.String`	`getSessionTimeZone()` Obtain Oracle session time zone region name.
`java.lang.String`	`getSQLType(java.lang.Object obj)`
`int`	`getStatementCacheSize()` getStatementCacheSize Returns the current size of the application cache.
`java.sql.PreparedStatement`	`getStatementWithKey(java.lang.String key)` getStatementWithKey Searches the explicit cache for a match on key.
`int`	`getStmtCacheSize()`
`short`	`getStructAttrCsId()` Obtain the Oracle identifier of the character set used in STRUCT attributes.
`int`	`getTransactionIsolation()`
`java.util.Map`	`getTypeMap()`
`java.util.Properties`	`getUnMatchedConnectionAttributes()` Returns the unmatched connection Attributes from the underlying PooledConnection.
`java.lang.String`	`getUserName()` Gets the user name of the current connection.
`boolean`	`getUsingXAFlag()` Gets the value of the `UsingXA` flag which the driver sets to `true` when using XA to manage distributed transactions.
`java.sql.SQLWarning`	`getWarnings()`
`boolean`	`getXAErrorFlag()` Gets the value of the `XAError` flag which is used with distributed transactions.
`boolean`	`isClosed()`
`boolean`	`isLogicalConnection()` Method that returns a boolean indicating whether its a logical connection or not.
`boolean`	`isProxySession()` Returns true if the current session associated with this connection is a proxy session.
`boolean`	`isReadOnly()`
`java.lang.String`	`nativeSQL(java.lang.String sql)`
`void`	`openProxySession(int mode, java.util.Properties prop)` Opens a new proxy session with the username provided in the prop argument and switch to this new session. This feature is a thin only feature. Three proxy types are supported : OracleConnection.PROXYTYPE_USER_NAME : In this type PROXY_USER_NAME needs to be provided in prop.
`void`	`oracleReleaseSavepoint(OracleSavepoint savepoint)` Removes the given `OracleSavepoint` object from the current transaction.
`void`	`oracleRollback(OracleSavepoint savepoint)` Undoes all changes made after the given `OracleSavepoint` object was set.
`OracleSavepoint`	`oracleSetSavepoint()` Creates an unnamed savepoint in the current transaction and returns the new `OracleSavepoint` object that represents it.
`OracleSavepoint`	`oracleSetSavepoint(java.lang.String name)` Creates a savepoint with the given name in the current transaction and returns the new `OracleSavepoint` object that represents it.
`int`	`pingDatabase(int timeOut)` ping Database
`java.sql.CallableStatement`	`prepareCall(java.lang.String sql)`
`java.sql.CallableStatement`	`prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency)`
`java.sql.CallableStatement`	`prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)`
`java.sql.CallableStatement`	`prepareCallWithKey(java.lang.String key)`
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql)`
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql, int autoGeneratedKeys)`
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql, int[] columnIndexes)`
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency)`
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)`
`java.sql.PreparedStatement`	`prepareStatement(java.lang.String sql, java.lang.String[] columnNames)`
`java.sql.PreparedStatement`	`prepareStatementWithKey(java.lang.String key)`
`void`	`purgeExplicitCache()` purgeExplicitCache Removes all existing statements from the explicit cache, after which it will be empty.
`void`	`purgeImplicitCache()` purgeImplicitCache Removes all existing statements from the implicit cache, after which it will be empty.
`void`	`putDescriptor(java.lang.String sql_name, java.lang.Object desc)` Store the Object Descriptor for later usage.
`void`	`registerConnectionCacheCallback(OracleConnectionCacheCallback occc, java.lang.Object userObj, int cbkFlag)` Registers the connection cache callback on the logical connection This is used in conjunction with the Implicit Connection Cache Properties.
`void`	`registerSQLType(java.lang.String sql_name, java.lang.Class java_class)`
`void`	`registerSQLType(java.lang.String sql_name, java.lang.String java_class_name)`
`void`	`registerTAFCallback(OracleOCIFailover cbk, java.lang.Object obj)` Register an application TAF Callback instance that will be called when an application failover occurs.
`void`	`releaseSavepoint(java.sql.Savepoint savepoint)`
`void`	`rollback()`
`void`	`rollback(java.sql.Savepoint savepoint)`
`void`	`setAutoClose(boolean autoClose)` We are always in auto-close mode.
`void`	`setAutoCommit(boolean autoCommit)`
`void`	`setCatalog(java.lang.String catalog)`
`void`	`setConnectionReleasePriority(int priority)` Sets connection release priority.
`void`	`setCreateStatementAsRefCursor(boolean value)` When this is set to `true`, any new statements created from this connection will be created as a `REF CURSOR`.
`void`	`setDefaultExecuteBatch(int batch)` Sets a default batch value for the Oracle update batching model (the default value is 1).
`void`	`setDefaultRowPrefetch(int value)` Sets the value of row prefetch for all statements associated with this connection and created after this value was set.
`void`	`setEndToEndMetrics(java.lang.String[] metrics, short sequenceNumber)` Sets the values of the end-to-end tracing metrics.
`void`	`setExplicitCachingEnabled(boolean cache)` setExplicitCachingEnabled Enables or disables the explicit cache.
`void`	`setHoldability(int holdability)`
`void`	`setImplicitCachingEnabled(boolean cache)` setImplicitCachingEnabled Enables or disables the implicit cache.
`void`	`setIncludeSynonyms(boolean synonyms)` Turns on or off retrieval of synonym information in DatabaseMetaData.
`void`	`setPlsqlWarnings(java.lang.String setting)` Enable/Disable PLSQL Compiler Warnings
`void`	`setReadOnly(boolean readOnly)`
`void`	`setRemarksReporting(boolean reportRemarks)` Turns on or off the reporting of the REMARKS columns by the `getTables` and `getColumns` calls of the `DatabaseMetaData` interface.
`void`	`setRestrictGetTables(boolean restrict)` Turns on or off the restriction of the returned data in `DatabaseMetaData.getTables.`
`java.sql.Savepoint`	`setSavepoint()`
`java.sql.Savepoint`	`setSavepoint(java.lang.String name)`
`void`	`setSessionTimeZone(java.lang.String regionName)` Set the session time zone.
`void`	`setStatementCacheSize(int size)` setStatementCacheSize Specifies the size of the size of the application cache (which will be used by both implicit and explicit caching).
`void`	`setStmtCacheSize(int size)`
`void`	`setStmtCacheSize(int size, boolean clearMetaData)`
`void`	`setTransactionIsolation(int level)`
`void`	`setTypeMap(java.util.Map map)`
`void`	`setUsingXAFlag(boolean value)` When using distributed transactions with XA, you can set the value of the `UsingXA` flag.
`void`	`setWrapper(OracleConnection wrapper)` Set a connection wrapper as the wrapper of this connection.
`void`	`setXAErrorFlag(boolean value)` Sets the value of the `XAError` flag which is used with distributed transactions.
`void`	`shutdown(int mode)` Not implemented.
`void`	`startup(java.lang.String startup_str, int mode)` Not implemented
`OracleConnection`	`unwrap()` Unwrap one level.

Methods inherited from class java.lang.Object

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

Field Detail

TRACE

public static final boolean TRACE

See Also:: Constant Field Values

PRIVATE_TRACE

public static final boolean PRIVATE_TRACE

See Also:: Constant Field Values

BUILD_DATE

public static final java.lang.String BUILD_DATE

See Also:: Constant Field Values

Constructor Detail

OracleConnectionWrapper

public OracleConnectionWrapper()

OracleConnectionWrapper

public OracleConnectionWrapper(OracleConnection toBeWrapped)

Construct an instance which wraps the arguement

Method Detail

unwrap

public OracleConnection unwrap()

Unwrap one level. Returns the connection within this wrapper.

Specified by:: unwrap in interface OracleConnection

Returns:: wrapping object which implements oracle.jdbc.OracleConnection if any else return null

setWrapper

public void setWrapper(OracleConnection wrapper)

Set a connection wrapper as the wrapper of this connection. Recursively sets the wrapper to the lowest level. Thus the physical connection will always know its outermost wrapper The recursion is terminated by the method in oracle.jdbc.driver.OracleConnction which stores its argument.

Specified by:: setWrapper in interface OracleConnection

Parameters:: wrapper - An object which implements oracle.jdbc.OracleConnection and which can act as a wrapper for this object # @since 9iR2

createStatement

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

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

Throws:: java.sql.SQLException

prepareStatement

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

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

Throws:: java.sql.SQLException

prepareCall

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

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

Throws:: java.sql.SQLException

nativeSQL

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

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

Throws:: java.sql.SQLException

setAutoCommit

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

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

Throws:: java.sql.SQLException

getAutoCommit

public boolean getAutoCommit()
                      throws java.sql.SQLException

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

Throws:: java.sql.SQLException

commit

public void commit()
            throws java.sql.SQLException

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

Throws:: java.sql.SQLException

rollback

public void rollback()
              throws java.sql.SQLException

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

Throws:: java.sql.SQLException

close

public void close()
           throws java.sql.SQLException

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

Throws:: java.sql.SQLException

isClosed

public boolean isClosed()
                 throws java.sql.SQLException

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

Throws:: java.sql.SQLException

getMetaData

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

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

Throws:: java.sql.SQLException

setReadOnly

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

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

Throws:: java.sql.SQLException

isReadOnly

public boolean isReadOnly()
                   throws java.sql.SQLException

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

Throws:: java.sql.SQLException

setCatalog

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

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

Throws:: java.sql.SQLException

getCatalog

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

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

Throws:: java.sql.SQLException

setTransactionIsolation

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

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

Throws:: java.sql.SQLException

getTransactionIsolation

public int getTransactionIsolation()
                            throws java.sql.SQLException

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

Throws:: java.sql.SQLException

getWarnings

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

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

Throws:: java.sql.SQLException

clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException

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

Throws:: java.sql.SQLException

createStatement

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

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

Throws:: java.sql.SQLException

prepareStatement

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

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

Throws:: java.sql.SQLException

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

Throws:: java.sql.SQLException

getTypeMap

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

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

Throws:: java.sql.SQLException

setTypeMap

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

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

Throws:: java.sql.SQLException

isProxySession

public boolean isProxySession()

Description copied from interface: OracleConnection

Returns true if the current session associated with this connection is a proxy session.

Specified by:: isProxySession in interface OracleConnection

openProxySession

public void openProxySession(int mode,
                             java.util.Properties prop)
                      throws java.sql.SQLException

Description copied from interface: OracleConnection

Opens a new proxy session with the username provided in the prop argument and switch to this new session.

This feature is a thin only feature.

Three proxy types are supported :

OracleConnection.PROXYTYPE_USER_NAME : In this type PROXY_USER_NAME needs to be provided in prop. The value should be a java.lang.String;
OracleConnection.PROXYTYPE_DISTINGUISHED_NAME : In this type PROXY_DISTINGUISHED_NAME has to be set in prop. The value is a java.lang.String object;
OracleConnection.PROXYTYPE_CERTIFICATE : In this type PROXY_CERTIFICATE has to be set in prop. The value is a bytep[] which contains the certificate.

Roles can also be provided in the property argument. The key is OracleConnection.PROXY_ROLES. The value is a String[] which contains the roles.

Specified by:: openProxySession in interface OracleConnection

Throws:: java.sql.SQLException

getAutoClose

public boolean getAutoClose()
                     throws java.sql.SQLException

Description copied from interface: OracleConnection

The driver is always in auto-close mode.

Specified by:: getAutoClose in interface OracleConnection

Returns:: should always return true
Throws:: java.sql.SQLException - should never been raised
See Also:: setAutoClose

getCallWithKey

public java.sql.CallableStatement getCallWithKey(java.lang.String key)
                                          throws java.sql.SQLException

Description copied from interface: OracleConnection

getCallWithKey Searches the explicit cache for a match on key. If found, the statement is returned, with the paramater and define metadata identical to the last usage. If no match is found, or if explicit caching is not enabled, then null is returned (as opposed to throwing an exception).

Specified by:: getCallWithKey in interface OracleConnection

Parameters:: key - Specified key to search for
Throws:: java.sql.SQLException

getDefaultExecuteBatch

public int getDefaultExecuteBatch()

Description copied from interface: OracleConnection

Retrieves the overall connection batch value of this connection.

The batch value from the connection is used for all prepared statements associated with this connection. A different batch value can also be defined for individual prepared statements. This can be done by using OraclePreparedStatement.setExecuteBatch, which will override the default value provided from the connection. Therefore, the batch value returned by this getDefaultExecuteBatch entrypoint is valid for prepared statements for which you have not defined a different batch value.

The following code retrieves the default batch value of the connection conn.
Integer batch_val = ((OracleConnection)conn).getDefaultExecuteBatch();

Specified by:: getDefaultExecuteBatch in interface OracleConnection

Returns:: the batch value
See Also:: OraclePreparedStatement.setExecuteBatch, setDefaultExecuteBatch

getDefaultRowPrefetch

public int getDefaultRowPrefetch()

Description copied from interface: OracleConnection

Retrieves the value of row prefetch for all statements associated with this connection and created after this value was set.

The row-prefetching feature associates an integer row-prefetch setting with a given statement object. JDBC fetches that number of rows at a time from the database during the query. That is, JDBC will fetch N rows that match the query criteria and bring them all back to the client at once, where N is the prefetch setting. Then, once your next calls have run through those N rows, JDBC will go back to fetch the next N rows that match the criteria.

You can set the number of rows to prefetch for a particular Oracle statement (any type of statement). You can also reset the default number of rows that will be prefetched for all statements in your connection with the setDefaultRowPrefetch method. Therefore, the row prefetch value returned by this getDefaultRowPrefetch entrypoint is valid for statements for which you have not defined a different row prefetch value.

The default number of rows to prefetch to the client is 10.

Example where conn is your connection object:
//Get the default row-prefetch setting for this connection int defRowPref = ((OracleConnection)conn).getDefaultRowPrefetch();

Specified by:: getDefaultRowPrefetch in interface OracleConnection

Returns:: the row prefetch value
See Also:: OracleStatement.setRowPrefetch, setDefaultRowPrefetch

getDescriptor

public java.lang.Object getDescriptor(java.lang.String sql_name)

Description copied from interface: OracleConnection

Gets a Descriptor object corresponding to a sql type.

Specified by:: getDescriptor in interface OracleConnection

Parameters:: sql_name - the sql type
Returns:: the Descriptor Object that matches the sql type
See Also:: putDescriptor, oracle.sql.TypeDescriptor

getEndToEndMetrics

public java.lang.String[] getEndToEndMetrics()
                                      throws java.sql.SQLException

Description copied from interface: OracleConnection

Gets the values of the end-to-end metrics, if any. Does not include the sequence number. If DMS is in use and metrics have been set via DMS, this method will return the metrics set via DMS, not those set via setEndToEndMetrics. The DMS metric override the metrics set by setEndToEndMetrics.

Specified by:: getEndToEndMetrics in interface OracleConnection

Throws:: java.sql.SQLException - if an error occurs
See Also:: setEndToEndMetrics

getEndToEndECIDSequenceNumber

public short getEndToEndECIDSequenceNumber()
                                    throws java.sql.SQLException

Description copied from interface: OracleConnection

Gets the current end to end tracing context id sequence number. This could be any of the following values: the value passed in the most recent call to setEndToEndMetrics the value returned by the database after the most recent statement execution the value incremented by JDBC diagnostic messages the value JDBC retrieved from DMS (only in a DMS environment)

Specified by:: getEndToEndECIDSequenceNumber in interface OracleConnection

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

getIncludeSynonyms

public boolean getIncludeSynonyms()

Description copied from interface: OracleConnection

Checks whether or not synonyms information is included in DatabaseMetaData.getColumns. By default and for performance reasons it won't but you can change this with the setIncludeSynonyms method.

Specified by:: getIncludeSynonyms in interface OracleConnection

Returns:: true if DatabaseMetaData.getColumns will report information if a table synonym is passed in, and false otherwise
See Also:: setIncludeSynonyms

getRestrictGetTables

public boolean getRestrictGetTables()

Description copied from interface: OracleConnection

Gets the restriction status of the returned data in DatabaseMetaData.getTables.

The default behavior is to return information about all synonyms, including those which do not point to accessible tables or views. But you can change this with the setRestrictGetTables method.

Specified by:: getRestrictGetTables in interface OracleConnection

Returns:: true if the information returned by DatabaseMetaData.getTables is restricted, and false otherwise
See Also:: setRestrictGetTables

getImplicitCachingEnabled

public boolean getImplicitCachingEnabled()
                                  throws java.sql.SQLException

Description copied from interface: OracleConnection

getImplicitCachingEnabled Returns true if the implicit cache is currently enabled, false otherwise. This method is valid on both logical and physical connections.

Specified by:: getImplicitCachingEnabled in interface OracleConnection

Throws:: java.sql.SQLException

getExplicitCachingEnabled

public boolean getExplicitCachingEnabled()
                                  throws java.sql.SQLException

Description copied from interface: OracleConnection

getExplicitCachingEnabled Returns true if the explicit cache is currently enabled, false otherwise. This method is valid on both logical and physical connections.

Specified by:: getExplicitCachingEnabled in interface OracleConnection

Throws:: java.sql.SQLException

getJavaObject

public java.lang.Object getJavaObject(java.lang.String sql_name)
                               throws java.sql.SQLException

Specified by:: getJavaObject in interface OracleConnection

Throws:: java.sql.SQLException

getRemarksReporting

public boolean getRemarksReporting()

Description copied from interface: OracleConnection

Checks whether or not a call of getTables or getColumns of the DatabaseMetaData interface will report the REMARKS column.

By default and for performance reasons it won't (it will return null) but you can change this with the setRemarksReporting method.

Specified by:: getRemarksReporting in interface OracleConnection

Returns:: true if the DatabaseMetaData calls getTables and getColumns will report the REMARKS column and false otherwise
See Also:: setRemarksReporting

getSQLType

public java.lang.String getSQLType(java.lang.Object obj)
                            throws java.sql.SQLException

Specified by:: getSQLType in interface OracleConnection

Throws:: java.sql.SQLException

getStmtCacheSize

public int getStmtCacheSize()

Specified by:: getStmtCacheSize in interface OracleConnection

getStatementCacheSize

public int getStatementCacheSize()
                          throws java.sql.SQLException

Description copied from interface: OracleConnection

getStatementCacheSize Returns the current size of the application cache. This is valid on both physical and logical connections. If the statement cache has not been initialized with setStatementCacheSize(), then CACHE_SIZE_NOT_SET is returned.

Specified by:: getStatementCacheSize in interface OracleConnection

Throws:: java.sql.SQLException

getStatementWithKey

public java.sql.PreparedStatement getStatementWithKey(java.lang.String key)
                                               throws java.sql.SQLException

Description copied from interface: OracleConnection

getStatementWithKey Searches the explicit cache for a match on key. If found, the statement is returned, with the paramater and define metadata identical to the last usage. If no match is found, or if explicit caching is not enabled, then null is returned (as opposed to throwing an exception).

Specified by:: getStatementWithKey in interface OracleConnection

Parameters:: key - Specified key to search for
Throws:: java.sql.SQLException

getStructAttrCsId

public short getStructAttrCsId()
                        throws java.sql.SQLException

Description copied from interface: OracleConnection

Obtain the Oracle identifier of the character set used in STRUCT attributes. Note that the network transport layer always send structure attributes in the database character set.

Specified by:: getStructAttrCsId in interface OracleConnection

Returns:: the Oracle identifier of the character set.
Throws:: java.sql.SQLException - if Conversion is null
See Also:: oracle.sql.CharacterSet for the set of constants defined for the identifiers."

getUserName

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

Description copied from interface: OracleConnection

Gets the user name of the current connection.

Example where conn is your connection object:
String UserName = ((OracleConnection)conn).getUserName();

Specified by:: getUserName in interface OracleConnection

Returns:: the user name
Throws:: java.sql.SQLException - if the logical connection is closed

getUsingXAFlag

public boolean getUsingXAFlag()

Description copied from interface: OracleConnection

Gets the value of the UsingXA flag which the driver sets to true when using XA to manage distributed transactions. If you are not using distributed transactions with the XA library, the value of the UsingXA flag will be false.

Specified by:: getUsingXAFlag in interface OracleConnection

Returns:: true when using XA to manage distributed transactions and false otherwise.
See Also:: setUsingXAFlag

getXAErrorFlag

public boolean getXAErrorFlag()

Description copied from interface: OracleConnection

Gets the value of the XAError flag which is used with distributed transactions.

When using distributed transactions with an XA library, you can ask the driver to raise exception when doing anything that might require a transaction. To do so, set the value of the XAError flag to true with the method setXAErrorFlag.

The default value is false.

Specified by:: getXAErrorFlag in interface OracleConnection

Returns:: false is the normal JDBC usage. true means that the driver will raise an exception when doing anything that might require a transaction.
See Also:: setXAErrorFlag

oracleSetSavepoint

public OracleSavepoint oracleSetSavepoint()
                                   throws java.sql.SQLException

Description copied from interface: OracleConnection

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

Specified by:: oracleSetSavepoint in interface OracleConnection

Returns:: the new OracleSavepoint object
Throws:: java.sql.SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode
See Also:: OracleSavepoint

oracleSetSavepoint

public OracleSavepoint oracleSetSavepoint(java.lang.String name)
                                   throws java.sql.SQLException

Description copied from interface: OracleConnection

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

Specified by:: oracleSetSavepoint in interface OracleConnection

Parameters:: name - a String containing the name of the savepoint
Returns:: the new OracleSavepoint object
Throws:: java.sql.SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode
See Also:: OracleSavepoint

oracleRollback

public void oracleRollback(OracleSavepoint savepoint)
                    throws java.sql.SQLException

Description copied from interface: OracleConnection

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

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

Specified by:: oracleRollback in interface OracleConnection

Parameters:: savepoint - the OracleSavepoint object to roll back to
Throws:: java.sql.SQLException - if a database access error occurs, the OracleSavepoint object is no longer valid, or this Connection object is currently in auto-commit mode
See Also:: OracleSavepoint

oracleReleaseSavepoint

public void oracleReleaseSavepoint(OracleSavepoint savepoint)
                            throws java.sql.SQLException

Description copied from interface: OracleConnection

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

Specified by:: oracleReleaseSavepoint in interface OracleConnection

Parameters:: savepoint - the OracleSavepoint object to be removed
Throws:: java.sql.SQLException - if a database access error occurs or the given OracleSavepoint object is not a valid savepoint in the current transaction
See Also:: OracleSavepoint

pingDatabase

public int pingDatabase(int timeOut)
                 throws java.sql.SQLException

Description copied from interface: OracleConnection

ping Database

Specified by:: pingDatabase in interface OracleConnection

Throws:: java.sql.SQLException

purgeExplicitCache

public void purgeExplicitCache()
                        throws java.sql.SQLException

Description copied from interface: OracleConnection

purgeExplicitCache Removes all existing statements from the explicit cache, after which it will be empty. This method does not affect the size of the application cache, nor the enabled/disabled status.

Specified by:: purgeExplicitCache in interface OracleConnection

Throws:: java.sql.SQLException

purgeImplicitCache

public void purgeImplicitCache()
                        throws java.sql.SQLException

Description copied from interface: OracleConnection

purgeImplicitCache Removes all existing statements from the implicit cache, after which it will be empty. This method does not affect the size of the application cache, nor the enabled/disabled status.

Specified by:: purgeImplicitCache in interface OracleConnection

Throws:: java.sql.SQLException

putDescriptor

public void putDescriptor(java.lang.String sql_name,
                          java.lang.Object desc)
                   throws java.sql.SQLException

Description copied from interface: OracleConnection

Store the Object Descriptor for later usage.

Specified by:: putDescriptor in interface OracleConnection

Parameters:: sql_name - the sql type; desc - the Object Descriptor associated
Throws:: java.sql.SQLException - if sql_name or desc is null
See Also:: getDescriptor, oracle.sql.TypeDescriptor

registerSQLType

public void registerSQLType(java.lang.String sql_name,
                            java.lang.Class java_class)
                     throws java.sql.SQLException

Specified by:: registerSQLType in interface OracleConnection

Throws:: java.sql.SQLException

registerSQLType

public void registerSQLType(java.lang.String sql_name,
                            java.lang.String java_class_name)
                     throws java.sql.SQLException

Specified by:: registerSQLType in interface OracleConnection

Throws:: java.sql.SQLException

setAutoClose

public void setAutoClose(boolean autoClose)
                  throws java.sql.SQLException

Description copied from interface: OracleConnection

We are always in auto-close mode.

Specified by:: setAutoClose in interface OracleConnection

Parameters:: autoClose - the boolean value
Throws:: java.sql.SQLException - when the argument autoClose is false
See Also:: getAutoClose

setDefaultExecuteBatch

public void setDefaultExecuteBatch(int batch)
                            throws java.sql.SQLException

Description copied from interface: OracleConnection

Sets a default batch value for the Oracle update batching model (the default value is 1).

You can reduce the number of round trips to the database, thereby improving application performance, by grouping multiple UPDATE, DELETE, or INSERT statements into a single "batch" and having the whole batch sent to the database and processed in one trip. To do this, you can either use the Oracle update batching model or the batch updates of the Sun Microsystems JDBC 2.0 specification. The standard model is a manual, explicit model (there is no batch value) whereas the Oracle model is an implicit model.

Note: It is important to be aware that you cannot mix theses models. In any single application, you can use the syntax of one model or the other, but not both. The Oracle JDBC driver will throw exceptions when you mix these syntaxes.

The Oracle update batching feature associates a batch value (limit) with each prepared statement object (this way the driver knows in advance how many operations will be batched). With Oracle update batching, instead of the JDBC driver executing a prepared statement each time its executeUpdate method is called, the driver adds the statement to a batch of accumulated execution requests. The driver will pass all the operations to the database for execution once the batch value is reached. For example, if the batch value is 10, then each batch of 10 operations will be sent to the database and processed in one trip.

The following code sets the default batch value to 20 for all prepared statement objects associated with the conn connection object:

((OracleConnection)conn).setDefaultExecuteBatch(20);

Even though this sets the default batch value for all the prepared statements of the connection, you can override it by calling setDefaultBatch on individual Oracle prepared statements. The connection batch value will apply to statement objects created after this batch value was set.

Note that instead of calling setDefaultExecuteBatch, you can set the defaultBatchValue Java property if you use a Java Properties object in establishing the connection.

Types of Statements Supported. As implemented by Oracle, update batching is intended for use with prepared statements, when you are repeating the same statement with different bind variables. Be aware of the following:

Oracle update batching supports only Oracle prepared statement objects. In an Oracle callable statement, both the connection default batch value and the statement batch value are overridden with a value of 1. In an Oracle generic statement, there is no statement batch value, and the connection default batch value is overridden with a value of 1.
Note that because Oracle update batching is vendor-specific, you must actually use (or cast to) OraclePreparedStatement objects, not general PreparedStatement objects.
To adhere to the JDBC 2.0 standard, Oracle's implementation of standard update batching supports callable statements and generic statements, as well as prepared statements. You can migrate standard update batching syntax into an Oracle JDBC application without difficulty.
You can batch only UPDATE, INSERT, or DELETE operations. Executing a batch that includes an operation that attempts to return a result set will cause an exception.
Note that with standard update batching model, you can use either standard PreparedStatement, CallableStatement, and Statement objects, or Oracle-specific OraclePreparedStatement, OracleCallableStatement, and OracleStatement objects.

Oracle Update Batching Characteristics and Limitations

By default, there is no statement batch value, and the connection (default) batch value is 1.
Batch values between 5 and 30 tend to be the most effective. Setting a very high value might even have a negative effect. It is worth trying different values to verify the effectiveness for your particular application.
Regardless of the batch value in effect, if any of the bind variables of an Oracle prepared statement is (or becomes) a stream type, then the Oracle JDBC driver sets the batch value to 1 and sends any queued requests to the database for execution.
The Oracle JDBC driver automatically executes the sendBatch method of an Oracle prepared statement in any of the following circumstances: 1) the connection receives a COMMIT request, either as a result of invoking the commit method or as a result of auto-commit mode; 2) the statement receives a close request; or 3) the connection receives a close request.
A connection COMMIT request, statement close, or connection close has no effect on a pending batch if you use standard update batching--only if you use Oracle update batching.

Specified by:: setDefaultExecuteBatch in interface OracleConnection

Parameters:: batch - your default batch value (default is 1)
Throws:: java.sql.SQLException - if the argument batch is <=0
See Also:: OraclePreparedStatement.setExecuteBatch, getDefaultExecuteBatch

setDefaultRowPrefetch

public void setDefaultRowPrefetch(int value)
                           throws java.sql.SQLException

Description copied from interface: OracleConnection

Sets the value of row prefetch for all statements associated with this connection and created after this value was set.

You can set the number of rows to prefetch for a particular Oracle statement (any type of statement) but this method allows you to reset the default number of rows that will be prefetched for all statements in your connection. The default number of rows to prefetch to the client is 10.

Use the setDefaultRowPrefetch method to set the default number of rows to prefetch, passing in an integer that specifies the desired default. If you want to check the current setting of the default, then use the getDefaultRowPrefetch method. This method returns an integer.

Example where conn is your connection object:
//Set the default row-prefetch setting for this connection to 7 ((OracleConnection)conn).setDefaultRowPrefetch(7);

Note 1 : A statement object receives the default row-prefetch setting from the associated connection at the time the statement object is created. Subsequent changes to the connection's default row-prefetch setting have no effect on the statement's row-prefetch setting.

Note 2 : If a column of a result set is of datatype LONG or LONG RAW (that is, the streaming types), JDBC changes the statement's row-prefetch setting to 1, even if you never actually read a value of either of those types.

Note 3 : Do not mix the JDBC 2.0 fetch size API and the Oracle row-prefetching API in your application. You can use one or the other but not both.

Specified by:: setDefaultRowPrefetch in interface OracleConnection

Parameters:: value - the number of rows to prefetch
Throws:: java.sql.SQLException - if the argument value is <=0
See Also:: OracleStatement.setRowPrefetch, getDefaultRowPrefetch

setEndToEndMetrics

public void setEndToEndMetrics(java.lang.String[] metrics,
                               short sequenceNumber)
                        throws java.sql.SQLException

Description copied from interface: OracleConnection

Sets the values of the end-to-end tracing metrics. The indices for the array are the END_TO_END_XXX_INDEX values defined in this class. The values set by this method are overridden by any values set via DMS if DMS is in use.

Specified by:: setEndToEndMetrics in interface OracleConnection

Throws:: java.sql.SQLException - if an error occurs
See Also:: getEndToEndMetrics

setExplicitCachingEnabled

public void setExplicitCachingEnabled(boolean cache)
                               throws java.sql.SQLException

Description copied from interface: OracleConnection

setExplicitCachingEnabled Enables or disables the explicit cache. Note that this is independent of the cache size, set with setStatmentCacheSize().

Specified by:: setExplicitCachingEnabled in interface OracleConnection

Parameters:: cache - If true, then explicit caching will be enabled. If false, then any existing statements will be purged and the explicit cache will be disabled.
Throws:: java.sql.SQLException - if called on a logical connection.

setImplicitCachingEnabled

public void setImplicitCachingEnabled(boolean cache)
                               throws java.sql.SQLException

Description copied from interface: OracleConnection

setImplicitCachingEnabled Enables or disables the implicit cache. Note that this is independent of the cache size, set with setStatmentCacheSize().

Specified by:: setImplicitCachingEnabled in interface OracleConnection

Parameters:: cache - If true, then implicit caching will be enabled. If false, then any existing statements will be purged and the implicit cache will be disabled.
Throws:: java.sql.SQLException - if called on a logical connection.

setIncludeSynonyms

public void setIncludeSynonyms(boolean synonyms)

Description copied from interface: OracleConnection

Turns on or off retrieval of synonym information in DatabaseMetaData. getColumns.

Similar to setRemarksReporting, getColumns performs extremely slow if information about synonyms has to be included, because it neccessitates an outer join so, by default, the JDBC driver will not report information about synonyms.

You can get synonym information by passing true to this method, and turn it off by passing false. You can also control this behavior by passing a property named "includeSynonyms" as "true" to DriverManager.getConnection.

Specified by:: setIncludeSynonyms in interface OracleConnection

Parameters:: synonyms - true if you want to retrieve synonym information in DatabaseMetaData.getColumns and false otherwise.
See Also:: getIncludeSynonyms

setRemarksReporting

public void setRemarksReporting(boolean reportRemarks)

Description copied from interface: OracleConnection

Turns on or off the reporting of the REMARKS columns by the getTables and getColumns calls of the DatabaseMetaData interface.

The DatabaseMetaData calls getTables and getColumnsare extremely slow if the REMARKS column has to be reported as this necessitates an expensive outer join so by default the JDBC driver does not report the REMARKS columns.

You can turn the reporting of REMARKS on by passing a true argument to this method. You turn it back off by passing a false argument.

Example where conn is your connection object:
((OracleConnection)conn).setRemarksReporting(true);

You can also control the reporting of REMARKS by passing a property named remarksReporting as true to the DriverManager.getConnection call.

Specified by:: setRemarksReporting in interface OracleConnection

Parameters:: reportRemarks - true if you want to turn on the reporting of the REMARKS columns and false otherwise.
See Also:: getRemarksReporting

setRestrictGetTables

public void setRestrictGetTables(boolean restrict)

Description copied from interface: OracleConnection

Turns on or off the restriction of the returned data in DatabaseMetaData.getTables.

DatabaseMetaData.getTables will return information about all accessible tables, views, and synonyms. There are two issues relating to synonyms which can affect the quality of the returned data:

Public synonyms can exist for tables to which you don't have access. Although the synonym itself is viewable, the underlying table is not.
Synonyms can exist for non-table objects, such as procedures, sequences, Java classes, etc.

As a result of the above issues, getTables can return rows containing objects that are not describable with getColumns, either because they are not accessible (issue 1) or because they are not tables or views (issue 2).

To remedy this, you can restrict the results of getTables to only those tables and views to which you have access. This is done by either passing true to this method, or by passing the restrictGetTables property as true to the DriverManager.getConnection call. The default behavior is to return information about all synonyms, including those which do not point to accessible tables or views.

Note that getTables can return more than one row for the same object, one for the object itself, and additional rows for any synonyms defined for that object. This is the case regardless of the setting for restrictGetTables.

The following code turns on the restriction:
((OracleConnection)conn).setRestrictGetTables(true);

Specified by:: setRestrictGetTables in interface OracleConnection



Parameters:
restrict - true to turn on the restriction and false
    otherwise.
See Also:
getRestrictGetTables





setStmtCacheSize
public void setStmtCacheSize(int size)
                      throws java.sql.SQLException


Specified by:
setStmtCacheSize in interface OracleConnection



Throws:
java.sql.SQLException





setStatementCacheSize
public void setStatementCacheSize(int size)
                           throws java.sql.SQLException

Description copied from interface: OracleConnection
setStatementCacheSize

    Specifies the size of the size of the application cache (which will be 
    used by both implicit and explicit caching).


Specified by:
setStatementCacheSize in interface OracleConnection


Parameters:
size - Requested size of the cache.  If the existing cache size
                is less than size, statements will be purged to reduce the
                size.
Throws:
java.sql.SQLException - if size < 0, or if called on a logical connection.





setStmtCacheSize
public void setStmtCacheSize(int size,
                             boolean clearMetaData)
                      throws java.sql.SQLException


Specified by:
setStmtCacheSize in interface OracleConnection



Throws:
java.sql.SQLException





setUsingXAFlag
public void setUsingXAFlag(boolean value)

Description copied from interface: OracleConnection
When using distributed transactions with XA, you can set the value of the
    UsingXA flag.

    XA is a general standard (not specific to Java) for distributed
    transactions. You should use this method only when using XA.

    
By default, when using distributed transactions with XA, the driver will
    set the UsingXA flag to true and exceptions will
    be raised when you want to do anything with your logical connection that
    might require a transaction. Otherwise the flag UsingXA is
    always false.

    
If you are actually using distributed transactions with XA and you dislike the
    default behavior, you can set the flag back to false.


Specified by:
setUsingXAFlag in interface OracleConnection


Parameters:
value - the value of the UsingXA flag
See Also:
getUsingXAFlag





setXAErrorFlag
public void setXAErrorFlag(boolean value)

Description copied from interface: OracleConnection
Sets the value of the XAError flag which is used with
    distributed transactions. When coexisting with an XA library, you can set
    the XAError flag to true and the driver will then
    raise an exception when doing anything that might require a transaction.


Specified by:
setXAErrorFlag in interface OracleConnection


Parameters:
value - the value of the XAError flag
See Also:
getXAErrorFlag





shutdown
public void shutdown(int mode)
              throws java.sql.SQLException

Description copied from interface: OracleConnection
Not implemented.


Specified by:
shutdown in interface OracleConnection



Throws:
java.sql.SQLException





startup
public void startup(java.lang.String startup_str,
                    int mode)
             throws java.sql.SQLException

Description copied from interface: OracleConnection
Not implemented


Specified by:
startup in interface OracleConnection



Throws:
java.sql.SQLException





prepareStatementWithKey
public java.sql.PreparedStatement prepareStatementWithKey(java.lang.String key)
                                                   throws java.sql.SQLException


Specified by:
prepareStatementWithKey in interface OracleConnection


Parameters:
key - the key with which it was closed
Returns:
a OraclePreparedStatement object
Throws:
java.sql.SQLException - if a database access error occurs





prepareCallWithKey
public java.sql.CallableStatement prepareCallWithKey(java.lang.String key)
                                              throws java.sql.SQLException


Specified by:
prepareCallWithKey in interface OracleConnection


Parameters:
key - the key with which it was closed
Returns:
a oracle.jdbc.driver.CallableStatement object
Throws:
java.sql.SQLException - if a database access error occurs





setCreateStatementAsRefCursor
public void setCreateStatementAsRefCursor(boolean value)

Description copied from interface: OracleConnection
When this is set to true, any new statements created from this
    connection will be created as a REF CURSOR. Only resultsets
    obtained from statements that are created as REF CURSORS can
    be returned from a Java Stored Procedure.  This feature is supported by the
    server-side internal driver only, and is no-op in all other JDBC drivers.

    Default value is false.

    
To use the setCreateStatementAsRefCursor entrypoint you
    have to cast the Connection object to the type
    oracle.jdbc.OracleConnection.


Specified by:
setCreateStatementAsRefCursor in interface OracleConnection


Parameters:
value - true if new statements should be created as
    REF CURSORS, false otherwise
See Also:
getCreateStatementAsRefCursor





getCreateStatementAsRefCursor
public boolean getCreateStatementAsRefCursor()

Description copied from interface: OracleConnection
Retrieves the current setting of the
    createStatementAsRefCursor flag which you can set with the
    setCreateStatementAsRefCursor method.

    To use the getCreateStatementAsRefCursor entrypoint you
    have to cast the Connection object to the type
    oracle.jdbc.OracleConnection.


Specified by:
getCreateStatementAsRefCursor in interface OracleConnection



Returns:
the current setting of the createStatementAsRefCursor flag
See Also:
setCreateStatementAsRefCursor





setSessionTimeZone
public void setSessionTimeZone(java.lang.String regionName)
                        throws java.sql.SQLException

Description copied from interface: OracleConnection
Set the session time zone.
    
    This method is used to set the session time zone.  This method must
    be invoked before accessing any TIMESTAMP WITH LOCAL TIME ZONE data.
    Upon invocation of this method, the Jdbc driver sets the session
    timezone of the connection adnd saves the session timezone so that
    any TSLTZ data accessed via Jdbc are adjusted using the session
    timezone.
    



Specified by:
setSessionTimeZone in interface OracleConnection


Parameters:
regionName - Oracle session time zone region name.
Throws:
java.sql.SQLException - if an error occurred.





getSessionTimeZone
public java.lang.String getSessionTimeZone()

Description copied from interface: OracleConnection
Obtain Oracle session time zone region name.


Specified by:
getSessionTimeZone in interface OracleConnection



Returns:
Oracle session time zone region name.





_getPC
public java.sql.Connection _getPC()

Description copied from interface: OracleConnection
Return the underlying physical connection if this is a 
    logical connection. Returns null otherwise.


Specified by:
_getPC in interface OracleConnection



Returns:
Connection object if its a logical handle otherwise
            returns null





isLogicalConnection
public boolean isLogicalConnection()

Description copied from interface: OracleConnection
Method that returns a boolean indicating whether its
    a logical connection or not.


Specified by:
isLogicalConnection in interface OracleConnection



Returns:
boolean true if this is a logical connection





registerTAFCallback
public void registerTAFCallback(OracleOCIFailover cbk,
                                java.lang.Object obj)
                         throws java.sql.SQLException

Description copied from interface: OracleConnection
Register an application TAF Callback instance that will be called
    when an application failover occurs.  The TAF feature is only
    available in the Jdbc OCI driver.


Specified by:
registerTAFCallback in interface OracleConnection


Parameters:
cbk - Callback instance.
obj - Context object in which any client's state can be
                   stored and provided when the callback method is
                   invoked.
Throws:
java.sql.SQLException - if this method is invoked in drivers other than
                   the Jdbc OCI driver.





getProperties
public java.util.Properties getProperties()

Description copied from interface: OracleConnection
Determines the connection properties.


Specified by:
getProperties in interface OracleConnection


See Also:
properties set during creation





close
public void close(java.util.Properties connAttr)
           throws java.sql.SQLException

Description copied from interface: OracleConnection
Closes the given Logical connection, and returns the underlying
    PooledConnection to the implicit connection cache. The connection
    Attributes is set on the PooledConnection. If the connection
    Attributes passed is null, then a null value is set on the
    PooledConnection as well. When called on a physical connection,
    the connection Attributes passed in has no effect.


Specified by:
close in interface OracleConnection


Parameters:
connAttr - the connection Attributes to be applied
Throws:
java.sql.SQLException - if a database access error occurs





close
public void close(int opt)
           throws java.sql.SQLException

Description copied from interface: OracleConnection
If opt is OracleConnection.INVALID_CONNECTION : Closes
    the given Logical connection, as well the underlying
    PooledConnection without returning the connection to the
    cache when called with the parameter INVALID_CONNECTION. 
    If this API is called on a physical connection, the supplied
    parameter has no effect.
    


    If opt is OracleConnection.PROXY_SESSION : Closes the
    proxy session (opened with openProxySession()).


Specified by:
close in interface OracleConnection


Parameters:
opt - set to INVALID_CONNECTION to close the PooledConnection
Throws:
java.sql.SQLException - if a database access error occurs





applyConnectionAttributes
public void applyConnectionAttributes(java.util.Properties connAttr)
                               throws java.sql.SQLException

Description copied from interface: OracleConnection
Applies the connection Attributes provided on the underlying
    PooledConnection. The connection Attributes set via the
    close API overrides the value set by this API.


Specified by:
applyConnectionAttributes in interface OracleConnection


Parameters:
connAttr - the connection Attributes to be applied
Throws:
java.sql.SQLException - if a database access error occurs





getConnectionAttributes
public java.util.Properties getConnectionAttributes()
                                             throws java.sql.SQLException

Description copied from interface: OracleConnection
Returns the connection Attributes set on the underlying 
    PooledConnection. This API returns null when called on
    a physical connection.


Specified by:
getConnectionAttributes in interface OracleConnection



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





getUnMatchedConnectionAttributes
public java.util.Properties getUnMatchedConnectionAttributes()
                                                      throws java.sql.SQLException

Description copied from interface: OracleConnection
Returns the unmatched connection Attributes from the
    underlying PooledConnection. These are essentially the
    PooledConnection Attributes that did not match the ones
    from the connection request.  This API returns null 
    when called on a physical connection.


Specified by:
getUnMatchedConnectionAttributes in interface OracleConnection



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





registerConnectionCacheCallback
public void registerConnectionCacheCallback(OracleConnectionCacheCallback occc,
                                            java.lang.Object userObj,
                                            int cbkFlag)
                                     throws java.sql.SQLException

Description copied from interface: OracleConnection
Registers the connection cache callback on the logical connection
    This is used in conjunction with the Implicit Connection Cache
    Properties.


Specified by:
registerConnectionCacheCallback in interface OracleConnection


Parameters:
occc - Implementation of the OracleConnectionCacheCallback Interface
userObj - User private object to be passed when invoking callbacks
cbkFlag - Indicates which callback method to invoke. 
                   Supported values are:
                   ABANDONED_CONNECTION_CALLBACK 
                   RELEASE_CONNECTION_CALLBACK 
                   ALL_CONNECTION_CALLBACKS
Throws:
java.sql.SQLException - if a database access error occurs





setConnectionReleasePriority
public void setConnectionReleasePriority(int priority)
                                  throws java.sql.SQLException

Description copied from interface: OracleConnection
Sets connection release priority. Works in conjunction with
    the Connection Cache Callback method RELEASE_CONNECTION_CALLBACK
    Suported release priorities are:
      CONNECTION_RELEASE_LOCKED 
      CONNECTION_RELEASE_LOW 
      CONNECTION_RELEASE_HIGH


Specified by:
setConnectionReleasePriority in interface OracleConnection


Parameters:
priority - one of the above release priority
Throws:
java.sql.SQLException - if a database access error occurs





getConnectionReleasePriority
public int getConnectionReleasePriority()
                                 throws java.sql.SQLException

Description copied from interface: OracleConnection
Returns the release priority set on the connection


Specified by:
getConnectionReleasePriority in interface OracleConnection



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





setPlsqlWarnings
public void setPlsqlWarnings(java.lang.String setting)
                      throws java.sql.SQLException

Description copied from interface: OracleConnection
Enable/Disable PLSQL Compiler Warnings


Specified by:
setPlsqlWarnings in interface OracleConnection


Parameters:
setting - Setting specified for ALTER SESSION SET PLSQL_WARNINGS.
    Sample values are: "'ENABLE:ALL'", "'DISABLE:ALL'",
    "'ENALBLE:INFORMATIONAL'", etc. Please refer to the SQL
    reference of ALTER SESSION SET PLSQL_WARNINGS for
    more information. If the setting is "'DISABLE:ALL'",
    jdbc drivers turn off PLSQL Compiler Warnings.
    Note: the quotes(') in the setting String are necessary.
Throws:
java.sql.SQLException - if a database access error occurs





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


Specified by:
setHoldability in interface java.sql.Connection



Throws:
java.sql.SQLException





getHoldability
public int getHoldability()
                   throws java.sql.SQLException


Specified by:
getHoldability in interface java.sql.Connection



Throws:
java.sql.SQLException





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


Specified by:
setSavepoint in interface java.sql.Connection



Throws:
java.sql.SQLException





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


Specified by:
setSavepoint in interface java.sql.Connection



Throws:
java.sql.SQLException





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


Specified by:
rollback in interface java.sql.Connection



Throws:
java.sql.SQLException





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


Specified by:
releaseSavepoint in interface java.sql.Connection



Throws:
java.sql.SQLException





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


Specified by:
createStatement in interface java.sql.Connection



Throws:
java.sql.SQLException





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


Specified by:
prepareStatement in interface java.sql.Connection



Throws:
java.sql.SQLException





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


Specified by:
prepareCall in interface java.sql.Connection



Throws:
java.sql.SQLException





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


Specified by:
prepareStatement in interface java.sql.Connection



Throws:
java.sql.SQLException





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


Specified by:
prepareStatement in interface java.sql.Connection



Throws:
java.sql.SQLException





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


Specified by:
prepareStatement in interface java.sql.Connection



Throws:
java.sql.SQLException














  
      Overview 
      Package 
    Class 
      Tree 
      Deprecated 
      Index 
      Help 
  



Oracle10g JDBC





 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 






  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD






Copyright � 1998,2004, Oracle. All rights reserved

oracle.jdbc Class OracleConnectionWrapper

TRACE

PRIVATE_TRACE

BUILD_DATE

OracleConnectionWrapper

OracleConnectionWrapper

unwrap

setWrapper

createStatement

prepareStatement

prepareCall

nativeSQL

setAutoCommit

getAutoCommit

commit

rollback

close

isClosed

getMetaData

setReadOnly

isReadOnly

setCatalog

getCatalog

setTransactionIsolation

getTransactionIsolation

getWarnings

clearWarnings

createStatement

prepareStatement

prepareCall

getTypeMap

setTypeMap

isProxySession

openProxySession

archive

getAutoClose

getCallWithKey

getDefaultExecuteBatch

getDefaultRowPrefetch

getDescriptor

getEndToEndMetrics

getEndToEndECIDSequenceNumber

getIncludeSynonyms

getRestrictGetTables

getImplicitCachingEnabled

getExplicitCachingEnabled

getJavaObject

getRemarksReporting

getSQLType

getStmtCacheSize

getStatementCacheSize

getStatementWithKey

getStructAttrCsId

getUserName

getUsingXAFlag

getXAErrorFlag

oracleSetSavepoint

oracleSetSavepoint

oracleRollback

oracleReleaseSavepoint

pingDatabase

purgeExplicitCache

purgeImplicitCache

putDescriptor

registerSQLType

registerSQLType

setAutoClose

setDefaultExecuteBatch

setDefaultRowPrefetch

setEndToEndMetrics

setExplicitCachingEnabled

setImplicitCachingEnabled

setIncludeSynonyms

setRemarksReporting

setRestrictGetTables

setStmtCacheSize

setStatementCacheSize

setStmtCacheSize

setUsingXAFlag

setXAErrorFlag

oracle.jdbc
Class OracleConnectionWrapper