oracle.jdbc.datasource.impl

Class OracleConnectionPoolDataSource

java.lang.Object

oracle.jdbc.datasource.impl.OracleDataSource

oracle.jdbc.datasource.impl.OracleConnectionPoolDataSource

All Implemented Interfaces:

java.io.Serializable, java.sql.Wrapper, javax.naming.Referenceable, javax.sql.CommonDataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource, OracleCommonDataSource, OracleConnectionPoolDataSource, OracleDataSource, Diagnosable, PropertyChangeListener, oracle.jdbc.internal.Monitor

Direct Known Subclasses:

OracleConnectionPoolDataSource, OracleConnectionPoolDataSourceImpl

public class OracleConnectionPoolDataSource
extends OracleDataSource
implements OracleConnectionPoolDataSource, oracle.jdbc.replay.internal.OracleConnectionPoolDataSource

A DataSource object is a factory for Connection objects. An object that implements the DataSource interface will typically be registered with a JNDI service provider. A JDBC driver that is accessed via the DataSource API does not automatically register itself with the DriverManager.

This data source implements the standard JDBC javax.sql.OracleConnectionPoolDataSource and the Oracle JDBC extension oracle.jdbc.datasource.OracleConnectionPoolDataSource interfaces.

This data Source also supports Application Continuity (AC) and transparent JDBC operation replay upon a failover. To disable such feature, set "oracle.jdbc.enableACSupport" to false either as a Java system property, or as a connection property on this data source.

For most common scenarios, use oracle.jdbc.datasource.impl.OracleDataSource, instead of this class. This class is reserved for connection pool developers who build their pools using javax.sql.PooledConnection. For those developers, we strongly recommend to use this data source, instead of older ones, like oracle.jdbc.pool.OracleConnectionPoolDataSource, or oracle.jdbc.replay.OracleConnectionPoolDataSourceImpl. This applies to both standalone and application container use cases.

The following example illustrates the use of this data source to create a JDBC PooledConnection:

  
    oracle.jdbc.datasource.OracleConnectionPoolDataSource ocpds =
      new oracle.jdbc.datasource.impl.OracleConnectionPoolDataSource();
    ocpds.setURL("jdbc:oracle:thin:@//dbhost:dbport/dbservice");
    ocpds.setUser("User");
    ocpds.setPassword("Passwd");
    ocpds.setConnectionProperty("connProp1", "value1");
    ocpds.setConnectionProperty("connProp2", "value2");
 
    javax.sql.PooledConnection pc = ocpds.getPooledConnection();
  
  

The following example illustrates the use of a connection obtained from this data source for Application Continuity protection:

  
    PooledConnection pc = rcpds.getPooledConnection();
    Connection conn = pc.getConnection();  // Implicit request begin
    ......  // JDBC calls protected by Application Continuity
    conn.close();  // Implicit request end
  
  

Since:

21c

See Also:

oracle.jdbc.datasource, oracle.jdbc.datasource.impl, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.jdbc.internal.Monitor

oracle.jdbc.internal.Monitor.CloseableLock, oracle.jdbc.internal.Monitor.WaitableMonitor

Field Summary

Fields inherited from class oracle.jdbc.datasource.impl.OracleDataSource

CHECKSUM_PROPERTY, clientChecksum11203x, clientChecksum12x, connectionProperties, databaseName, dataSourceName, DEFAULT_SERVICE_NAME, description, DMS_DEFAULT_DATASOURCE_NAME, DMS_ROOT_NAME, doneDumpOnMemoryPressure, driver, driverType, ENABLE_AC_SUPPORT_PROPERTY, ENABLE_SSS_CURSOR_SUPPORT_PROPERTY, explicitCachingEnabled, explicitCachingEnabledSet, FAILOVER_RESTORE_AUTO, FAILOVER_RESTORE_LEVEL1, FAILOVER_RESTORE_LEVEL2, FAILOVER_RESTORE_NONE, FAILOVER_RESTORE_PROPERTY, FAILOVER_TYPE_AUTO, FAILOVER_TYPE_ON_REMOTE, FAILOVER_TYPE_PROPERTY, FAILOVER_TYPE_TRANSACTION, IGNORE_AC_CONTEXT_PROPERTY, implicitCachingEnabled, implicitCachingEnabledSet, INITIATION_TIMEOUT_PROPERTY, isAutoACEnabled, isFirstConnection, isHybrid, isOracleDataSource, isReplayInDynamicMode, isSSSCursorEnabled, isStateRestorationAuto, isTransactionReplayEnabled, loginTimeout, logWriter, maxStatements, maxStatementsSet, networkProtocol, password, portNumber, RECONNECT_DELAY_PROPERTY, RECONNECT_RETRIES_PROPERTY, reconnectDelay, reconnectRetries, replayInitiationTimeout, REQUEST_SIZE_LIMIT_PROPERTY, serverName, serviceName, SESSION_STATE_CONSISTENCY_HYBRID, SESSION_STATE_CONSISTENCY_STATIC, SESSION_STATE_PROPERTY, stateRestorationType, tnsEntry, TRACE, trackerInitialized, unnamedInstanceCount, url, user

