PoolDataSource (Oracle Universal Connection Pool Java API Reference, Release 23c)

All Superinterfaces:

javax.sql.CommonDataSource, javax.sql.DataSource, Diagnosable, java.sql.Wrapper

All Known Subinterfaces:

PoolXADataSource

All Known Implementing Classes:

PoolDataSourceImpl, PoolXADataSourceImpl
```
public interface PoolDataSource
extends javax.sql.DataSource, Diagnosable
```
A connection pool-aware data source interface. PoolDataSource uses Universal Connection Pool internally. See setters for pool properties and their default values.
The interface also defines the JNDI property names supported by UCP datasource. These properties can be configured in application servers that support datasource configuration using JNDI feature.
For example, In Tomcat you can define the UCP pool JNDI resource in application's context.xml like below-
```
 
 <Resource name="tomcat/UCPPool" auth="Container" 
 factory="oracle.ucp.jdbc.PoolDataSourceImpl" 
 type="oracle.ucp.jdbc.PoolDataSource"
 description="UCP Pool in Tomcat" 
 connectionFactoryClassName="oracle.jdbc.pool.OracleDataSource"
 user="<user>" 
 password="<password>"
 initialPoolSize="<val>" 
 url="<database_url>" 
 />
 
 
```
See Also:

UniversalConnectionPool

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface PoolDataSource.HostnameResolver

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`PoolDataSource.HostnameResolver`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`SYSTEM_PROPERTY_AFFINITY_STRICT` Strict RAC affinity flag.
`static java.lang.String`	`SYSTEM_PROPERTY_BEGIN_REQUEST_AT_CONNECTION_CREATION` Driver's implicit beginRequest switch.
`static java.lang.String`	`SYSTEM_PROPERTY_CONNECTION_CREATION_RETRY_DELAY` The retry delay for connection creation polling.
`static java.lang.String`	`SYSTEM_PROPERTY_DESTROY_ON_RELOAD` What to do if a new pool with existing pool name gets created.
`static java.lang.String`	`SYSTEM_PROPERTY_DIAGNOSTIC_BUFFER_SIZE` Diagnosability: initial in-memory trace size.
`static java.lang.String`	`SYSTEM_PROPERTY_DIAGNOSTIC_ENABLE_LOGGING` Diagnosability: is debug logging enabled?
`static java.lang.String`	`SYSTEM_PROPERTY_DIAGNOSTIC_ENABLE_TRACE` Diagnosability: is tracing enabled?
`static java.lang.String`	`SYSTEM_PROPERTY_DIAGNOSTIC_ERROR_CODES_TO_WATCH_LIST` Diagnosability: error codes to watch and trigger dumping in-memory tracing buffer into a logger.
`static java.lang.String`	`SYSTEM_PROPERTY_DIAGNOSTIC_LOGGING_LEVEL` Diagnosability: initial logging level.
`static java.lang.String`	`SYSTEM_PROPERTY_ENABLE_SHUTDOWN_HOOK` The shutdown hook of UCP will attempt to gracefully close connections during shutdown by first closing available connections in the pool and then continuously retrying until, eventually, all connections are closed.
`static java.lang.String`	`SYSTEM_PROPERTY_FAN_ENABLED` Driver's High Availability processing switch.
`static java.lang.String`	`SYSTEM_PROPERTY_IMITATE_ASYNC_BORROW` Asynchronous borrow imitation switch.
`static java.lang.String`	`SYSTEM_PROPERTY_MAX_INIT_THREADS` The maximum number of worker threads to reach initial pool size.
`static java.lang.String`	`SYSTEM_PROPERTY_PRE_WLS1212_COMPATIBLE` Pre-WLS 12.1.2 compatibility flag.
`static java.lang.String`	`SYSTEM_PROPERTY_RLB_INOPERABILITY_TIMEOUT` Timeout in seconds for the UCP Runtime Load Balancer to be allowed not to follow RLB advisories in case of inoperability of at least one RAC instance (i.e.
`static java.lang.String`	`SYSTEM_PROPERTY_SELFTUNING` Pool Size self-tuning switch.
`static java.lang.String`	`SYSTEM_PROPERTY_TIMERS_AFFECT_ALL_CONNECTIONS` The switch to change the logic of InactiveConnectionTimeout and MaxConnectionReuseTime handling.
`static java.lang.String`	`SYSTEM_PROPERTY_WLS_JTA` UCP native data source in WebLogic to work with WLS transaction manager for JTA/XA transactions.
`static java.lang.String`	`SYSTEM_PROPERTY_XML_CONFIG_FILE` The XML configuration file path for UCP.
`static java.lang.String`	`UCP_ABANDONED_CONNECTION_TIMEOUT`
`static java.lang.String`	`UCP_CONNECTION_AFFINITY_CALLBACK`
`static java.lang.String`	`UCP_CONNECTION_CREATION_CONSUMER`
`static java.lang.String`	`UCP_CONNECTION_FACTORY_CLASS_NAME`
`static java.lang.String`	`UCP_CONNECTION_FACTORY_PROPERTIES`
`static java.lang.String`	`UCP_CONNECTION_HARVEST_MAX_COUNT`
`static java.lang.String`	`UCP_CONNECTION_HARVEST_TRIGGER_COUNT`
`static java.lang.String`	`UCP_CONNECTION_INITIALIZATION_CALLBACK`
`static java.lang.String`	`UCP_CONNECTION_LABELING_CALLBACK`
`static java.lang.String`	`UCP_CONNECTION_LABELING_HIGH_COST`
`static java.lang.String`	`UCP_CONNECTION_POOL_NAME`
`static java.lang.String`	`UCP_CONNECTION_PROPERTIES`
`static java.lang.String`	`UCP_CONNECTION_REPURPOSE_THRESHOLD`
`static java.lang.String`	`UCP_CONNECTION_VALIDATION_TIMEOUT`
`static java.lang.String`	`UCP_CONNECTION_WAIT_DURATION`
`static java.lang.String`	`UCP_CONNECTION_WAIT_TIMEOUT`
`static java.lang.String`	`UCP_DATA_SOURCE_FROM_CONFIGURATION`
`static java.lang.String`	`UCP_DATA_SOURCE_NAME`
`static java.lang.String`	`UCP_DATABASE_NAME`
`static java.lang.String`	`UCP_DESCRIPTION`
`static java.lang.String`	`UCP_FAST_CONNECTION_FAILOVER_ENABLED`
`static java.lang.String`	`UCP_HIGH_COST_CONNECTION_REUSE_THRESHOLD`
`static java.lang.String`	`UCP_INACTIVE_CONNECTION_TIMEOUT`
`static java.lang.String`	`UCP_INITIAL_POOL_SIZE`
`static java.lang.String`	`UCP_LOGIN_TIMEOUT`
`static java.lang.String`	`UCP_MAX_CONNECTION_REUSE_COUNT`
`static java.lang.String`	`UCP_MAX_CONNECTION_REUSE_TIME`
`static java.lang.String`	`UCP_MAX_CONNECTIONS_PER_SERVICE`
`static java.lang.String`	`UCP_MAX_CONNECTIONS_PER_SHARD`
`static java.lang.String`	`UCP_MAX_IDLE_TIME`
`static java.lang.String`	`UCP_MAX_POOL_SIZE`
`static java.lang.String`	`UCP_MAX_STATEMENTS`
`static java.lang.String`	`UCP_MIN_POOL_SIZE`
`static java.lang.String`	`UCP_NETWORK_PROTOCOL`
`static java.lang.String`	`UCP_NTH_RETURNED_CONNECTION_TO_VALIDATE`
`static java.lang.String`	`UCP_ONS_CONFIGURATION`
`static java.lang.String`	`UCP_PASSWORD`
`static java.lang.String`	`UCP_PDB_ROLES`
`static java.lang.String`	`UCP_PORT_NUMBER`
`static java.lang.String`	`UCP_PROPERTY_CYCLE`
`static java.lang.String`	`UCP_READONLY_INSTANCE_ALLOWED`
`static java.lang.String`	`UCP_ROLE_NAME`
`static java.lang.String`	`UCP_SECONDS_TO_TRUST_IDLE_CONNECTION`
`static java.lang.String`	`UCP_SERVER_NAME`
`static java.lang.String`	`UCP_SERVICE_NAME`
`static java.lang.String`	`UCP_SHARDING_MODE`
`static java.lang.String`	`UCP_SQL_FOR_VALIDATE_CONNECTION`
`static java.lang.String`	`UCP_TIME_TO_LIVE_CONNECTION_TIMEOUT`
`static java.lang.String`	`UCP_TIMEOUT_CHECK_INTERVAL`
`static java.lang.String`	`UCP_URL`
`static java.lang.String`	`UCP_USER`
`static java.lang.String`	`UCP_VALIDATE_CONNECTION_ON_BORROW`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`UCPConnectionBuilder`	`createConnectionBuilder()` Creates a new UCPConnectionBuilder instance.
`default oracle.jdbc.OracleShardingKeyBuilder`	`createShardingKeyBuilder()` Creates a new OracleShardingKeyBuilder instance
`int`	`getAbandonedConnectionTimeout()` Gets the abandoned connection timeout value.
`int`	`getAvailableConnectionsCount()` Gets the number of available connections in the pool.
`int`	`getBorrowedConnectionsCount()` Gets the number of borrowed connections from the pool.
`java.sql.Connection`	`getConnection(java.util.Properties labels)` Attempts to obtain a database connection with the requested connection labels.
`java.sql.Connection`	`getConnection(java.lang.String username, java.lang.String password, java.util.Properties labels)` Attempts to obtain a database connection with the requested connection labels.
`default java.util.function.Consumer<oracle.ucp.ConnectionCreationInformation>`	`getConnectionCreationConsumer()` Obtains the registered connection creation Consumer, if any.
`java.lang.String`	`getConnectionFactoryClassName()` Gets the Connection Factory class name.
`java.util.Properties`	`getConnectionFactoryProperties()` Gets the connection factory properties that are set on this data source.
`java.lang.String`	`getConnectionFactoryProperty(java.lang.String propertyName)` Gets the specified connection factory property that are set on this data source.
`int`	`getConnectionHarvestMaxCount()` Gets the maximum number of connections that may be harvested when the connection harvesting occurs.
`int`	`getConnectionHarvestTriggerCount()` Gets the number of available connections below which the connection pool's connection harvesting will occur.
`ConnectionInitializationCallback`	`getConnectionInitializationCallback()` Obtains the registered connection initialization callback, if any.
`int`	`getConnectionLabelingHighCost()` Obtains the cost value which identifies a connection as "high-cost" for connection labeling.
`java.lang.String`	`getConnectionPoolName()` Gets the connection pool name.
`java.util.Properties`	`getConnectionProperties()` Gets the connection properties that are set on this data source.
`java.lang.String`	`getConnectionProperty(java.lang.String propertyName)` Gets the specified connection property that are set on this data source.
`int`	`getConnectionRepurposeThreshold()` Gets the connection repurpose threshold for the pool.
`int`	`getConnectionValidationTimeout()` Connection validation timeout getter
`java.time.Duration`	`getConnectionWaitDuration()` Gets the maximum time (in seconds) that any connection borrow request can wait before it returns to the application.
`int`	`getConnectionWaitTimeout()` Deprecated.
`java.lang.String`	`getDatabaseName()` Gets the database name.
`java.lang.String`	`getDataSourceName()` Gets the data source name.
`java.lang.String`	`getDescription()` Gets the data source description.
`boolean`	`getFastConnectionFailoverEnabled()` Checks if Fast Connection Failover is enabled.
`int`	`getHighCostConnectionReuseThreshold()` Obtains the high-cost connection reuse threshold property value for connection labeling.
`int`	`getInactiveConnectionTimeout()` Gets the inactive connection timeout.
`int`	`getInitialPoolSize()` Gets the initial pool size.
`int`	`getMaxConnectionReuseCount()` Gets the maximum connection reuse count property value.
`long`	`getMaxConnectionReuseTime()` Gets the maximum connection reuse time property value.
`int`	`getMaxConnectionsPerService()` Gets the maximum number of connections that can be obtained to a particular service, in a shared pool.
`int`	`getMaxConnectionsPerShard()` Gets the currently configured max connections that can be created per shard from this connection pool.
`int`	`getMaxIdleTime()` Gets the maximum idle time.
`int`	`getMaxPoolSize()` Gets the maximum number of connections that the connection pool will maintain.
`int`	`getMaxStatements()` Gets the maximum number of statements that may be pooled or cached on a Connection.
`int`	`getMinPoolSize()` Gets the minimum number of connections that the connection pool will maintain.
`java.lang.String`	`getNetworkProtocol()` Gets the data source network protocol.
`java.lang.String`	`getONSConfiguration()` Returns the ONS configuration string that is used for remote ONS subscription in the form specified in `setONSConfiguration(String)`.
`default java.lang.String`	`getPassword()` Deprecated.
`java.util.Properties`	`getPdbRoles()` Gets the PDB roles specified for this datasource
`int`	`getPortNumber()` Gets the database port number.
`int`	`getPropertyCycle()` Gets the property cycle in seconds.
`int`	`getQueryTimeout()` Gets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds.
`java.lang.String`	`getRoleName()` Gets the data source role name.
`int`	`getSecondsToTrustIdleConnection()` Gets the seconds To Trust Idle Connection value.
`java.lang.String`	`getServerName()` Gets the database server name.
`java.lang.String`	`getServiceName()` Gets the service name set on this data source
`boolean`	`getShardingMode()` Returns the mode of UCP when UCP is using a Sharded Database.
`java.lang.String`	`getSQLForValidateConnection()` Gets the value of the `SQLForValidateConnection` property.
`JDBCConnectionPoolStatistics`	`getStatistics()` Gets the statistics of the connection pool.
`int`	`getTimeoutCheckInterval()` Gets the timeout check interval (in seconds).
`int`	`getTimeToLiveConnectionTimeout()` Gets the maximum time (in seconds) a connection may remain in-use.
`java.lang.String`	`getURL()` Gets the URL for this data source.
`java.lang.String`	`getUser()` Gets the user name for this data source.
`boolean`	`getValidateConnectionOnBorrow()` Returns whether or not a connection being borrowed should first be validated.
`boolean`	`isReadOnlyInstanceAllowed()` Returns true if the connection borrow is allowed to a read-only instance, false otherwise.
`void`	`reconfigureDataSource(java.util.Properties configuration)` Reconfigures the data source.
`void`	`registerConnectionAffinityCallback(ConnectionAffinityCallback cbk)` Registers a connection affinity callback on the connection pool.
`default void`	`registerConnectionCreationConsumer(java.util.function.Consumer<oracle.ucp.ConnectionCreationInformation> consumer)` Registers a connection creation Consumer.
`void`	`registerConnectionInitializationCallback(ConnectionInitializationCallback cbk)` Registers a connection initialization callback.
`void`	`registerConnectionLabelingCallback(ConnectionLabelingCallback cbk)` Registers a connection labeling callback with the underlying connection pool.
`void`	`removeConnectionAffinityCallback()` Removes the `ConnectionAffinityCallback` object registered on the connection pool.
`void`	`removeConnectionLabelingCallback()` Removes the `ConnectionLabelingCallback` object registered with the underlying connection pool, if any.
`void`	`setAbandonedConnectionTimeout(int abandonedConnectionTimeout)` Sets the abandoned connection timeout.
`void`	`setConnectionFactoryClassName(java.lang.String factoryClassName)` Sets the Connection Factory class name.
`void`	`setConnectionFactoryProperties(java.util.Properties factoryProperties)` Sets the connection factory properties on the connection factory.
`void`	`setConnectionFactoryProperty(java.lang.String name, java.lang.String value)` Sets a connection factory property on the connection factory.
`void`	`setConnectionHarvestMaxCount(int connectionHarvestMaxCount)` Sets the maximum number of connections that may be harvested when the connection harvesting occurs.
`void`	`setConnectionHarvestTriggerCount(int connectionHarvestTriggerCount)` Sets the number of available connections below which the connection pool's connection harvesting will occur.
`void`	`setConnectionLabelingHighCost(int highCost)` Sets the cost value which identifies a connection as "high-cost" for connection labeling.
`void`	`setConnectionPoolName(java.lang.String connectionpoolName)` Sets the connection pool name.
`void`	`setConnectionProperties(java.util.Properties connectionProperties)` Sets the connection properties on the connection factory.
`void`	`setConnectionProperty(java.lang.String name, java.lang.String value)` Sets a connection property on the connection factory.
`void`	`setConnectionRepurposeThreshold(int threshold)` Sets the connection repurpose threshold for the pool.
`void`	`setConnectionValidationTimeout(int connectionValidationTimeout)` This property changes the connection validation timeout which is specified in seconds.
`void`	`setConnectionWaitDuration(java.time.Duration waitDuration)` Configures how much time a connection request call may wait before it either successfully returns a connection or throws an exception.
`void`	`setConnectionWaitTimeout(int waitTimeout)` Deprecated.
`void`	`setDatabaseName(java.lang.String databaseName)` Sets the database name.
`void`	`setDataSourceName(java.lang.String dataSourceName)` Sets the data source name.
`void`	`setDescription(java.lang.String description)` Sets the data source description.
`void`	`setFastConnectionFailoverEnabled(boolean failoverEnabled)` Enables Fast Connection Failover (FCF) for the connection pool accessed using this pool-enabled data source.
`void`	`setHighCostConnectionReuseThreshold(int threshold)` Sets the high-cost connection reuse threshold for connection labeling.
`void`	`setHostnameResolver(PoolDataSource.HostnameResolver hostnameResolver)` Specifies a `PoolDataSource.HostnameResolver` to use by the pool
`void`	`setInactiveConnectionTimeout(int inactivityTimeout)` Sets the inactive connection timeout.
`void`	`setInitialPoolSize(int initialPoolSize)` Sets the initial pool size.
`void`	`setMaxConnectionReuseCount(int maxConnectionReuseCount)` Sets the maximum connection reuse count property.
`void`	`setMaxConnectionReuseTime(long maxConnectionReuseTime)` Sets the maximum connection reuse time property.
`void`	`setMaxConnectionsPerShard(int maxConnectionsPerShard)` Sets the max number of connections that can be created per shard from this connection pool.
`void`	`setMaxIdleTime(int idleTime)` Sets the maximum idle time for available connections in the pool.
`void`	`setMaxPoolSize(int maxPoolSize)` Sets the maximum number of connections.
`void`	`setMaxStatements(int maxStatements)` Sets the maximum number of statements that may be pooled or cached on a connection.
`void`	`setMinPoolSize(int minPoolSize)` Sets the minimum number of connections.
`void`	`setNetworkProtocol(java.lang.String networkProtocol)` Sets the data source network protocol.
`void`	`setONSConfiguration(java.lang.String onsConfigStr)` Sets the configuration string used for remote ONS subscription.
`void`	`setPassword(java.lang.String pd)` Sets the password with which connections have to be obtained.
`void`	`setPortNumber(int portNumber)` Sets the database port number.
`void`	`setPropertyCycle(int propertyCycle)` Sets the property cycle in seconds.
`void`	`setQueryTimeout(int queryTimeout)` Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds.
`void`	`setReadOnlyInstanceAllowed(boolean readOnlyInstanceAllowed)` Sets the read-only instance allowed value on the datasource.
`void`	`setRoleName(java.lang.String roleName)` Sets the data source role name.
`void`	`setSecondsToTrustIdleConnection(int secondsToTrustIdleConnection)` Sets the time in seconds to trust an idle connection to skip a validation test.
`void`	`setServerName(java.lang.String serverName)` Sets the database server name.
`void`	`setShardingMode(boolean shardingMode)` This API changes the mode of UCP when UCP is using a Sharded Database.
`void`	`setSQLForValidateConnection(java.lang.String SQLString)` Sets the value of the `SQLForValidateConnection` property.
`void`	`setSSLContext(javax.net.ssl.SSLContext sslContext)` Specifies a `SSLContext` to use as a factory for SSLEngine objects that carry out the TLS protocol.
`void`	`setTimeoutCheckInterval(int timeInterval)` Sets the timeoutCheckInterval (in seconds).
`void`	`setTimeToLiveConnectionTimeout(int timeToLiveConnectionTimeout)` Sets the maximum time (in seconds) a connection may remain in-use.
`void`	`setTokenSupplier(java.util.function.Supplier<? extends oracle.jdbc.AccessToken> tokenSupplier)` Sets a supplier function that generates an access token when creating a connection with this `DataSource`.
`void`	`setURL(java.lang.String url)` Sets the URL that the data source uses to obtain connections to the database.
`void`	`setUser(java.lang.String userName)` Sets the user name with which connections have to be obtained.
`void`	`setValidateConnectionOnBorrow(boolean validateConnectionOnBorrow)` Makes the pool validate the connection before returning it to the user by calling the JDBC API "isValid".
`default void`	`unregisterConnectionCreationConsumer()` Unregisters the connection creation Consumer on this pool.
`void`	`unregisterConnectionInitializationCallback()` Unregisters the connection initialization callback on this pool.

Methods inherited from interface javax.sql.DataSource
getConnection, getConnection

Methods inherited from interface javax.sql.CommonDataSource
getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter

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

Methods inherited from interface oracle.ucp.diagnostics.Diagnosable
beginCurrentSql, debug, debug, endCurrentSql, format, getDiagnosable, isLoggingLevelFinest, resumeLogging, secure, suspendLogging, trace, trace

- Field Detail
  - SYSTEM_PROPERTY_AFFINITY_STRICT
```
static final java.lang.String SYSTEM_PROPERTY_AFFINITY_STRICT
```
    Strict RAC affinity flag.
    This system property indicates whether RAC affinity is strict or not. The default value is "false".
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_MAX_INIT_THREADS
```
static final java.lang.String SYSTEM_PROPERTY_MAX_INIT_THREADS
```
    The maximum number of worker threads to reach initial pool size.
    This system property defines how many worker threads will perticipate in connection pool warming up creating designated number of initial connections. The default value is 4.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_PRE_WLS1212_COMPATIBLE
```
static final java.lang.String SYSTEM_PROPERTY_PRE_WLS1212_COMPATIBLE
```
    Pre-WLS 12.1.2 compatibility flag.
    This system property defines whether we should operate in pre-WLS 12.1.2 compatible mode or not. If the property value is "true", we'll be backward-compatible with WLS 10.3.6 and 12.1.1. This is a transient property that will be removed in a future version/patch. The default value is "false".
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_CONNECTION_CREATION_RETRY_DELAY
```
static final java.lang.String SYSTEM_PROPERTY_CONNECTION_CREATION_RETRY_DELAY
```
    The retry delay for connection creation polling.
    When a database is inoperable, UCP makes periodic connection creation reattempts. This system property defined the re-attempt timeout in milliseconds. The default value is 3000 milliseconds.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_FAN_ENABLED
```
static final java.lang.String SYSTEM_PROPERTY_FAN_ENABLED
```
    Driver's High Availability processing switch.
    This system property is the flag for disabling Oracle JDBC driver's High Availability processing. This applies to both UCP and WLS AGL use cases. The default value is "false".
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_BEGIN_REQUEST_AT_CONNECTION_CREATION
```
static final java.lang.String SYSTEM_PROPERTY_BEGIN_REQUEST_AT_CONNECTION_CREATION
```
    Driver's implicit beginRequest switch.
    This system property is the flag for disabling Oracle JDBC driver's implicit beginRequest for Auto-AC (Automatic Application Continuity). This applies to both UCP and WLS AGL use cases. The default value is "false".
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_XML_CONFIG_FILE
```
static final java.lang.String SYSTEM_PROPERTY_XML_CONFIG_FILE
```
    The XML configuration file path for UCP.
    This system property defines the pathname for an XML file to read and interpret for automatic UCP configuring. No default value (empty string).
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_DESTROY_ON_RELOAD
```
static final java.lang.String SYSTEM_PROPERTY_DESTROY_ON_RELOAD
```
    What to do if a new pool with existing pool name gets created.
    This system property is the flag instructing whether to destroy a pool or throw the "pool already exists" exception if there is an attempt to create a new pool with the name of existing pool. This feature has been implemented per JBoss request because thir reload procedure recreates a pool with the same name expecting the old one is implicitly gets destroyed. The traditional pool's behavior in this case is to throw the exception. The default value is "false".
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_IMITATE_ASYNC_BORROW
```
static final java.lang.String SYSTEM_PROPERTY_IMITATE_ASYNC_BORROW
```
    Asynchronous borrow imitation switch.
    This system property is the flag defining whether to run real asynchronous borrow mechanism or its imitation through blocking borrow. This property is introduced for debugging and testing purposes. The default value is "false".
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_SELFTUNING
```
static final java.lang.String SYSTEM_PROPERTY_SELFTUNING
```
    Pool Size self-tuning switch.
    This system property is the flag to enable or disable pool size self-tuning. If self-tuning is enabled, UCP will try to keep pool's working set of connection to be able to effectively serve recent number of connection borrow requests. Self-tuning mechanism will not bring the working set of connections beyond designated pool bounds (minumum and maximum pool size). The default value is "false", i.e. self-tuning is disabled.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_WLS_JTA
```
static final java.lang.String SYSTEM_PROPERTY_WLS_JTA
```
    UCP native data source in WebLogic to work with WLS transaction manager for JTA/XA transactions.
    This system property is the flag that allows UCP native data source in WebLogic to work with WLS transaction manager for JTA/XA transactions. The feature is disabled by default, and can be enabled by setting the system property to true.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_TIMERS_AFFECT_ALL_CONNECTIONS
```
static final java.lang.String SYSTEM_PROPERTY_TIMERS_AFFECT_ALL_CONNECTIONS
```
    The switch to change the logic of InactiveConnectionTimeout and MaxConnectionReuseTime handling.
    This system property changes the behavior of InactiveConnectionTimeout and MaxConnectionReuseTime: if set to false, a pool will be reduced down to minPoolSize, other connections, even if applicable, will be left opened and not replaced. If set to false and the number of idle connections is equal to the min pool size, then these timeouts are ignored. If set to true, the timeouts are enforced and will affect connections even if the number of idle connections is smaller than the min pool size. This will cause idle connections to be purged and re-created. The default value is "false".
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_DIAGNOSTIC_ENABLE_TRACE
```
static final java.lang.String SYSTEM_PROPERTY_DIAGNOSTIC_ENABLE_TRACE
```
    Diagnosability: is tracing enabled?
    This system property is the flag for enabling diagnosability tracing. Initial state for a flag allowing publishing a trace into DiagnosticsCollector's memory handlers. Tracing in this context is a collecting logging messages into an in-memory ring buffer. The default value is "true".
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_DIAGNOSTIC_ENABLE_LOGGING
```
static final java.lang.String SYSTEM_PROPERTY_DIAGNOSTIC_ENABLE_LOGGING
```
    Diagnosability: is debug logging enabled?
    Initial state for a flag allowing publishing a trace into DiagnosticsCollector's debug logger. Logging is the same as the Java logging API. The default value is "false".
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_DIAGNOSTIC_BUFFER_SIZE
```
static final java.lang.String SYSTEM_PROPERTY_DIAGNOSTIC_BUFFER_SIZE
```
    Diagnosability: initial in-memory trace size.
    Initial size of a Diagnosability in-memory tracing buffers. The default value is 1024 log messages.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_DIAGNOSTIC_LOGGING_LEVEL
```
static final java.lang.String SYSTEM_PROPERTY_DIAGNOSTIC_LOGGING_LEVEL
```
    Diagnosability: initial logging level.
    This system property defines the default logging level for all loggers. Every logger, if not explicitly leveled in the logging config file, will be leveled with this level. The default value is Level.INFO.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_DIAGNOSTIC_ERROR_CODES_TO_WATCH_LIST
```
static final java.lang.String SYSTEM_PROPERTY_DIAGNOSTIC_ERROR_CODES_TO_WATCH_LIST
```
    Diagnosability: error codes to watch and trigger dumping in-memory tracing buffer into a logger.
    This system property defined the comma separated list of SQLException and UniversalConnectionPoolException error codes to trigger in-memory buffer dump into an appropriate logger. The default value is empty list, nothing.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_ENABLE_SHUTDOWN_HOOK
```
static final java.lang.String SYSTEM_PROPERTY_ENABLE_SHUTDOWN_HOOK
```
    The shutdown hook of UCP will attempt to gracefully close connections during shutdown by first closing available connections in the pool and then continuously retrying until, eventually, all connections are closed. Note that any pending transaction will be rolled back. This shutdown hook is enabled by default, but can be disabled by setting this system property to false.
    -Doracle.ucp.enableShutdownHook=false
    
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_RLB_INOPERABILITY_TIMEOUT
```
static final java.lang.String SYSTEM_PROPERTY_RLB_INOPERABILITY_TIMEOUT
```
    Timeout in seconds for the UCP Runtime Load Balancer to be allowed not to follow RLB advisories in case of inoperability of at least one RAC instance (i.e. if an instance is UP but throws SQLRecoverableException on an attempt to create a connection on it).
    
    See Also:
    
    Constant Field Values
  - UCP_USER
```
static final java.lang.String UCP_USER
```
    See Also:
    
    Constant Field Values
  - UCP_URL
```
static final java.lang.String UCP_URL
```
    See Also:
    
    Constant Field Values
  - UCP_PASSWORD
```
static final java.lang.String UCP_PASSWORD
```
    See Also:
    
    Constant Field Values
  - UCP_SERVER_NAME
```
static final java.lang.String UCP_SERVER_NAME
```
    See Also:
    
    Constant Field Values
  - UCP_PORT_NUMBER
```
static final java.lang.String UCP_PORT_NUMBER
```
    See Also:
    
    Constant Field Values
  - UCP_DATABASE_NAME
```
static final java.lang.String UCP_DATABASE_NAME
```
    See Also:
    
    Constant Field Values
  - UCP_DATA_SOURCE_NAME
```
static final java.lang.String UCP_DATA_SOURCE_NAME
```
    See Also:
    
    Constant Field Values
  - UCP_DESCRIPTION
```
static final java.lang.String UCP_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - UCP_NETWORK_PROTOCOL
```
static final java.lang.String UCP_NETWORK_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - UCP_ROLE_NAME
```
static final java.lang.String UCP_ROLE_NAME
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_FACTORY_CLASS_NAME
```
static final java.lang.String UCP_CONNECTION_FACTORY_CLASS_NAME
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_PROPERTIES
```
static final java.lang.String UCP_CONNECTION_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_FACTORY_PROPERTIES
```
static final java.lang.String UCP_CONNECTION_FACTORY_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - UCP_VALIDATE_CONNECTION_ON_BORROW
```
static final java.lang.String UCP_VALIDATE_CONNECTION_ON_BORROW
```
    See Also:
    
    Constant Field Values
  - UCP_SQL_FOR_VALIDATE_CONNECTION
```
static final java.lang.String UCP_SQL_FOR_VALIDATE_CONNECTION
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_POOL_NAME
```
static final java.lang.String UCP_CONNECTION_POOL_NAME
```
    See Also:
    
    Constant Field Values
  - UCP_INITIAL_POOL_SIZE
```
static final java.lang.String UCP_INITIAL_POOL_SIZE
```
    See Also:
    
    Constant Field Values
  - UCP_MIN_POOL_SIZE
```
static final java.lang.String UCP_MIN_POOL_SIZE
```
    See Also:
    
    Constant Field Values
  - UCP_MAX_POOL_SIZE
```
static final java.lang.String UCP_MAX_POOL_SIZE
```
    See Also:
    
    Constant Field Values
  - UCP_NTH_RETURNED_CONNECTION_TO_VALIDATE
```
static final java.lang.String UCP_NTH_RETURNED_CONNECTION_TO_VALIDATE
```
    See Also:
    
    Constant Field Values
  - UCP_ABANDONED_CONNECTION_TIMEOUT
```
static final java.lang.String UCP_ABANDONED_CONNECTION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - UCP_TIME_TO_LIVE_CONNECTION_TIMEOUT
```
static final java.lang.String UCP_TIME_TO_LIVE_CONNECTION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - UCP_INACTIVE_CONNECTION_TIMEOUT
```
static final java.lang.String UCP_INACTIVE_CONNECTION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - UCP_MAX_IDLE_TIME
```
static final java.lang.String UCP_MAX_IDLE_TIME
```
    See Also:
    
    Constant Field Values
  - UCP_TIMEOUT_CHECK_INTERVAL
```
static final java.lang.String UCP_TIMEOUT_CHECK_INTERVAL
```
    See Also:
    
    Constant Field Values
  - UCP_PROPERTY_CYCLE
```
static final java.lang.String UCP_PROPERTY_CYCLE
```
    See Also:
    
    Constant Field Values
  - UCP_MAX_STATEMENTS
```
static final java.lang.String UCP_MAX_STATEMENTS
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_WAIT_TIMEOUT
```
static final java.lang.String UCP_CONNECTION_WAIT_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_WAIT_DURATION
```
static final java.lang.String UCP_CONNECTION_WAIT_DURATION
```
    See Also:
    
    Constant Field Values
  - UCP_MAX_CONNECTION_REUSE_TIME
```
static final java.lang.String UCP_MAX_CONNECTION_REUSE_TIME
```
    See Also:
    
    Constant Field Values
  - UCP_MAX_CONNECTION_REUSE_COUNT
```
static final java.lang.String UCP_MAX_CONNECTION_REUSE_COUNT
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_HARVEST_TRIGGER_COUNT
```
static final java.lang.String UCP_CONNECTION_HARVEST_TRIGGER_COUNT
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_HARVEST_MAX_COUNT
```
static final java.lang.String UCP_CONNECTION_HARVEST_MAX_COUNT
```
    See Also:
    
    Constant Field Values
  - UCP_FAST_CONNECTION_FAILOVER_ENABLED
```
static final java.lang.String UCP_FAST_CONNECTION_FAILOVER_ENABLED
```
    See Also:
    
    Constant Field Values
  - UCP_ONS_CONFIGURATION
```
static final java.lang.String UCP_ONS_CONFIGURATION
```
    See Also:
    
    Constant Field Values
  - UCP_SECONDS_TO_TRUST_IDLE_CONNECTION
```
static final java.lang.String UCP_SECONDS_TO_TRUST_IDLE_CONNECTION
```
    See Also:
    
    Constant Field Values
  - UCP_MAX_CONNECTIONS_PER_SERVICE
```
static final java.lang.String UCP_MAX_CONNECTIONS_PER_SERVICE
```
    See Also:
    
    Constant Field Values
  - UCP_LOGIN_TIMEOUT
```
static final java.lang.String UCP_LOGIN_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - UCP_SERVICE_NAME
```
static final java.lang.String UCP_SERVICE_NAME
```
    See Also:
    
    Constant Field Values
  - UCP_PDB_ROLES
```
static final java.lang.String UCP_PDB_ROLES
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_AFFINITY_CALLBACK
```
static final java.lang.String UCP_CONNECTION_AFFINITY_CALLBACK
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_INITIALIZATION_CALLBACK
```
static final java.lang.String UCP_CONNECTION_INITIALIZATION_CALLBACK
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_CREATION_CONSUMER
```
static final java.lang.String UCP_CONNECTION_CREATION_CONSUMER
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_LABELING_CALLBACK
```
static final java.lang.String UCP_CONNECTION_LABELING_CALLBACK
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_LABELING_HIGH_COST
```
static final java.lang.String UCP_CONNECTION_LABELING_HIGH_COST
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_REPURPOSE_THRESHOLD
```
static final java.lang.String UCP_CONNECTION_REPURPOSE_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - UCP_HIGH_COST_CONNECTION_REUSE_THRESHOLD
```
static final java.lang.String UCP_HIGH_COST_CONNECTION_REUSE_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - UCP_DATA_SOURCE_FROM_CONFIGURATION
```
static final java.lang.String UCP_DATA_SOURCE_FROM_CONFIGURATION
```
    See Also:
    
    Constant Field Values
  - UCP_MAX_CONNECTIONS_PER_SHARD
```
static final java.lang.String UCP_MAX_CONNECTIONS_PER_SHARD
```
    See Also:
    
    Constant Field Values
  - UCP_SHARDING_MODE
```
static final java.lang.String UCP_SHARDING_MODE
```
    See Also:
    
    Constant Field Values
  - UCP_CONNECTION_VALIDATION_TIMEOUT
```
static final java.lang.String UCP_CONNECTION_VALIDATION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - UCP_READONLY_INSTANCE_ALLOWED
```
static final java.lang.String UCP_READONLY_INSTANCE_ALLOWED
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getInitialPoolSize
```
int getInitialPoolSize()
```
    Gets the initial pool size.
    
    Returns:
    
    the initial pool size.
  - setInitialPoolSize
```
void setInitialPoolSize(int initialPoolSize)
                 throws java.sql.SQLException
```
    Sets the initial pool size. This is the number of connections that will be created and placed in the pool when the pool is started.
    The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 0.
    
    Parameters:
    
    initialPoolSize - the initial pool size.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set size.
  - getMinPoolSize
```
int getMinPoolSize()
```
    Gets the minimum number of connections that the connection pool will maintain.
    
    Returns:
    
    The minimum number of connections.
  - setMinPoolSize
```
void setMinPoolSize(int minPoolSize)
             throws java.sql.SQLException
```
    Sets the minimum number of connections. If the number of available connections PLUS the number of connections in use IS LESS THAN the minimum then the connection is returned to the pool. Otherwise, the connection is closed.
    The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. The default is 1 connection.
    
    Parameters:
    
    minPoolSize - The minimum number of connections.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set min pool size.
  - getMaxPoolSize
```
int getMaxPoolSize()
```
    Gets the maximum number of connections that the connection pool will maintain.
    
    Returns:
    
    The maximum number of connections.
  - setMaxPoolSize
```
void setMaxPoolSize(int maxPoolSize)
             throws java.sql.SQLException
```
    Sets the maximum number of connections. The maximum number of connections includes the number of connections that are in use as well as the number of available connections.
    The range of valid values is 1 to Integer.MAX_VALUE. Default is 8 connections.
    
    Parameters:
    
    maxPoolSize - The maximum number of connections.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set max pool size.
  - getInactiveConnectionTimeout
```
int getInactiveConnectionTimeout()
```
    Gets the inactive connection timeout.
    
    Returns:
    
    The inactivity timeout.
  - setInactiveConnectionTimeout
```
void setInactiveConnectionTimeout(int inactivityTimeout)
                           throws java.sql.SQLException
```
    Sets the inactive connection timeout. This timeout determines how long an available connection remains in the connection pool before it is removed from the pool.
    The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0.
    Setting the value to 0 disables inactive connection timeout processing.
    
    Parameters:
    
    inactivityTimeout - The inactive connection timeout in seconds.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set timeout.
  - getAbandonedConnectionTimeout
```
int getAbandonedConnectionTimeout()
```
    Gets the abandoned connection timeout value.
    
    Returns:
    
    The abandoned connection timeout.
  - setAbandonedConnectionTimeout
```
void setAbandonedConnectionTimeout(int abandonedConnectionTimeout)
                            throws java.sql.SQLException
```
    Sets the abandoned connection timeout. This timeout determines how long a borrowed connection can remain unused before it is considered as abandoned and reclaimed by the connection pool.
    The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0.
    Setting the value to 0 disables abandoned connection timeout.
    
    Parameters:
    
    abandonedConnectionTimeout - The value of how long a connection has not been used before it is abandoned (in seconds).
    
    Throws:
    
    java.sql.SQLException - in case of inability to set timeout.
  - getConnectionWaitTimeout
```
@Deprecated
int getConnectionWaitTimeout()
```
    Deprecated.
    
    Gets the maximum time (in seconds) that any connection borrow request can wait before it returns to the application.
    
    A borrow request may end up creating a new JDBC connection. Therefore, starting in 23.1, the value returned by this method may be larger than the configured one because UCP adjusts it so that it's always equal or larger than the CONNECT_TIMEOUT of the JDBC driver.
    
    This method is deprecated. Use getConnectionWaitDuration() instead.
    
    Returns:
    
    The connection wait timeout.
    
    See Also:
    
    setConnectionWaitTimeout
  - getConnectionWaitDuration
```
java.time.Duration getConnectionWaitDuration()
```
    Gets the maximum time (in seconds) that any connection borrow request can wait before it returns to the application.
    
    A borrow request may end up creating a new JDBC connection. Therefore, starting in 23.1, the value returned by this method may be larger than the configured one because UCP adjusts it so that it's always equal or larger than the CONNECT_TIMEOUT of the JDBC driver.
    
    Returns:
    
    The connection wait duration.
    
    See Also:
    
    setConnectionWaitDuration
  - setConnectionWaitTimeout
```
@Deprecated
void setConnectionWaitTimeout(int waitTimeout)
                                   throws java.sql.SQLException
```
    Deprecated.
    
    Configures how much time a connection request call may wait before it either successfully returns a connection or throws an exception.
    
    The wait duration starts from the point when a connection borrow request is submitted to the pool.
    
    During this time, UCP may either return a connection that's currently available in the pool (ideal scenario) or create a new connection if the pool hasn't reached its maximum size. Otherwise, UCP waits for a connection to be returned to the pool.
    
    By default, the connection wait timeout is set to 3 seconds.
    
    Setting the timeout to 0 makes UCP throw an exception immediately if there is no connection available and no room to grow the pool. Note that it still allows UCP to create a new connection if the maximum size hasn't been reached, and that may take some time.
    
    This method is deprecated. Use setConnectionWaitDuration(java.time.Duration) instead.
    
    Parameters:
    
    waitTimeout - The amount of time in seconds for a connection request to wait.
    
    Throws:
    
    java.sql.SQLException - in case it was not possible to set timeout.
  - setConnectionWaitDuration
```
void setConnectionWaitDuration(java.time.Duration waitDuration)
                        throws java.sql.SQLException
```
    Configures how much time a connection request call may wait before it either successfully returns a connection or throws an exception.
    
    The wait duration starts from the point when a connection borrow request is submitted to the pool.
    
    During this time, UCP may either return a connection that's currently available in the pool (ideal scenario) or create a new connection if the pool hasn't reached its maximum size. Otherwise, UCP waits for a connection to be returned to the pool.
    
    By default, the connection wait timeout is set to 3 seconds.
    
    Setting the connection wait timeout to Duration.ZERO makes UCP throw an exception immediately if there is no connection available and no room to grow the pool. Note that it still allows UCP to create a new connection if the maximum size hasn't been reached, and that may take some time.
    
    Parameters:
    
    waitDuration - The duration for a connection request to wait.
    
    Throws:
    
    java.sql.SQLException - in case it was not possible to set timeout.
  - getTimeToLiveConnectionTimeout
```
int getTimeToLiveConnectionTimeout()
```
    Gets the maximum time (in seconds) a connection may remain in-use. When this timeout expires, the used connection is unconditionally returned to the connection pool. A value of 0 means that the feature is not enabled.
    
    Returns:
    
    The maximum time (in seconds) a used connection may be active.
  - setTimeToLiveConnectionTimeout
```
void setTimeToLiveConnectionTimeout(int timeToLiveConnectionTimeout)
                             throws java.sql.SQLException
```
    Sets the maximum time (in seconds) a connection may remain in-use.
    The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0.
    Setting the value to 0 disables time-to-live connection timeout processing.
    
    Parameters:
    
    timeToLiveConnectionTimeout - The maximum time (in seconds) a used connection may be active.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set timeout.
  - setTimeoutCheckInterval
```
void setTimeoutCheckInterval(int timeInterval)
                      throws java.sql.SQLException
```
    Sets the timeoutCheckInterval (in seconds). This interval specifies how often the timeout properties such as InactiveConnectionTimeout, AbandonedConnectionTimeout, and TimeToLiveConnectionTimeout are enforced.
    The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 30.
    Setting the value to 0 disables all connection timeout processing.
    
    Parameters:
    
    timeInterval - The timeInterval (in seconds) between checks to enforce the timeout properties.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set interval.
  - getTimeoutCheckInterval
```
int getTimeoutCheckInterval()
```
    Gets the timeout check interval (in seconds).
    
    Returns:
    
    timeInterval The timeInterval (in seconds) between checks to enforce the timeout properties.
  - setFastConnectionFailoverEnabled
```
void setFastConnectionFailoverEnabled(boolean failoverEnabled)
                               throws java.sql.SQLException
```
    Enables Fast Connection Failover (FCF) for the connection pool accessed using this pool-enabled data source. By default, FCF is disabled.
    
    Parameters:
    
    failoverEnabled - true if Fast Connection Failover is enabled; false if not.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set flag.
  - getFastConnectionFailoverEnabled
```
boolean getFastConnectionFailoverEnabled()
```
    Checks if Fast Connection Failover is enabled.
    
    Returns:
    
    true if Fast Connection Failover is enabled; false if not.
  - getConnectionFactoryClassName
```
java.lang.String getConnectionFactoryClassName()
```
    Gets the Connection Factory class name.
    
    Returns:
    
    Name of the connection factory class specified.
  - setConnectionFactoryClassName
```
void setConnectionFactoryClassName(java.lang.String factoryClassName)
                            throws java.sql.SQLException
```
    Sets the Connection Factory class name. This is the connection factory used by the connection pool to create physical connections. Must be set for PoolDataSource to operate.
    
    Parameters:
    
    factoryClassName - Connection factory class name for obtaining physical connections.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set factory class name.
  - setMaxStatements
```
void setMaxStatements(int maxStatements)
               throws java.sql.SQLException
```
    Sets the maximum number of statements that may be pooled or cached on a connection. This is used to enable the statement pooling.
    The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0.
    
    Parameters:
    
    maxStatements - maximum number of statements to be pooled.
    
    Throws:
    
    java.sql.SQLException - Exception occurred during the process of setting maximum statements that may be pooled on a connection.
  - getMaxStatements
```
int getMaxStatements()
```
    Gets the maximum number of statements that may be pooled or cached on a Connection.
    
    Returns:
    
    m_maxStatements maximum number of statements that may be pooled or cached on a Connection.
  - setMaxIdleTime
```
void setMaxIdleTime(int idleTime)
             throws java.sql.SQLException
```
    Sets the maximum idle time for available connections in the pool. This has the same effect as setting the inactive connection timeout.
    The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0.
    
    Parameters:
    
    idleTime - Maximum idle time in seconds.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set idle time.
  - getMaxIdleTime
```
int getMaxIdleTime()
```
    Gets the maximum idle time.
    
    Returns:
    
    The maximum idle time.
  - setPropertyCycle
```
void setPropertyCycle(int propertyCycle)
               throws java.sql.SQLException
```
    Sets the property cycle in seconds. This is the time interval between checks to enforce connection pool timeout properties. This has the same effect as setting timeoutCheckInterval.
    The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 30.
    
    Parameters:
    
    propertyCycle - Time interval in seconds to enforce connection pool timeout properties.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set property cycle.
  - getPropertyCycle
```
int getPropertyCycle()
```
    Gets the property cycle in seconds.
    
    Returns:
    
    The PropertyCycle value.
  - setConnectionPoolName
```
void setConnectionPoolName(java.lang.String connectionpoolName)
                    throws java.sql.SQLException
```
    Sets the connection pool name. This property allows the user to specify a String value to name a connection pool instance.
    If not set, the pool name will be automatically generated.
    
    Parameters:
    
    connectionpoolName - Name of the connection pool.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set name.
  - getConnectionPoolName
```
java.lang.String getConnectionPoolName()
```
    Gets the connection pool name.
    
    Returns:
    
    The connection pool name.
  - setURL
```
void setURL(java.lang.String url)
     throws java.sql.SQLException
```
    Sets the URL that the data source uses to obtain connections to the database.
    
    Parameters:
    
    url - URL to be set.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set URL.
  - getURL
```
java.lang.String getURL()
```
    Gets the URL for this data source.
    
    Returns:
    
    URL for this data source.
  - setUser
```
void setUser(java.lang.String userName)
      throws java.sql.SQLException
```
    Sets the user name with which connections have to be obtained.
    
    Parameters:
    
    userName - Username to be set.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set user.
  - getUser
```
java.lang.String getUser()
```
    Gets the user name for this data source.
    
    Returns:
    
    userName for this data source.
  - setPassword
```
void setPassword(java.lang.String pd)
          throws java.sql.SQLException
```
    Sets the password with which connections have to be obtained.
    
    Parameters:
    
    pd - Password to be set.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set password.
  - getPassword
```
@Deprecated
default java.lang.String getPassword()
```
    Deprecated.
    
    Gets the Password for this data source.
    
    Returns:
    
    password for this data source.
  - setServerName
```
void setServerName(java.lang.String serverName)
            throws java.sql.SQLException
```
    Sets the database server name.
    
    Parameters:
    
    serverName - Database server name to be set.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set server name.
  - getServerName
```
java.lang.String getServerName()
```
    Gets the database server name.
    
    Returns:
    
    Database server name.
  - setPortNumber
```
void setPortNumber(int portNumber)
            throws java.sql.SQLException
```
    Sets the database port number.
    
    Parameters:
    
    portNumber - Database port number to be set.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set port number.
  - getPortNumber
```
int getPortNumber()
```
    Gets the database port number.
    
    Returns:
    
    Database port number.
  - setDatabaseName
```
void setDatabaseName(java.lang.String databaseName)
              throws java.sql.SQLException
```
    Sets the database name.
    
    Parameters:
    
    databaseName - Database name to be set.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set db name.
  - getDatabaseName
```
java.lang.String getDatabaseName()
```
    Gets the database name.
    
    Returns:
    
    Database name.
  - setDataSourceName
```
void setDataSourceName(java.lang.String dataSourceName)
                throws java.sql.SQLException
```
    Sets the data source name.
    
    Parameters:
    
    dataSourceName - data source name to be set.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set datasource name.
  - getDataSourceName
```
java.lang.String getDataSourceName()
```
    Gets the data source name.
    
    Returns:
    
    data source name.
  - setDescription
```
void setDescription(java.lang.String description)
             throws java.sql.SQLException
```
    Sets the data source description.
    
    Parameters:
    
    description - data source description to be set.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set description.
  - getDescription
```
java.lang.String getDescription()
```
    Gets the data source description.
    
    Returns:
    
    data source description.
  - setNetworkProtocol
```
void setNetworkProtocol(java.lang.String networkProtocol)
                 throws java.sql.SQLException
```
    Sets the data source network protocol.
    
    Parameters:
    
    networkProtocol - data source network protocol to be set.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set protocol.
  - getNetworkProtocol
```
java.lang.String getNetworkProtocol()
```
    Gets the data source network protocol.
    
    Returns:
    
    data source network protocol.
  - setRoleName
```
void setRoleName(java.lang.String roleName)
          throws java.sql.SQLException
```
    Sets the data source role name.
    
    Parameters:
    
    roleName - data source role name to be set.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set role name.
  - getRoleName
```
java.lang.String getRoleName()
```
    Gets the data source role name.
    
    Returns:
    
    data source role name.
  - setValidateConnectionOnBorrow
```
void setValidateConnectionOnBorrow(boolean validateConnectionOnBorrow)
                            throws java.sql.SQLException
```
    Makes the pool validate the connection before returning it to the user by calling the JDBC API "isValid".
    
    Validating the connection each time it's borrowed from the pool has a performance cost because it typically requires a full roundtrip to the database. You can tune how the Oracle JDBC thin driver validates connections using the "oracle.jdbc.defaultConnectionValidation" property (please refer to the JDBC driver javadoc). You may also configure "secondsToTrustIdleConnection" to avoid validating connections that are often active.
    
    Parameters:
    
    validateConnectionOnBorrow - Whether or not a connection being borrowed should first be validated.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set flag.
    
    See Also:
    
    setSecondsToTrustIdleConnection
  - getValidateConnectionOnBorrow
```
boolean getValidateConnectionOnBorrow()
```
    Returns whether or not a connection being borrowed should first be validated.
    
    Returns:
    
    Whether or not a connection being borrowed should first be validated.
  - setSQLForValidateConnection
```
void setSQLForValidateConnection(java.lang.String SQLString)
                          throws java.sql.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. Defaults to null.
    
    Parameters:
    
    SQLString - The SQL string used for connection validation.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set SQL string.
  - getSQLForValidateConnection
```
java.lang.String getSQLForValidateConnection()
```
    Gets the value of the SQLForValidateConnection property.
    
    Returns:
    
    The SQLForValidateConnection property value.
  - getConnectionHarvestTriggerCount
```
int getConnectionHarvestTriggerCount()
```
    Gets the number of available connections below which the connection pool's connection harvesting will occur. For example, if the value is set to 10, then connection harvesting will occur when the number of available connections drops to 10.
    
    Returns:
    
    The number of available connections below which the connection pool's connection harvesting will occur.
  - setConnectionHarvestTriggerCount
```
void setConnectionHarvestTriggerCount(int connectionHarvestTriggerCount)
                               throws java.sql.SQLException
```
    Sets the number of available connections below which the connection pool's connection harvesting will occur.
    The range of valid values is 0 to maxPoolSize. Defaults to Integer.MAX_VALUE.
    Setting the value to Integer.MAX_VALUE disables connection harvesting.
    
    Parameters:
    
    connectionHarvestTriggerCount - The number of available connections below which the connection pool's connection harvesting will occur.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set that count.
  - getConnectionHarvestMaxCount
```
int getConnectionHarvestMaxCount()
```
    Gets the maximum number of connections that may be harvested when the connection harvesting occurs. Note that it is possible that the number of connections that are harvested may be anywhere from 0 to the connectionHarvestMaxCount.
    
    Returns:
    
    The maximum number of connections that may be harvested when the connection harvesting occurs.
  - setConnectionHarvestMaxCount
```
void setConnectionHarvestMaxCount(int connectionHarvestMaxCount)
                           throws java.sql.SQLException
```
    Sets the maximum number of connections that may be harvested when the connection harvesting occurs.
    The range of valid values is 1 to maxPoolSize. Defaults to 1.
    
    Parameters:
    
    connectionHarvestMaxCount - the maximum number of connections that may be harvested when the connection harvesting occurs.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set that count.
  - getAvailableConnectionsCount
```
int getAvailableConnectionsCount()
                          throws java.sql.SQLException
```
    Gets the number of available connections in the pool.
    
    Returns:
    
    AvailableConnectionsCount
    
    Throws:
    
    java.sql.SQLException - in case of inability to set that count.
  - getBorrowedConnectionsCount
```
int getBorrowedConnectionsCount()
                         throws java.sql.SQLException
```
    Gets the number of borrowed connections from the pool.
    
    Returns:
    
    BorrowedConnectionsCount
    
    Throws:
    
    java.sql.SQLException - in case of inability to set that count.
  - getONSConfiguration
```
java.lang.String getONSConfiguration()
                              throws java.sql.SQLException
```
    Returns the ONS configuration string that is used for remote ONS subscription in the form specified in setONSConfiguration(String). This is used by Fast Connection Failover and Runtime Connection Load Balancing.
    
    Returns:
    
    The ONS configuration string used for remote ONS subscription.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set that configuration.
  - setONSConfiguration
```
void setONSConfiguration(java.lang.String onsConfigStr)
                  throws java.sql.SQLException
```
    Sets the configuration string used for remote ONS subscription. The parameter string closely resembles the content of the ONS configuration file (ons.config). The string contains a list of name=value pairs separated by a newline character (\n). The name can be one of nodes, walletfile, or walletpassword.
    The parameter string should at least specify the ONS configuration nodes attribute as a list of host:port pairs separated by a comma. SSL would be used when the walletfile attribute is specified as an Oracle wallet file.
    
    An example ONS configuration string: "nodes=host1:4200,host2:4200\nwalletfile=wfile\nwalletpassword=wpwd" This is used primarily by Fast Connection Failover and Runtime Load Balancing.
    
    Parameters:
    
    onsConfigStr - The configuration string for remote ONS subscription.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set that configuration.
  - getConnection
```
java.sql.Connection getConnection(java.util.Properties labels)
                           throws java.sql.SQLException
```
    Attempts to obtain a database connection with the requested connection labels.
    
    Parameters:
    
    labels - The requested connection labels.
    
    Returns:
    
    A Connection to the database.
    
    Throws:
    
    java.sql.SQLException - if a database-access error occurs.
  - getConnection
```
java.sql.Connection getConnection(java.lang.String username,
                                  java.lang.String password,
                                  java.util.Properties labels)
                           throws java.sql.SQLException
```
    Attempts to obtain a database connection with the requested connection labels.
    
    Parameters:
    
    username - The database user on whose behalf the connection is being made.
    
    password - The user's password.
    
    labels - The requested connection labels.
    
    Returns:
    
    A Connection to the database.
    
    Throws:
    
    java.sql.SQLException - if a database-access error occurs.
  - registerConnectionLabelingCallback
```
void registerConnectionLabelingCallback(ConnectionLabelingCallback cbk)
                                 throws java.sql.SQLException
```
    Registers a connection labeling callback with the underlying connection pool.
    
    Parameters:
    
    cbk - The ConnectionLabelingCallback object to be registered.
    
    Throws:
    
    java.sql.SQLException - If there is a callback already registered with the pool.
  - removeConnectionLabelingCallback
```
void removeConnectionLabelingCallback()
                               throws java.sql.SQLException
```
    Removes the ConnectionLabelingCallback object registered with the underlying connection pool, if any.
    
    Throws:
    
    java.sql.SQLException - If callback removal fails.
  - registerConnectionAffinityCallback
```
void registerConnectionAffinityCallback(ConnectionAffinityCallback cbk)
                                 throws java.sql.SQLException
```
    Registers a connection affinity callback on the connection pool.
    
    Parameters:
    
    cbk - Affinity Callback object that must be registered.
    
    Throws:
    
    java.sql.SQLException - If callback registration fails.
  - removeConnectionAffinityCallback
```
void removeConnectionAffinityCallback()
                               throws java.sql.SQLException
```
    Removes the ConnectionAffinityCallback object registered on the connection pool.
    
    Throws:
    
    java.sql.SQLException - If callback removal fails.
  - getConnectionProperties
```
java.util.Properties getConnectionProperties()
```
    Gets the connection properties that are set on this data source.
    
    Returns:
    
    Connection properties.
  - getConnectionProperty
```
java.lang.String getConnectionProperty(java.lang.String propertyName)
```
    Gets the specified connection property that are set on this data source.
    
    Parameters:
    
    propertyName - The name of the specified property.
    
    Returns:
    
    The value of the inquired connection property. Null if the property is not set.
  - setConnectionProperty
```
void setConnectionProperty(java.lang.String name,
                           java.lang.String value)
                    throws java.sql.SQLException
```
    Sets a connection property on the connection factory. This is used only for DataSource connection factories that also support connection properties; for example, the oracle.jdbc.pool.OracleDataSource in the Oracle JDBC driver.
    
    Parameters:
    
    name - The name of the connection property to be set on the connection factory class.
    
    value - The value of the connection property to be set on the connection factory class.
    
    Throws:
    
    java.sql.SQLException - If any exception occurred while setting the connection property.
    
    See Also:
    
    setConnectionFactoryProperties
  - setConnectionProperties
```
void setConnectionProperties(java.util.Properties connectionProperties)
                      throws java.sql.SQLException
```
    Sets the connection properties on the connection factory. This is used only for DataSource connection factories that also support connection properties; for example, the oracle.jdbc.pool.OracleDataSource in the Oracle JDBC driver.
    
    Parameters:
    
    connectionProperties - Connection properties to be set on the connection factory class.
    
    Throws:
    
    java.sql.SQLException - If any exception occurred while setting the connection properties.
    
    See Also:
    
    setConnectionFactoryProperties
  - getConnectionFactoryProperties
```
java.util.Properties getConnectionFactoryProperties()
```
    Gets the connection factory properties that are set on this data source.
    
    Returns:
    
    Connection factory properties.
  - getConnectionFactoryProperty
```
java.lang.String getConnectionFactoryProperty(java.lang.String propertyName)
```
    Gets the specified connection factory property that are set on this data source.
    
    Parameters:
    
    propertyName - The name of the specified property.
    
    Returns:
    
    The value of the inquired connection factory property. Null if the property is not set.
  - setConnectionFactoryProperty
```
void setConnectionFactoryProperty(java.lang.String name,
                                  java.lang.String value)
                           throws java.sql.SQLException
```
    Sets a connection factory property on the connection factory.
    For connection factories that implement java.sql.Driver, the connection factory property specified here will be assumed as a connection property.
    For DataSource connection factories, the property specified here will be assumed as a DataSource property.
    
    Parameters:
    
    name - The name of the connection factory property to be set on the connection factory class.
    
    value - The value of the connection factory property to be set on the connection factory class.
    
    Throws:
    
    java.sql.SQLException - If any exception occurred while setting the connection factory property.
    
    java.lang.IllegalArgumentException - If the property name or value is invalid.
  - setConnectionFactoryProperties
```
void setConnectionFactoryProperties(java.util.Properties factoryProperties)
                             throws java.sql.SQLException
```
    Sets the connection factory properties on the connection factory.
    For connection factories that implement java.sql.Driver, the connection factory properties specified here will be assumed as the connection properties.
    For DataSource connection factories, the properties specified here will be assumed as the DataSource properties.
    
    Parameters:
    
    factoryProperties - Connection factory properties to be set on the connection factory class.
    
    Throws:
    
    java.sql.SQLException - If any exception occurred while setting the connection factory properties.
    
    java.lang.IllegalArgumentException - If factoryProperties is empty.
  - getMaxConnectionReuseTime
```
long getMaxConnectionReuseTime()
```
    Gets the maximum connection reuse time property value. See property description in setMaxConnectionReuseTime().
    
    Returns:
    
    Maximum connection reuse time (in seconds).
  - setMaxConnectionReuseTime
```
void setMaxConnectionReuseTime(long maxConnectionReuseTime)
                        throws java.sql.SQLException
```
    Sets the maximum connection reuse time property. This property specifies the maximum time any connection can potentially be reused after which the pool removes and closes a connection. The value is specified in seconds and must be greater than 0. For example, if the specified value is 3600 seconds, then when a connection is in existence for more than 3600 seconds, the connection is closed and removed from the pool. Connections are closed gracefully after they are returned to the pool and the specified property value has been exceeded. Default is 0, which means this feature is not enabled.
    
    Parameters:
    
    maxConnectionReuseTime - Maximum connection reuse time (in seconds).
    
    Throws:
    
    java.sql.SQLException - in case of inability to set reuse time.
  - getMaxConnectionReuseCount
```
int getMaxConnectionReuseCount()
```
    Gets the maximum connection reuse count property value. See property description in setMaxConnectionReuseCount().
    
    Returns:
    
    Maximum connection reuse count.
  - setMaxConnectionReuseCount
```
void setMaxConnectionReuseCount(int maxConnectionReuseCount)
                         throws java.sql.SQLException
```
    Sets the maximum connection reuse count property. This property specifies the maximum number of times any connection can be reused after which the pool removes and closes a connection. The value must be greater than 0 for this feature to be enabled. For example, if the specified value is 100, then when a connection is reused or borrowed 100 times from the pool, it is closed and removed from the pool. Connections are closed gracefully after they are returned to the pool and the property value has been exceeded. Default is 0, which means this feature is not enabled.
    
    Parameters:
    
    maxConnectionReuseCount - Maximum connection reuse count.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set reuse time.
  - getStatistics
```
JDBCConnectionPoolStatistics getStatistics()
```
    Gets the statistics of the connection pool.
    
    Returns:
    
    The statistics of the connection pool.
  - registerConnectionInitializationCallback
```
void registerConnectionInitializationCallback(ConnectionInitializationCallback cbk)
                                       throws java.sql.SQLException
```
    Registers a connection initialization callback.
    
    Parameters:
    
    cbk - The ConnectionInitializationCallback object to be registered.
    
    Throws:
    
    java.sql.SQLException - If there is a callback already registered with the pool.
  - unregisterConnectionInitializationCallback
```
void unregisterConnectionInitializationCallback()
                                         throws java.sql.SQLException
```
    Unregisters the connection initialization callback on this pool.
    
    Throws:
    
    java.sql.SQLException - If callback removal fails.
  - getConnectionInitializationCallback
```
ConnectionInitializationCallback getConnectionInitializationCallback()
```
    Obtains the registered connection initialization callback, if any.
    
    Returns:
    
    The registered ConnectionInitializationCallback, or null if there is no callback registered.
  - registerConnectionCreationConsumer
```
default void registerConnectionCreationConsumer(java.util.function.Consumer<oracle.ucp.ConnectionCreationInformation> consumer)
```
    Registers a connection creation Consumer.
    
    Parameters:
    
    consumer - The Consumer object to be registered.
  - unregisterConnectionCreationConsumer
```
default void unregisterConnectionCreationConsumer()
```
    Unregisters the connection creation Consumer on this pool.
  - getConnectionCreationConsumer
```
default java.util.function.Consumer<oracle.ucp.ConnectionCreationInformation> getConnectionCreationConsumer()
```
    Obtains the registered connection creation Consumer, if any.
    
    Returns:
    
    The registered Consumer, or null if there is no Consumer registered.
  - getConnectionLabelingHighCost
```
int getConnectionLabelingHighCost()
```
    Obtains the cost value which identifies a connection as "high-cost" for connection labeling.
    
    Returns:
    
    The cost value that identifies a connection as "high-cost" for connection labeling.
    
    See Also:
    
    setConnectionLabelingHighCost
  - setConnectionLabelingHighCost
```
void setConnectionLabelingHighCost(int highCost)
                            throws java.sql.SQLException
```
    Sets the cost value which identifies a connection as "high-cost" for connection labeling. Connection labeling uses the cost(Properties, Properties) method in ConnectionLabelingCallback to find a connection in the pool for a request. When this property is set, connections with a cost value equal to or greater than the property value are considered "high-cost" connections. The default value is Integer.MAX_VALUE.
    
    Parameters:
    
    highCost - The cost value that identifies a connection as "high-cost" for connection labeling.
    
    Throws:
    
    java.sql.SQLException - If an exception occurs while setting the cost.
  - getHighCostConnectionReuseThreshold
```
int getHighCostConnectionReuseThreshold()
```
    Obtains the high-cost connection reuse threshold property value for connection labeling.
    
    Returns:
    
    The high-cost connection reuse threshold property value currently set.
    
    See Also:
    
    setConnectionLabelingHighCost, setHighCostConnectionReuseThreshold
  - setHighCostConnectionReuseThreshold
```
void setHighCostConnectionReuseThreshold(int threshold)
                                  throws java.sql.SQLException
```
    Sets the high-cost connection reuse threshold for connection labeling. This property works together with the ConnectionLabelingHighCost property to determine when high-cost connections are reused for connection labeling. This property specifies a threshold of the number of total connections in the pool. If Connection Labeling finds all available connections are high-cost connections (i.e., the lowest cost value exceeds the ConnectionLabelingHighCost value), it checks this threshold to determine whether to reuse those connections. Only when this threshold is reached, Connection Labeling will try to reuse the high-cost connections in the pool to serve a labeled connection request. Otherwise, Connection Labeling picks a low-cost connection, a no-label connection available in the pool, or creates a brand-new physical connection to serve a labeled request. For example, if the property value is set to 10, Connection Labeling reuses high-cost connections when there are no low-cost connections available and the total connections reach 10. Note that any labeled connection with cost Integer.MAX_VALUE will not be reused. This is consistent with connection labeling behavior when this property and ConnectionLabelingHighCost are not set. A Connection Labeling callback must be registered at the same time for this property to take effect. The default value is 0, which is treated the same way as MinPoolSize.
    
    Parameters:
    
    threshold - The high-cost connection reuse threshold to set.
    
    Throws:
    
    java.sql.SQLException - If any exception occurs while setting the threshold.
  - createConnectionBuilder
```
UCPConnectionBuilder createConnectionBuilder()
```
    Creates a new UCPConnectionBuilder instance.
    
    Returns:
    
    The OracleConnectionBuilder instance that was created
  - createShardingKeyBuilder
```
default oracle.jdbc.OracleShardingKeyBuilder createShardingKeyBuilder()
```
    Creates a new OracleShardingKeyBuilder instance
    
    Returns:
    
    The OracleShardingKeyBuilder instance that was created
  - getConnectionRepurposeThreshold
```
int getConnectionRepurposeThreshold()
```
    Gets the connection repurpose threshold for the pool. This property is used in cases when the connection pool is shared by multiple datasources connecting to the same database but using different services.Only when this threshold is reached the pool will try to repurpose connections between different services before trying to create new connections. This property is applicable only for multi-tenant databases.
    
    Returns:
    
    connection repurpose threshold property value currently set.
  - setConnectionRepurposeThreshold
```
void setConnectionRepurposeThreshold(int threshold)
                              throws java.sql.SQLException
```
    Sets the connection repurpose threshold for the pool. This property is applicable only for multi-tenant databases.
    
    Parameters:
    
    threshold - connection repurpose threshold to set.
    
    Throws:
    
    java.sql.SQLException - If any exception occurs while setting the threshold.
    
    See Also:
    
    getConnectionRepurposeThreshold
  - getPdbRoles
```
java.util.Properties getPdbRoles()
```
    Gets the PDB roles specified for this datasource
    
    Returns:
    
    roles key values pairs that correspond to the role names and password that are set for this datasource
  - getServiceName
```
java.lang.String getServiceName()
```
    Gets the service name set on this data source
    
    Returns:
    
    service name on this data source
  - getSecondsToTrustIdleConnection
```
int getSecondsToTrustIdleConnection()
```
    Gets the seconds To Trust Idle Connection value.
    
    Returns:
    
    The seconds To Trust Idle Connection.
  - setSecondsToTrustIdleConnection
```
void setSecondsToTrustIdleConnection(int secondsToTrustIdleConnection)
                              throws java.sql.SQLException
```
    Sets the time in seconds to trust an idle connection to skip a validation test. It works in conjunction with setValidateConnectionOnBorrow(boolean). When set to any positive value, a connection validation during the checkout is skipped if the connection was successfully used and returned to the pool within the time specified for secondsToTrustIdleConnection. Default value is set to 0 seconds which means that the feature is disabled.
    With this mode enabled, UCP will do a SOCKET validation on every connection borrow and default driver validation type (can be changed with the "oracle.jdbc.defaultConnectionValidation" system property) after designated seconds to trust idle connection has passed
    * @param secondsToTrustIdleConnection The value of how long a connection can be trusted to skip connectionValidationOnBorrow
    
    Throws:
    
    java.sql.SQLException - in case of inability to set these seconds.
  - reconfigureDataSource
```
void reconfigureDataSource(java.util.Properties configuration)
                    throws java.sql.SQLException
```
    Reconfigures the data source. This API can be only used to modify existing data source properties. To add a new data source to a running pool instance, use PoolDataSourceFactory's getPoolDataSource(Properties configuration) API instead. Only the following data source properties can be modified using this API: user, password, description, serviceName, pdbRoles.
    
    Parameters:
    
    configuration - the configuration input
    
    Throws:
    
    java.sql.SQLException - If an error occurs while configuring the data source.
  - getMaxConnectionsPerService
```
int getMaxConnectionsPerService()
```
    Gets the maximum number of connections that can be obtained to a particular service, in a shared pool.
    
    Returns:
    
    The maximum number of connections that can be obtained to a particular service.
  - getQueryTimeout
```
int getQueryTimeout()
```
    Gets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds.
    
    Returns:
    
    The query timeout in seconds
  - setQueryTimeout
```
void setQueryTimeout(int queryTimeout)
              throws java.sql.SQLException
```
    Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds.
    
    Parameters:
    
    queryTimeout - in seconds
    
    Throws:
    
    java.sql.SQLException - in case of inability to set that timeout.
  - getMaxConnectionsPerShard
```
int getMaxConnectionsPerShard()
```
    Gets the currently configured max connections that can be created per shard from this connection pool.
    
    Returns:
    
    The configured max number of connections that can be created per shard.
  - setMaxConnectionsPerShard
```
void setMaxConnectionsPerShard(int maxConnectionsPerShard)
                        throws java.sql.SQLException
```
    Sets the max number of connections that can be created per shard from this connection pool. (Note: This property is applicable to Sharded databases only. It should not be used when the Sharded database is configured with Oracle Golden Gate)
    
    Parameters:
    
    maxConnectionsPerShard - The max number of connections that can be created per shard
    
    Throws:
    
    java.sql.SQLException - if there is an any exception while setting this parameter
  - setShardingMode
```
void setShardingMode(boolean shardingMode)
              throws java.sql.SQLException
```
    This API changes the mode of UCP when UCP is using a Sharded Database. By default UCP requires the caller to provide a sharding key for every connection request. When switching off the sharding mode, UCP behaves like a regular connection pool and all the sharding features are disabled so that a caller can request a connection without providing any sharding key.
    
    Parameters:
    
    shardingMode - Mode of UCP when using a Sharded Database.
    
    Throws:
    
    java.sql.SQLException - in case of inability to set sharding mode.
  - getShardingMode
```
boolean getShardingMode()
```
    Returns the mode of UCP when UCP is using a Sharded Database. By default sharding mode is ON which means UCP requires the caller to provide a sharding key for every connection request.
    
    Returns:
    
    Mode of UCP when using a Sharded Database.
  - setConnectionValidationTimeout
```
void setConnectionValidationTimeout(int connectionValidationTimeout)
                             throws java.sql.SQLException
```
    This property changes the connection validation timeout which is specified in seconds. Default is 15 seconds. This is the maximum time for connection validation operation. If not completed during this timeout, the connection is treated as invalid.
    
    Parameters:
    
    connectionValidationTimeout - timeout to validate connection
    
    Throws:
    
    java.sql.SQLException - if tiomeout is negative
  - getConnectionValidationTimeout
```
int getConnectionValidationTimeout()
```
    Connection validation timeout getter
    
    Returns:
    
    the current connection validation timaout value in seconds
  - setSSLContext
```
void setSSLContext(javax.net.ssl.SSLContext sslContext)
```
    Specifies a SSLContext to use as a factory for SSLEngine objects that carry out the TLS protocol.
    The SSLContext must be initialized before setting it on PoolDataSource. The certificates specified by that initialization will be used in place of any connection properties that would otherwise have specified certificates, such as oracle.jdbc.OracleConnection#CONNECTION_PROPERTY_KEYSTORE key store and oracle.jdbc.OracleConnection#CONNECTION_PROPERTY_TRUSTSTORE trust store property values.
    
    Parameters:
    
    sslContext - SSLContext instance to be used as an SSLEngine factory.
  - setHostnameResolver
```
void setHostnameResolver(PoolDataSource.HostnameResolver hostnameResolver)
```
    Specifies a PoolDataSource.HostnameResolver to use by the pool
    
    Parameters:
    
    hostnameResolver - HostnameResolver instance to be used as a custom DNS name resolver.
  - isReadOnlyInstanceAllowed
```
boolean isReadOnlyInstanceAllowed()
```
    Returns true if the connection borrow is allowed to a read-only instance, false otherwise. This property is applicable to sharded database only. A shard instance can be in read-only mode for a chunk if chunk move/split operation is in progress.
    
    Returns:
    
    true if the connection borrow is allowed to a read-only instance, false otherwise.
  - setReadOnlyInstanceAllowed
```
void setReadOnlyInstanceAllowed(boolean readOnlyInstanceAllowed)
                         throws java.sql.SQLException
```
    Sets the read-only instance allowed value on the datasource. This property is applicable to sharded database only. When the property value is set to true, UCP allows connection borrow to read-only instances as well otherwise not. A shard instance goes into read-only mode for a chunk if the chunk move/split operation is in progress on that instance. The default value is false which means by default connection borrow is not allowed to a read-only instance.
    
    Parameters:
    
    readOnlyInstanceAllowed - whether to allow connection borrow to a read-only instance or not
    
    Throws:
    
    java.sql.SQLException - if unable to set property value
  - setTokenSupplier
```
void setTokenSupplier(java.util.function.Supplier<? extends oracle.jdbc.AccessToken> tokenSupplier)
               throws java.sql.SQLException
```
    Sets a supplier function that generates an access token when creating a connection with this DataSource. The supplier function is invoked each time this DataSource creates a connection. Instances of AccessToken that are output by the supplier must represent a token type that is supported by Oracle Database for client authentication. The supplier must be thread safe.
    It is invalid to configure this DataSource with both a token supplier and with a user name or password. If invocations of setUser(String), setPassword(String), setConnectionProperties(java.util.Properties), or setConnectionProperty(String, String) have configured this DataSource with a user name or password, and an invocation of this method has also configured a token supplier, then a SQLException indicating an invalid configuration is thrown when creating a connection with this datasource.
    Note that AccessToken.createJsonWebTokenCache(Supplier) can be called to create a thread safe Supplier that caches tokens from a user defined Supplier.
    
    Parameters:
    
    tokenSupplier - Token supplying function. Not null.
    
    Throws:
    
    java.lang.NullPointerException - If the tokenSupplier is null.
    
    java.sql.SQLException - if unable to set property value

Interface PoolDataSource

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface javax.sql.DataSource

Methods inherited from interface javax.sql.CommonDataSource

Methods inherited from interface java.sql.Wrapper

Methods inherited from interface oracle.ucp.diagnostics.Diagnosable

Field Detail

SYSTEM_PROPERTY_AFFINITY_STRICT

SYSTEM_PROPERTY_MAX_INIT_THREADS

SYSTEM_PROPERTY_PRE_WLS1212_COMPATIBLE

SYSTEM_PROPERTY_CONNECTION_CREATION_RETRY_DELAY

SYSTEM_PROPERTY_FAN_ENABLED

SYSTEM_PROPERTY_BEGIN_REQUEST_AT_CONNECTION_CREATION

SYSTEM_PROPERTY_XML_CONFIG_FILE

SYSTEM_PROPERTY_DESTROY_ON_RELOAD

SYSTEM_PROPERTY_IMITATE_ASYNC_BORROW

SYSTEM_PROPERTY_SELFTUNING

SYSTEM_PROPERTY_WLS_JTA

SYSTEM_PROPERTY_TIMERS_AFFECT_ALL_CONNECTIONS

SYSTEM_PROPERTY_DIAGNOSTIC_ENABLE_TRACE

SYSTEM_PROPERTY_DIAGNOSTIC_ENABLE_LOGGING

SYSTEM_PROPERTY_DIAGNOSTIC_BUFFER_SIZE

SYSTEM_PROPERTY_DIAGNOSTIC_LOGGING_LEVEL

SYSTEM_PROPERTY_DIAGNOSTIC_ERROR_CODES_TO_WATCH_LIST

SYSTEM_PROPERTY_ENABLE_SHUTDOWN_HOOK

SYSTEM_PROPERTY_RLB_INOPERABILITY_TIMEOUT

UCP_USER

UCP_URL

UCP_PASSWORD

UCP_SERVER_NAME

UCP_PORT_NUMBER

UCP_DATABASE_NAME

UCP_DATA_SOURCE_NAME

UCP_DESCRIPTION

UCP_NETWORK_PROTOCOL

UCP_ROLE_NAME

UCP_CONNECTION_FACTORY_CLASS_NAME

UCP_CONNECTION_PROPERTIES

UCP_CONNECTION_FACTORY_PROPERTIES

UCP_VALIDATE_CONNECTION_ON_BORROW

UCP_SQL_FOR_VALIDATE_CONNECTION

UCP_CONNECTION_POOL_NAME

UCP_INITIAL_POOL_SIZE

UCP_MIN_POOL_SIZE

UCP_MAX_POOL_SIZE

UCP_NTH_RETURNED_CONNECTION_TO_VALIDATE

UCP_ABANDONED_CONNECTION_TIMEOUT

UCP_TIME_TO_LIVE_CONNECTION_TIMEOUT

UCP_INACTIVE_CONNECTION_TIMEOUT

UCP_MAX_IDLE_TIME

UCP_TIMEOUT_CHECK_INTERVAL

UCP_PROPERTY_CYCLE

UCP_MAX_STATEMENTS

UCP_CONNECTION_WAIT_TIMEOUT

UCP_CONNECTION_WAIT_DURATION

UCP_MAX_CONNECTION_REUSE_TIME

UCP_MAX_CONNECTION_REUSE_COUNT

UCP_CONNECTION_HARVEST_TRIGGER_COUNT

UCP_CONNECTION_HARVEST_MAX_COUNT

UCP_FAST_CONNECTION_FAILOVER_ENABLED

UCP_ONS_CONFIGURATION

UCP_SECONDS_TO_TRUST_IDLE_CONNECTION

UCP_MAX_CONNECTIONS_PER_SERVICE

UCP_LOGIN_TIMEOUT

UCP_SERVICE_NAME

UCP_PDB_ROLES

UCP_CONNECTION_AFFINITY_CALLBACK

UCP_CONNECTION_INITIALIZATION_CALLBACK

UCP_CONNECTION_CREATION_CONSUMER

UCP_CONNECTION_LABELING_CALLBACK

UCP_CONNECTION_LABELING_HIGH_COST

UCP_CONNECTION_REPURPOSE_THRESHOLD

UCP_HIGH_COST_CONNECTION_REUSE_THRESHOLD

UCP_DATA_SOURCE_FROM_CONFIGURATION

UCP_MAX_CONNECTIONS_PER_SHARD

UCP_SHARDING_MODE

UCP_CONNECTION_VALIDATION_TIMEOUT

UCP_READONLY_INSTANCE_ALLOWED