Package oracle.ucp.jdbc.oracle

Class OracleJDBCConnectionPool

java.lang.Object

oracle.ucp.common.UniversalConnectionPoolBase

oracle.ucp.common.UniversalConnectionPoolImpl

oracle.ucp.jdbc.JDBCConnectionPool

oracle.ucp.jdbc.oracle.OracleJDBCConnectionPool

All Implemented Interfaces:

oracle.ucp.common.Failoverable, RACCallback, RACManagerImpl.RACCallbackExtended, UniversalConnectionPool

Direct Known Subclasses:

OracleConnectionConnectionPool, OraclePooledConnectionConnectionPool

public class OracleJDBCConnectionPool
extends JDBCConnectionPool
implements RACManagerImpl.RACCallbackExtended

Base class for Oracle-specific JDBC connection pools. Subclasses handle particular JDBC connection types, including Connection, PooledConnection, and XAConnection.

Field Summary

Fields inherited from class oracle.ucp.jdbc.JDBCConnectionPool

m_connectionInitializationCallback

Fields inherited from class oracle.ucp.common.UniversalConnectionPoolBase

borrowedAccumulator, borrowedConnectionsCount, borrowedSamples, core, DEFAULT_ABANDONED_CONNECTION_TIMEOUT, DEFAULT_CONNECTION_HARVEST_MAX_COUNT, DEFAULT_CONNECTION_HARVEST_TRIGGER_COUNT, DEFAULT_CONNECTION_VALIDATION_TIMEOUT, DEFAULT_CONNECTION_WAIT_TIMEOUT, DEFAULT_INACTIVE_CONNECTION_TIMEOUT, DEFAULT_INITIAL_POOL_SIZE, DEFAULT_MAX_CONNECTIONS_PER_SERVICE, DEFAULT_MAX_CONNECTIONS_PER_SHARD, DEFAULT_MAX_POOL_SIZE, DEFAULT_MIN_POOL_SIZE, DEFAULT_POOLNAME_PREFIX, DEFAULT_QUERY_TIMEOUT, DEFAULT_SECONDS_TO_TRUST_IDLE_CONNECTION, DEFAULT_TIME_TO_LIVE_CONNECTION_TIMEOUT, DEFAULT_TIMEOUT_CHECK_INTERVAL, DEFAULT_VALIDATE_BORROWED_CONNECTION, FRAMES, HISTOGRAM_STEP, HISTOGRAM_TIME_SPAN, labeledConnectionsCount, logWriter, m_connectionAffinityCallback, m_connectionLabelingCallback, m_lifeCycleState, THREAD_POOL_SIZE, totalConnectionsCount

Fields inherited from class oracle.ucp.common.UniversalConnectionPoolImpl

m_ucpInternal

Constructor Summary

Constructors

Constructor	Description
OracleJDBCConnectionPool(JDBCConnectionFactoryAdapter connectionFactoryAdapter)	Constructor.

Method Summary