Fields inherited from interface oracle.jdbc.replay.OracleDataSource

CONNECTION_PROPERTIES, DATA_SOURCE_NAME, DATABASE_NAME, DESCRIPTION, EXPLICIT_CACHING_ENABLED, IMPLICIT_CACHING_ENABLED, MAX_STATEMENTS, NETWORK_PROTOCOL, PASSWORD, PORT_NUMBER, ROLE_NAME, SERVER_NAME, URL, USER

Constructor Summary

Constructors

Constructor and Description
OracleConnectionPoolDataSource()

Method Summary

Modifier and Type	Method and Description
OraclePooledConnectionBuilder	createPooledConnectionBuilder() Creates a new OraclePooledConnectionBuilder instance
java.sql.Connection	getConnection() Attempt to establish a database connection.
java.sql.Connection	getConnection(java.util.Properties props)
java.sql.Connection	getConnection(java.lang.String usr, java.lang.String pwd) Attempt to establish a database connection.
protected java.sql.Connection	getPhysicalConnection() Get a Physical Connection with default url, user name, and password
protected java.sql.Connection	getPhysicalConnection(java.lang.String _user, oracle.jdbc.internal.OpaqueString _passwd) Get a Physical Connection with the user name and password & default URL
protected java.sql.Connection	getPhysicalConnection(java.lang.String _user, java.lang.String _passwd) Get a Physical Connection with the user name and password & default URL
protected java.sql.Connection	getPhysicalConnection(java.lang.String _url, java.lang.String _user, oracle.jdbc.internal.OpaqueString _passwd) Get a Physical Connection with the given url, user name, and password
protected java.sql.Connection	getPhysicalConnection(java.lang.String _url, java.lang.String _user, java.lang.String _passwd) Get a Physical Connection with the given url, user name, and password
javax.sql.PooledConnection	getPooledConnection() Attempt to establish a database connection.
protected OraclePooledConnection	getPooledConnection(OracleConnectionBuilderImpl connBuilder)
javax.sql.PooledConnection	getPooledConnection(java.lang.String _user, java.lang.String _password) Attempt to establish a database connection.

Methods inherited from class oracle.jdbc.datasource.impl.OracleDataSource

addRefProperties, cleanup, clearDoneDumpOnMemoryPressure, clearReplayStatistics, createConnectionBuilder, dms_data_source_type, enableACAndProxifyIfNecessary, finalize, getConnection, getConnection, getConnectionDuringExceptionHandling, getConnectionInitializationCallback, getConnectionNoProxy, getConnectionProperties, getConnectionProperty, getDatabaseName, getDataSourceName, getDescription, getDiagnosable, getDriverType, getExplicitCachingEnabled, getImplicitCachingEnabled, getLoginTimeout, getLogWriter, getMaxStatements, getMonitorLock, getNetworkProtocol, getParentLogger, getPassword, getPhysicalConnection, getPortNumber, getProxyFactory, getReference, getReplayStatistics, getReplayStatisticsString, getRequestSizeLimit, getRoleName, getServerName, getServiceName, getSSSCursorProperty, getSystemProperty, getTNSEntryName, getURL, getUser, isWrapperFor, makeURL, registerConnectionInitializationCallback, registerMBean, removeReplayStatistics, setConnectionProperties, setConnectionProperty, setDatabaseName, setDataSourceName, setDescription, setDriverType, setExplicitCachingEnabled, setHostnameResolver, setImplicitCachingEnabled, setLoginTimeout, setLogWriter, setMaxStatements, setNetworkProtocol, setPassword, setPortNumber, setRoleName, setServerName, setServiceName, setSingleShardTransactionSupport, setSSLContext, setTNSEntryName, setTokenSupplier, setupACSpecificProperties, setURL, setUser, unregisterConnectionInitializationCallback, unregisterMBean, unwrap, updateReplayStatistics

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jdbc.replay.internal.OracleDataSource

clearDoneDumpOnMemoryPressure, getConnectionNoProxy, getProxyFactory, getReplayStatisticsString, getRequestSizeLimit, removeReplayStatistics, updateReplayStatistics

Methods inherited from interface oracle.jdbc.replay.OracleDataSource

clearReplayStatistics, getConnectionInitializationCallback, getExplicitCachingEnabled, getImplicitCachingEnabled, getMaxStatements, getReplayStatistics, getRoleName, registerConnectionInitializationCallback, setExplicitCachingEnabled, setImplicitCachingEnabled, setMaxStatements, setRoleName, unregisterConnectionInitializationCallback

