oracle.ucp.jdbc

Class JDBCConnectionPool

java.lang.Object

oracle.ucp.common.UniversalConnectionPoolBase

oracle.ucp.common.UniversalConnectionPoolImpl

oracle.ucp.jdbc.JDBCConnectionPool

All Implemented Interfaces:

oracle.ucp.common.Failoverable, UniversalConnectionPool

Direct Known Subclasses:

ConnectionConnectionPool, OracleJDBCConnectionPool, PooledConnectionConnectionPool

public class JDBCConnectionPool
extends oracle.ucp.common.UniversalConnectionPoolImpl

Base JDBC connection pool.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectionInitializationCallback	m_connectionInitializationCallback

Fields inherited from class oracle.ucp.common.UniversalConnectionPoolImpl

m_ucpInternal

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_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, logWriter, m_connectionAffinityCallback, m_connectionLabelingCallback, m_lifeCycleState, THREAD_POOL_SIZE, totalConnectionsCount

Constructor Summary

Constructors

Constructor and Description
JDBCConnectionPool(JDBCConnectionFactoryAdapter connectionFactoryAdapter) Constructor.

Method Summary

Modifier and Type	Method and Description
UniversalPooledConnection	borrowConnection(ConnectionRetrievalInfo connectionRetrievalInfo) Gets a Universal Pooled Connection from the base pool and enables the statement caching when qualified.
ConnectionInitializationCallback	getConnectionInitializationCallback() Obtains ConnectionInitializationCallback registered on the connection pool.
protected Object	getConnectionObjectForLabelingConfigure(UniversalPooledConnection upc) Public and protected methods used in other packages.
int	getMaxStatements() Gets the maximum number of statements being pooled.
String	getSQLForValidateConnection() Gets the value of the SQLForValidateConnection property.
void	registerConnectionInitializationCallback(ConnectionInitializationCallback cbk) Registers ConnectionInitializationCallback with this connection pool.
protected void	setConnectionFactory(Object connectionFactory)
void	setMaxStatements(int maxStatements) Sets the maximum number of statements to be pooled per connection.
void	setSQLForValidateConnection(String SQLString) Sets the value of the SQLForValidateConnection property.
void	unregisterConnectionInitializationCallback() Removes the ConnectionInitializationCallback object registered with this connection pool, if any.

Methods inherited from class oracle.ucp.common.UniversalConnectionPoolImpl

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

Methods inherited from class oracle.ucp.common.UniversalConnectionPoolBase

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

Methods inherited from class java.lang.Object

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

Field Detail

m_connectionInitializationCallback

protected ConnectionInitializationCallback m_connectionInitializationCallback

Constructor Detail

JDBCConnectionPool

public JDBCConnectionPool(JDBCConnectionFactoryAdapter connectionFactoryAdapter)
                   throws UniversalConnectionPoolException

Constructor.

Throws:

UniversalConnectionPoolException

Method Detail

setSQLForValidateConnection

public void setSQLForValidateConnection(String SQLString)
                                 throws SQLException

Sets the value of the SQLForValidateConnection property. This is a SQL command used in conjunction with the ValidateConnectionOnBorrow property. The SQL specified should be applicable to the backend database and the JDBC driver configured.

Parameters:

SQLString - The SQL string used for connection validation.

Throws:

SQLException

getSQLForValidateConnection

public String getSQLForValidateConnection()

Gets the value of the SQLForValidateConnection property.

Returns:

The SQLForValidateConnection property value.

setMaxStatements

public void setMaxStatements(int maxStatements)
                      throws SQLException

Sets the maximum number of statements to be pooled per connection. Note that this also enables statement pooling.

Parameters:

maxStatements - The maximum number of pooled statements.

Throws:

SQLException

getMaxStatements

public int getMaxStatements()

Gets the maximum number of statements being pooled.

Returns:

The maximum number of statements being pooled.

borrowConnection

public UniversalPooledConnection borrowConnection(ConnectionRetrievalInfo connectionRetrievalInfo)
                                           throws UniversalConnectionPoolException

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 oracle.ucp.common.UniversalConnectionPoolImpl

Parameters:

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

NoAvailableConnectionsException - if all of the connections are in use.

registerConnectionInitializationCallback

public void registerConnectionInitializationCallback(ConnectionInitializationCallback cbk)
                                              throws UniversalConnectionPoolException

Registers ConnectionInitializationCallback with this connection pool.

Parameters:

cbk - The ConnectionInitializationCallback object to be registered.

Throws:

UniversalConnectionPoolException - If there is a callback already registered with this pool.

unregisterConnectionInitializationCallback

public void unregisterConnectionInitializationCallback()
                                                throws UniversalConnectionPoolException

Removes the ConnectionInitializationCallback object registered with this connection pool, if any.

Throws:

UniversalConnectionPoolException - If callback removal fails.

getConnectionInitializationCallback

public ConnectionInitializationCallback getConnectionInitializationCallback()

Obtains ConnectionInitializationCallback registered on the connection pool.

getConnectionObjectForLabelingConfigure

protected Object getConnectionObjectForLabelingConfigure(UniversalPooledConnection upc)

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

Public and protected methods used in other packages.

Overrides:

getConnectionObjectForLabelingConfigure in class oracle.ucp.common.UniversalConnectionPoolImpl

setConnectionFactory

protected void setConnectionFactory(Object connectionFactory)