Modifier and Type	Method	Description
UniversalPooledConnection	borrowConnection(ConnectionRetrievalInfo cri)	Gets a Universal Pooled Connection from the base pool and enables the statement caching when qualified.
void	closePhysicalConnection(Object physicalConnection)	Closes the physical connection.
UniversalPooledConnection	createOnePooledConnection(ConnectionRetrievalInfo cri)	Creates a physical connection in the pool based on the ConnectionRetrievalInfo
Collection<FailoverablePooledConnection>	getAvailableConnections(ConnectionRetrievalInfo cri)
FailoverablePooledConnection	getAvailableConnectionToInstance(ConnectionRetrievalInfo cri, RACInstance racInstance)
long	getConnectionRepurposeCount()	Returns the number of connection repurposed in a shared pool for a mutitenant database, where connections can be reused across PDB's by switching their container and PDB service.
protected String	getDRCPPLSQLCallbackName(UniversalPooledConnection pc)	DRCP featue is currently available only for OracleConnectionConnectionPool so returning Null by default.
long	getFailedAffinityBasedBorrowCount()	Gets the number of borrow requests that returned connections not matching the affinity contexts.
long	getFailedAffinityBasedBorrowCount(String serviceName)	Gets the number of borrow requests that returned connections not matching the affinity contexts for the particular service
long	getFailedRCLBBasedBorrowCount()	Gets the number of borrow requests that failed using Runtime Connection Load-Balancing (RCLB) algorithms.
long	getFailedRCLBBasedBorrowCount(String serviceName)	Gets the number of borrow requests that failed using Runtime Connection Load-Balancing (RCLB) algorithms for the particular service
String	getFCFProcessingInfo()	Gets the information of recent Fast Connection Failover (FCF) attempts, in the form of a String.
String	getFCFProcessingInfo(String serviceName)	Gets the information of recent Fast Connection Failover (FCF) attempts for a particular service, in the form of a String.
String	getFCFProcessingInfoProcessedOnly()	Gets the information of recent Fast Connection Failover (FCF) attempts for a particular service, in the form of a String only for the processed High Availability(HA) events.
String	getFCFProcessingInfoProcessedOnly(String serviceName)	Gets the information of recent Fast Connection Failover (FCF) attempts for a particular service, in the form of a String only for the processed High Availability(HA) events of a particular service.
String	getPoolName()
int	getRoomToGrowPool()
String	getShardConnectionStats(String serviceName)	Retrieves the connection counts on various shards discovered by UCP so far.
OracleJDBCConnectionPoolStatistics	getStatistics()	Gets the statistics of the connection pool.
long	getSuccessfulAffinityBasedBorrowCount()	Gets the number of borrow requests that succeeded with matching affinity contexts.
long	getSuccessfulAffinityBasedBorrowCount(String serviceName)	Gets the number of borrow requests that succeeded with matching affinity contexts for the particular service
long	getSuccessfulRCLBBasedBorrowCount()	Gets the number of borrow requests that succeeded using Runtime Connection Load-Balancing (RCLB) algorithms.
long	getSuccessfulRCLBBasedBorrowCount(String serviceName)	Gets the number of borrow requests that succeeded using Runtime Connection Load-Balancing (RCLB) algorithms for the particular service
String	getUrl()
void	initiateDownEventProcessing(OracleFailoverEvent event)
int	initiateUpEventProcessing(OracleFailoverEvent event)
protected boolean	isDRCPEnabled(UniversalPooledConnection pc)	DRCP feature is currently available only for OracleConnectionConnectionPool so returing false by default.
protected boolean	isDRCPMultiTagEnabled(UniversalPooledConnection pc)	DRCP feature is currently available only for OracleConnectionConnectionPool so returing false by default.
boolean	isRuntimeLoadBalancingEnabled()	Checks if Runtime Load-Balancing (RLB) is enabled.
boolean	isValid(FailoverablePooledConnection fpc)
void	lbaEventOccurred(OracleLoadBalancingEvent rlbEvent)
protected void	onAddingConnectionToPool(UniversalPooledConnection pooledConnection)
protected void	onRemovingConnectionFromPool(UniversalPooledConnection pooledConnection)
FailoverablePooledConnection	openNewConnection(String url, RACInstance racInstance)
void	registerConnectionAffinityCallback(ConnectionAffinityCallback affCbk)	Registers ConnectionAffinityCallback on the connection pool.
void	removeConnectionAffinityCallback()	Removes the connection affinity callback registered on the connection pool.
void	start()	Starts the connection pool.
void	superClosePhysicalConnection(Object physicalConnection)
void	tearDownConnectionsForInstance(oracle.ucp.jdbc.oracle.rlb.OracleDatabaseInstanceInfo dbInstance, int numConnectionsToTearDown)
void	useStrictWebSessionAffinity(boolean strict)	The knob for switching strict web session affinity
void	useStrictXAAffinity(boolean strict)

Methods inherited from class oracle.ucp.jdbc.JDBCConnectionPool

getConnectionInitializationCallback, getConnectionObjectForLabelingConfigure, getMaxStatements, getProxyFactory, getSQLForValidateConnection, registerConnectionInitializationCallback, setConnectionFactory, setMaxStatements, setProxyFactory, setSQLForValidateConnection, unregisterConnectionInitializationCallback

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ucp.jdbc.oracle.RACCallback

getMaxPoolSize, getMinPoolSize, getTotalConnectionsCount, getValidateConnectionOnBorrow