Methods inherited from interface oracle.jdbc.datasource.OracleDataSource

createConnectionBuilder, setExecutorService

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Methods inherited from interface javax.sql.CommonDataSource

getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter

Methods inherited from interface oracle.jdbc.diagnostics.Diagnosable

begin, beginCurrentSql, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debugp, end, endCurrentSql, format, isDebugEnabled, isDiagnoseFirstFailureEnabled, isLoggable, isSensitiveEnabled, onClose, propertyChange, resumeLogging, secure, suspendLogging, trace, tracep

Methods inherited from interface oracle.jdbc.internal.Monitor

acquireCloseableLock, acquireLock, assertLockHeldByCurrentThread, isReentrantLock, newDefaultLock, newInstance, releaseLock

Constructor Detail

OracleConnectionPoolDataSource

public OracleConnectionPoolDataSource()
                               throws java.sql.SQLException

Throws:

java.sql.SQLException

Method Detail

getPooledConnection

public javax.sql.PooledConnection getPooledConnection()
                                               throws java.sql.SQLException

Attempt to establish a database connection.

Specified by:

getPooledConnection in interface javax.sql.ConnectionPoolDataSource

Returns:

a PooledConnection to the database

Throws:

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

getPooledConnection

public javax.sql.PooledConnection getPooledConnection(java.lang.String _user,
                                                      java.lang.String _password)
                                               throws java.sql.SQLException

Attempt to establish a database connection.

Specified by:

getPooledConnection in interface javax.sql.ConnectionPoolDataSource

Parameters:

user - the database user on whose behalf the Connection is being made

password - the user's password

Returns:

a PooledConnection to the database

Throws:

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

getPhysicalConnection

protected java.sql.Connection getPhysicalConnection()
                                             throws java.sql.SQLException

Get a Physical Connection with default url, user name, and password

Throws:

java.sql.SQLException

getPhysicalConnection

protected java.sql.Connection getPhysicalConnection(java.lang.String _url,
                                                    java.lang.String _user,
                                                    java.lang.String _passwd)
                                             throws java.sql.SQLException

Get a Physical Connection with the given url, user name, and password

Throws:

java.sql.SQLException

getPhysicalConnection

protected java.sql.Connection getPhysicalConnection(java.lang.String _user,
                                                    java.lang.String _passwd)
                                             throws java.sql.SQLException

Get a Physical Connection with the user name and password & default URL

Throws:

java.sql.SQLException

getPhysicalConnection

protected java.sql.Connection getPhysicalConnection(java.lang.String _url,
                                                    java.lang.String _user,
                                                    oracle.jdbc.internal.OpaqueString _passwd)
                                             throws java.sql.SQLException

Get a Physical Connection with the given url, user name, and password

Throws:

java.sql.SQLException

getPhysicalConnection

protected java.sql.Connection getPhysicalConnection(java.lang.String _user,
                                                    oracle.jdbc.internal.OpaqueString _passwd)
                                             throws java.sql.SQLException

Get a Physical Connection with the user name and password & default URL

Throws:

java.sql.SQLException

getPooledConnection

protected OraclePooledConnection getPooledConnection(OracleConnectionBuilderImpl connBuilder)
                                              throws java.sql.SQLException

Throws:

java.sql.SQLException

createPooledConnectionBuilder

public OraclePooledConnectionBuilder createPooledConnectionBuilder()
                                                            throws java.sql.SQLException

Description copied from interface: OracleConnectionPoolDataSource

Creates a new OraclePooledConnectionBuilder instance

Specified by:

createPooledConnectionBuilder in interface OracleConnectionPoolDataSource

Returns:

The OraclePooledConnectionBuilder instance that was created

Throws:

java.sql.SQLException - if an error occurs while creating the builder

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Description copied from class: OracleDataSource

Attempt to establish a database connection.

Specified by:

getConnection in interface javax.sql.DataSource

Overrides:

getConnection in class OracleDataSource

Returns:

a Connection to the database

Throws:

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

getConnection

public java.sql.Connection getConnection(java.lang.String usr,
                                         java.lang.String pwd)
                                  throws java.sql.SQLException

Description copied from class: OracleDataSource

Attempt to establish a database connection.

Specified by:

getConnection in interface javax.sql.DataSource

Overrides:

getConnection in class OracleDataSource

Parameters:

usr - the database user on whose behalf the Connection is being made

pwd - the user's password

Returns:

a Connection to the database

Throws:

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

getConnection

public java.sql.Connection getConnection(java.util.Properties props)
                                  throws java.sql.SQLException

Throws:

java.sql.SQLException