Methods inherited from class oracle.ucp.common.UniversalConnectionPoolBase

getAbandonedConnectionsCount, getAbandonedConnectionTimeout, getAbandonedConnectionTimer, getAvailableConnectionsCount, getAverageBorrowedConnectionsCount, getBorrowedConnectionsCount, getConnectionAffinityCallback, getConnectionFactoryAdapter, getConnectionHarvestMaxCount, getConnectionHarvestTriggerCount, getConnectionLabelingCallback, getConnectionLabelingHighCost, getConnectionRepurposeThreshold, getConnectionRetrievalInfo, getConnectionValidationTimeout, getConnectionWaitTimeout, getCumulativeConnectionBorrowedCount, getCumulativeConnectionReturnedCount, getCumulativeConnectionsCreated, getCumulativeConnectionUseTime, getCumulativeFailedConnectionWaitCount, getCumulativeFailedConnectionWaitTime, getCumulativeReturnedConnectionCount, getCumulativeSuccessfulConnectionWaitCount, getCumulativeSuccessfulConnectionWaitTime, getDatabaseTopologyInfo, getFailoverEventHandlerTask, getFailoverInfo, getHighCostConnectionReuseThreshold, getInactiveConnectionTimeout, getInactiveConnectionTimer, getInitialPoolSize, getLabeledConnectionsCount, getLifeCycleState, getLoginTimeout, getLogWriter, getMaxConnectionReuseCount, getMaxConnectionReuseTime, getMaxConnectionsPerService, getMaxConnectionsPerShard, getMaxPoolSize, getMinPoolSize, getName, getNeverUsedConnectionsCounter, getONSConfiguration, getPeakConnectionsCount, getPeakConnectionWaitTime, getPendingRequestsCount, getQueryTimeout, getSecondsToTrustIdleConnection, getServiceName, getShardedDatabaseInfo, getShardingMode, getShardRoutingCacheInfo, getTimeoutCheckInterval, getTimeToLiveConnectionTimeout, getTimeToLiveConnectionTimer, getTotalConnectionsCount, getValidateConnectionOnBorrow, handleFailoverEvent, ilogFine, ilogFinest, ilogThrowing, incrementConnectionsClosedCount, incrementConnectionsCreatedCount, insertToAvailableHistogram, insertToBorrowedHistogram, insertToCreatedHistogram, isFailoverEnabled, isFailoverExplicitlySet, isLifecycleFailed, isLifecycleRunning, isLifecycleStarting, isLifecycleStopped, isLifecycleStopping, isOraclePool, isShareable, reconfigure, registerConnectionLabelingCallback, removeConnectionLabelingCallback, resetAllPoolStatistics, resetNonCumulativePoolStatistics, setAbandonedConnectionTimeout, setConnectionHarvestMaxCount, setConnectionHarvestTriggerCount, setConnectionLabelingHighCost, setConnectionRepurposeThreshold, setConnectionRetrievalInfo, setConnectionValidationTimeout, setConnectionWaitTimeout, setFailoverEnabled, setFailoverInfo, setHighCostConnectionReuseThreshold, setInactiveConnectionTimeout, setInitialPoolSize, setLoginTimeout, setLogWriter, setMaxConnectionReuseCount, setMaxConnectionReuseTime, setMaxConnectionsPerService, setMaxConnectionsPerShard, setMaxPoolSize, setMinPoolSize, setName, setONSConfiguration, setOraclePool, setQueryTimeout, setRuntimeLoadBalancingEnabled, setSecondsToTrustIdleConnection, setShardingMode, setShareable, setTimeoutCheckInterval, setTimeToLiveConnectionTimeout, setValidateConnectionOnBorrow, stop, validatePoolSizes

Methods inherited from class oracle.ucp.common.UniversalConnectionPoolImpl

closeConnection, closePooledConnection, closeUsedPhysicalConnection, computeBorrowGiveUpTimestamp, createOnePooledConnection, discardUsedConnection, getAvailableConnection, getUsedConnection, incrementCumulativeConnectionsCreated, isAffinityStrict, isStillOkayToBorrow, needToConfigureConnection, purge, recycle, refresh, returnConnection, returnUsedPhysicalConnection, setConnectionHarvestable, setNoWaitBorrow

Constructor Detail

OracleJDBCConnectionPool

public OracleJDBCConnectionPool(JDBCConnectionFactoryAdapter connectionFactoryAdapter)
                         throws UniversalConnectionPoolException

Constructor.

Parameters:

connectionFactoryAdapter - The connection factory adapter.

Throws:

UniversalConnectionPoolException - If an error occurs constructing this.

Method Detail

createOnePooledConnection

public UniversalPooledConnection createOnePooledConnection(ConnectionRetrievalInfo cri)
                                                    throws UniversalConnectionPoolException

Creates a physical connection in the pool based on the ConnectionRetrievalInfo

Overrides:

createOnePooledConnection in class oracle.ucp.common.UniversalConnectionPoolImpl

Parameters:

connectionRetrievalInfo - Info to use to get the connection.

Returns:

A UniversalPooledConnection for the specified connection retrieval info.

Throws:

UniversalConnectionPoolException - if an error occurs getting a connection.

NoAvailableConnectionsException - if all of the connections are in use.

start

public void start()
           throws UniversalConnectionPoolException

Starts the connection pool.

Specified by:

start in interface UniversalConnectionPool

Overrides:

start in class oracle.ucp.common.UniversalConnectionPoolBase

Throws:

UniversalConnectionPoolException - If an error occurs during start.

isRuntimeLoadBalancingEnabled

public boolean isRuntimeLoadBalancingEnabled()

Checks if Runtime Load-Balancing (RLB) is enabled.

Overrides:

isRuntimeLoadBalancingEnabled in class oracle.ucp.common.UniversalConnectionPoolBase

Returns:

The RLB enabled flag. True for enabled, false for disabled.

tearDownConnectionsForInstance

public void tearDownConnectionsForInstance(oracle.ucp.jdbc.oracle.rlb.OracleDatabaseInstanceInfo dbInstance,
                                           int numConnectionsToTearDown)

Specified by:

tearDownConnectionsForInstance in interface RACManagerImpl.RACCallbackExtended

registerConnectionAffinityCallback

public void registerConnectionAffinityCallback(ConnectionAffinityCallback affCbk)
                                        throws UniversalConnectionPoolException

Description copied from class: oracle.ucp.common.UniversalConnectionPoolBase

Registers ConnectionAffinityCallback on the connection pool.

Specified by:

registerConnectionAffinityCallback in interface UniversalConnectionPool

Overrides:

registerConnectionAffinityCallback in class oracle.ucp.common.UniversalConnectionPoolBase

Parameters:

affCbk - The affinity callback object to be registered.

Throws:

UniversalConnectionPoolException - If callback registration fails.

removeConnectionAffinityCallback

public void removeConnectionAffinityCallback()
                                      throws UniversalConnectionPoolException

Removes the connection affinity callback registered on the connection pool.

Specified by:

removeConnectionAffinityCallback in interface UniversalConnectionPool

Overrides:

removeConnectionAffinityCallback in class oracle.ucp.common.UniversalConnectionPoolBase

Throws:

UniversalConnectionPoolException - If callback removal fails.

getStatistics

public OracleJDBCConnectionPoolStatistics getStatistics()

Gets the statistics of the connection pool.

Specified by:

getStatistics in interface UniversalConnectionPool

Overrides:

getStatistics in class oracle.ucp.common.UniversalConnectionPoolImpl

Returns:

The statistics of the connection pool.

getSuccessfulAffinityBasedBorrowCount

public long getSuccessfulAffinityBasedBorrowCount()

Gets the number of borrow requests that succeeded with matching affinity contexts.

Returns:

The number of borrow requests that succeeded with matching affinity contexts.

getSuccessfulAffinityBasedBorrowCount

public long getSuccessfulAffinityBasedBorrowCount(String serviceName)

Gets the number of borrow requests that succeeded with matching affinity contexts for the particular service

Parameters:

serviceName - The service name for which these statistics are requested.

Returns:

The number of borrow requests that succeeded with matching affinity contexts for the service

getFailedAffinityBasedBorrowCount

public long getFailedAffinityBasedBorrowCount()

Gets the number of borrow requests that returned connections not matching the affinity contexts.

Returns:

The number of borrow requests that returned connections not matching the affinity contexts.

getFailedAffinityBasedBorrowCount

public long getFailedAffinityBasedBorrowCount(String serviceName)

Gets the number of borrow requests that returned connections not matching the affinity contexts for the particular service

Parameters:

serviceName - The service name for which these statistics are requested.

Returns:

The number of borrow requests that returned connections not matching the affinity contexts for the service.

getSuccessfulRCLBBasedBorrowCount

public long getSuccessfulRCLBBasedBorrowCount()

Gets the number of borrow requests that succeeded using Runtime Connection Load-Balancing (RCLB) algorithms.

Returns:

The number of borrow requests that succeeded using Runtime Connection Load-Balancing (RCLB) algorithms.

getSuccessfulRCLBBasedBorrowCount

public long getSuccessfulRCLBBasedBorrowCount(String serviceName)

Gets the number of borrow requests that succeeded using Runtime Connection Load-Balancing (RCLB) algorithms for the particular service

Parameters:

serviceName - The service name for which these statistics are requested.

Returns:

The number of borrow requests that succeeded using Runtime Connection Load-Balancing (RCLB) algorithms for the service.

getFailedRCLBBasedBorrowCount

public long getFailedRCLBBasedBorrowCount()

Gets the number of borrow requests that failed using Runtime Connection Load-Balancing (RCLB) algorithms.

Returns:

The number of borrow requests that failed using Runtime Connection Load-Balancing (RCLB) algorithms.

getFailedRCLBBasedBorrowCount

public long getFailedRCLBBasedBorrowCount(String serviceName)

Gets the number of borrow requests that failed using Runtime Connection Load-Balancing (RCLB) algorithms for the particular service

Parameters:

serviceName - The service name for which these statistics are requested.

Returns:

The number of borrow requests that failed using Runtime Connection Load-Balancing (RCLB) algorithms for the service.

getFCFProcessingInfo

public String getFCFProcessingInfo()

Gets the information of recent Fast Connection Failover (FCF) attempts, in the form of a String. The information returned is to help diagnosing FCF problems, and includes the outcome of each FCF attempt (successful or failed), the relevant RAC instances, the number of connections cleaned up, the exception that triggered the FCF attempt failure, and so forth.

Returns:

The information string for recent FCF attempts.

getFCFProcessingInfo

public String getFCFProcessingInfo(String serviceName)

Gets the information of recent Fast Connection Failover (FCF) attempts for a particular service, in the form of a String. The information returned is to help diagnosing FCF problems, and includes the outcome of each FCF attempt (successful or failed), the relevant RAC instances, the number of connections cleaned up, the exception that triggered the FCF attempt failure, and so forth.

Parameters:

serviceName - The service name for which these statistics are requested.

Returns:

The information string for recent FCF attempts for the service.

getFCFProcessingInfoProcessedOnly

public String getFCFProcessingInfoProcessedOnly()

Gets the information of recent Fast Connection Failover (FCF) attempts for a particular service, in the form of a String only for the processed High Availability(HA) events.

Returns:

The information string for recent FCF attempts for processed event only.

getFCFProcessingInfoProcessedOnly

public String getFCFProcessingInfoProcessedOnly(String serviceName)

Gets the information of recent Fast Connection Failover (FCF) attempts for a particular service, in the form of a String only for the processed High Availability(HA) events of a particular service.

Parameters:

serviceName - The service name for which these statistics are requested.

Returns:

The information string for recent FCF attempts for processed event only for the particular service.

getConnectionRepurposeCount

public long getConnectionRepurposeCount()

Returns the number of connection repurposed in a shared pool for a mutitenant database, where connections can be reused across PDB's by switching their container and PDB service.

getShardConnectionStats

public String getShardConnectionStats(String serviceName)

Retrieves the connection counts on various shards discovered by UCP so far.

Parameters:

serviceName - name of the sharded database service whose stats needs to be fetched.

Returns:

String that contains the connection counts of the currently known shards.

closePhysicalConnection

public void closePhysicalConnection(Object physicalConnection)

Description copied from class: oracle.ucp.common.UniversalConnectionPoolImpl

Closes the physical connection. This method does 2 things: it closes the physical connection by calling ConnectionFactoryAdapter.closeConnection and increments the number of physical connections closed.

Overrides:

closePhysicalConnection in class oracle.ucp.common.UniversalConnectionPoolImpl

Parameters:

physicalConnection - The physcial connection to close.

superClosePhysicalConnection

public void superClosePhysicalConnection(Object physicalConnection)

initiateDownEventProcessing

public void initiateDownEventProcessing(OracleFailoverEvent event)

Specified by:

initiateDownEventProcessing in interface RACCallback

initiateUpEventProcessing

public int initiateUpEventProcessing(OracleFailoverEvent event)

Specified by:

initiateUpEventProcessing in interface RACCallback

openNewConnection

public FailoverablePooledConnection openNewConnection(String url,
                                                      RACInstance racInstance)

Specified by:

openNewConnection in interface RACCallback

getUrl

public String getUrl()

Specified by:

getUrl in interface RACCallback

getPoolName

public String getPoolName()

Specified by:

getPoolName in interface RACCallback

getRoomToGrowPool

public int getRoomToGrowPool()

Specified by:

getRoomToGrowPool in interface RACCallback

isValid

public boolean isValid(FailoverablePooledConnection fpc)

Specified by:

isValid in interface RACCallback

getAvailableConnectionToInstance

public FailoverablePooledConnection getAvailableConnectionToInstance(ConnectionRetrievalInfo cri,
                                                                     RACInstance racInstance)
                                                              throws UniversalConnectionPoolException

Specified by:

getAvailableConnectionToInstance in interface RACCallback

Throws:

UniversalConnectionPoolException

getAvailableConnections

public Collection<FailoverablePooledConnection> getAvailableConnections(ConnectionRetrievalInfo cri)
                                                                 throws UniversalConnectionPoolException

Specified by:

getAvailableConnections in interface RACCallback

Throws:

UniversalConnectionPoolException

lbaEventOccurred

public void lbaEventOccurred(OracleLoadBalancingEvent rlbEvent)
                      throws UniversalConnectionPoolException

Specified by:

lbaEventOccurred in interface RACCallback

Throws:

UniversalConnectionPoolException

borrowConnection

public UniversalPooledConnection borrowConnection(ConnectionRetrievalInfo cri)
                                           throws UniversalConnectionPoolException

Description copied from class: JDBCConnectionPool

Gets a Universal Pooled Connection from the base pool and enables the statement caching when qualified.

Specified by:

borrowConnection in interface UniversalConnectionPool

Overrides:

borrowConnection in class JDBCConnectionPool

Parameters:

cri - Info to use to get the connection.

Returns:

Universal Pooled Connection for the specified connection retrieval info.

Throws:

UniversalConnectionPoolException - if an error occurs getting a connection.

onAddingConnectionToPool

protected void onAddingConnectionToPool(UniversalPooledConnection pooledConnection)

onRemovingConnectionFromPool

protected void onRemovingConnectionFromPool(UniversalPooledConnection pooledConnection)

useStrictWebSessionAffinity

public void useStrictWebSessionAffinity(boolean strict)

The knob for switching strict web session affinity

Parameters:

true - if strict, otherwise nonstrict

useStrictXAAffinity

public void useStrictXAAffinity(boolean strict)

isDRCPEnabled

protected boolean isDRCPEnabled(UniversalPooledConnection pc)
                         throws UniversalConnectionPoolException

DRCP feature is currently available only for OracleConnectionConnectionPool so returing false by default.

Parameters:

pc -

Returns:

false

Throws:

UniversalConnectionPoolException

isDRCPMultiTagEnabled

protected boolean isDRCPMultiTagEnabled(UniversalPooledConnection pc)
                                 throws UniversalConnectionPoolException

DRCP feature is currently available only for OracleConnectionConnectionPool so returing false by default.

Parameters:

pc -

Returns:

false

Throws:

UniversalConnectionPoolException

getDRCPPLSQLCallbackName

protected String getDRCPPLSQLCallbackName(UniversalPooledConnection pc)
                                   throws UniversalConnectionPoolException

DRCP featue is currently available only for OracleConnectionConnectionPool so returning Null by default.

Parameters:

pc -

Returns:

Null

Throws:

UniversalConnectionPoolException