oracle.ucp.jdbc

Class PoolXADataSourceImpl

java.lang.Object

oracle.ucp.jdbc.PoolDataSourceImpl

oracle.ucp.jdbc.PoolXADataSourceImpl

All Implemented Interfaces:

java.io.Serializable, java.sql.Wrapper, javax.naming.Referenceable, javax.naming.spi.ObjectFactory, javax.sql.CommonDataSource, javax.sql.DataSource, javax.sql.XADataSource, PoolDataSource, PoolXADataSource, UniversalConnectionPoolAdapter

public class PoolXADataSourceImpl
extends PoolDataSourceImpl
implements PoolXADataSource, java.io.Serializable, javax.naming.Referenceable, javax.naming.spi.ObjectFactory, UniversalConnectionPoolAdapter

A connection pool-aware data source. This DataSource uses the Universal Connection Pool to get an XAconneciton, creating a proxy to that connection, and returning the proxy to the client. When the client calls close on the XAConnection proxy, the underlying physical connection is usually returned to the pool. Also see the proxy factory.

Besides other data source properties, applications must set the connection factory class name. The connection factory class is a class that implements javax.sql.XADataSource and does not implement its own connection pooling. The connection factory's getXAConnection(...) methods should return a physical XAConnection to the database. For example, "oracle.jdbc.xa.client.OracleXADataSource" is a valid connection factory class name.

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.ucp.jdbc.PoolDataSourceImpl

m_connectionFactory, m_connectionFactoryClassName, m_cp, SECRET_STORE_CONNECT, SECRET_STORE_DEFAULT_PASSWORD, SECRET_STORE_DEFAULT_USERNAME, SECRET_STORE_PASSWORD, SECRET_STORE_USERNAME

Fields inherited from interface oracle.ucp.jdbc.PoolDataSource

UCP_ABANDONED_CONNECTION_TIMEOUT, UCP_CONNECTION_AFFINITY_CALLBACK, UCP_CONNECTION_FACTORY_CLASS_NAME, UCP_CONNECTION_FACTORY_PROPERTIES, UCP_CONNECTION_HARVEST_MAX_COUNT, UCP_CONNECTION_HARVEST_TRIGGER_COUNT, UCP_CONNECTION_INITIALIZATION_CALLBACK, UCP_CONNECTION_LABELING_CALLBACK, UCP_CONNECTION_LABELING_HIGH_COST, UCP_CONNECTION_POOL_NAME, UCP_CONNECTION_PROPERTIES, UCP_CONNECTION_REPURPOSE_THRESHOLD, UCP_CONNECTION_WAIT_TIMEOUT, UCP_DATA_SOURCE_FROM_CONFIGURATION, UCP_DATA_SOURCE_NAME, UCP_DATABASE_NAME, UCP_DESCRIPTION, UCP_FAST_CONNECTION_FAILOVER_ENABLED, UCP_HIGH_COST_CONNECTION_REUSE_THRESHOLD, UCP_INACTIVE_CONNECTION_TIMEOUT, UCP_INITIAL_POOL_SIZE, UCP_LOGIN_TIMEOUT, UCP_MAX_CONNECTION_REUSE_COUNT, UCP_MAX_CONNECTION_REUSE_TIME, UCP_MAX_CONNECTIONS_PER_SERVICE, UCP_MAX_CONNECTIONS_PER_SHARD, UCP_MAX_IDLE_TIME, UCP_MAX_POOL_SIZE, UCP_MAX_STATEMENTS, UCP_MIN_POOL_SIZE, UCP_NETWORK_PROTOCOL, UCP_NTH_RETURNED_CONNECTION_TO_VALIDATE, UCP_ONS_CONFIGURATION, UCP_PASSWORD, UCP_PDB_ROLES, UCP_PORT_NUMBER, UCP_PROPERTY_CYCLE, UCP_ROLE_NAME, UCP_SECONDS_TO_TRUST_IDLE_CONNECTION, UCP_SERVER_NAME, UCP_SERVICE_NAME, UCP_SQL_FOR_VALIDATE_CONNECTION, UCP_TIME_TO_LIVE_CONNECTION_TIMEOUT, UCP_TIMEOUT_CHECK_INTERVAL, UCP_URL, UCP_USER, UCP_VALIDATE_CONNECTION_ON_BORROW

Constructor Summary

Constructors

Constructor and Description
PoolXADataSourceImpl()

Method Summary

Modifier and Type	Method and Description
protected void	createPoolWithDefaultProperties()
UCPXAConnectionBuilder	createXAConnectionBuilder() Creates a new XAConnectionBuilder instance.
java.sql.Connection	getConnection() Attempts to obtain a database connection.
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) Attempts to obtain a database connection.
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.
javax.sql.XAConnection	getXAConnection() Obtains an XAConnection from the embedded Universal Connection Pool instance.
javax.sql.XAConnection	getXAConnection(java.util.Properties labels) Obtains an XAConnection from the embedded Universal Connection Pool instance, using the given connection labels.
javax.sql.XAConnection	getXAConnection(java.lang.String user, java.lang.String password) Obtains an XAConnection from the embedded Universal Connection Pool instance, using the given user name and password.
javax.sql.XAConnection	getXAConnection(java.lang.String username, java.lang.String password, java.util.Properties labels) Obtains an XAConnection from the embedded Universal Connection Pool instance, using the given user name, password, and connection labels.

Methods inherited from class oracle.ucp.jdbc.PoolDataSourceImpl

createConnectionBuilder, createUniversalConnectionPool, createUniversalConnectionPoolMBean, getAbandonedConnectionTimeout, getAvailableConnectionsCount, getBorrowedConnectionsCount, getConnectionFactoryClassName, getConnectionFactoryProperties, getConnectionFactoryProperty, getConnectionHarvestMaxCount, getConnectionHarvestTriggerCount, getConnectionInitializationCallback, getConnectionLabelingHighCost, getConnectionPoolName, getConnectionProperties, getConnectionProperty, getConnectionRepurposeThreshold, getConnectionWaitTimeout, getDatabaseName, getDataSourceName, getDescription, getFastConnectionFailoverEnabled, getHighCostConnectionReuseThreshold, getInactiveConnectionTimeout, getInitialPoolSize, getLoginTimeout, getLogWriter, getMaxConnectionReuseCount, getMaxConnectionReuseTime, getMaxConnectionsPerService, getMaxConnectionsPerShard, getMaxIdleTime, getMaxPoolSize, getMaxStatements, getMinPoolSize, getNetworkProtocol, getObjectInstance, getONSConfiguration, getParentLogger, getPassword, getPdbRoles, getPortNumber, getPropertyCycle, getQueryTimeout, getReference, getRoleName, getSecondsToTrustIdleConnection, getServerName, getServiceName, getSQLForValidateConnection, getStatistics, getTimeoutCheckInterval, getTimeToLiveConnectionTimeout, getURL, getUser, getValidateConnectionOnBorrow, ilogFine, ilogFinest, ilogSevere, ilogThrowing, ilogWarning, isWrapperFor, reconfigureDataSource, registerConnectionAffinityCallback, registerConnectionInitializationCallback, registerConnectionLabelingCallback, removeConnectionAffinityCallback, removeConnectionLabelingCallback, setAbandonedConnectionTimeout, setConnectionFactoryClassName, setConnectionFactoryProperties, setConnectionFactoryProperty, setConnectionHarvestMaxCount, setConnectionHarvestTriggerCount, setConnectionLabelingHighCost, setConnectionPoolName, setConnectionProperties, setConnectionProperty, setConnectionRepurposeThreshold, setConnectionWaitTimeout, setDatabaseName, setDataSourceName, setDescription, setFastConnectionFailoverEnabled, setHighCostConnectionReuseThreshold, setInactiveConnectionTimeout, setInitialPoolSize, setLoginTimeout, setLogWriter, setMaxConnectionReuseCount, setMaxConnectionReuseTime, setMaxConnectionsPerShard, setMaxIdleTime, setMaxPoolSize, setMaxStatements, setMinPoolSize, setNetworkProtocol, setONSConfiguration, setPassword, setPortNumber, setPropertyCycle, setQueryTimeout, setRoleName, setSecondsToTrustIdleConnection, setServerName, setSQLForValidateConnection, setTimeoutCheckInterval, setTimeToLiveConnectionTimeout, setURL, setUser, setValidateConnectionOnBorrow, startPool, toBasicType, unregisterConnectionInitializationCallback, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ucp.jdbc.PoolDataSource

createConnectionBuilder, createShardingKeyBuilder, getAbandonedConnectionTimeout, getAvailableConnectionsCount, getBorrowedConnectionsCount, getConnectionFactoryClassName, getConnectionFactoryProperties, getConnectionFactoryProperty, getConnectionHarvestMaxCount, getConnectionHarvestTriggerCount, getConnectionInitializationCallback, getConnectionLabelingHighCost, getConnectionPoolName, getConnectionProperties, getConnectionProperty, getConnectionRepurposeThreshold, getConnectionWaitTimeout, getDatabaseName, getDataSourceName, getDescription, getFastConnectionFailoverEnabled, getHighCostConnectionReuseThreshold, getInactiveConnectionTimeout, getInitialPoolSize, getMaxConnectionReuseCount, getMaxConnectionReuseTime, getMaxConnectionsPerService, getMaxConnectionsPerShard, getMaxIdleTime, getMaxPoolSize, getMaxStatements, getMinPoolSize, getNetworkProtocol, getONSConfiguration, getPassword, getPdbRoles, getPortNumber, getPropertyCycle, getQueryTimeout, getRoleName, getSecondsToTrustIdleConnection, getServerName, getServiceName, getSQLForValidateConnection, getStatistics, getTimeoutCheckInterval, getTimeToLiveConnectionTimeout, getURL, getUser, getValidateConnectionOnBorrow, reconfigureDataSource, registerConnectionAffinityCallback, registerConnectionInitializationCallback, registerConnectionLabelingCallback, removeConnectionAffinityCallback, removeConnectionLabelingCallback, setAbandonedConnectionTimeout, setConnectionFactoryClassName, setConnectionFactoryProperties, setConnectionFactoryProperty, setConnectionHarvestMaxCount, setConnectionHarvestTriggerCount, setConnectionLabelingHighCost, setConnectionPoolName, setConnectionProperties, setConnectionProperty, setConnectionRepurposeThreshold, setConnectionWaitTimeout, setDatabaseName, setDataSourceName, setDescription, setFastConnectionFailoverEnabled, setHighCostConnectionReuseThreshold, setInactiveConnectionTimeout, setInitialPoolSize, setMaxConnectionReuseCount, setMaxConnectionReuseTime, setMaxConnectionsPerShard, setMaxIdleTime, setMaxPoolSize, setMaxStatements, setMinPoolSize, setNetworkProtocol, setONSConfiguration, setPassword, setPortNumber, setPropertyCycle, setQueryTimeout, setRoleName, setSecondsToTrustIdleConnection, setServerName, setSQLForValidateConnection, setTimeoutCheckInterval, setTimeToLiveConnectionTimeout, setURL, setUser, setValidateConnectionOnBorrow, unregisterConnectionInitializationCallback

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 javax.naming.Referenceable

getReference

Methods inherited from interface javax.naming.spi.ObjectFactory

getObjectInstance

Methods inherited from interface oracle.ucp.UniversalConnectionPoolAdapter

createUniversalConnectionPool, createUniversalConnectionPoolMBean

Constructor Detail

PoolXADataSourceImpl

public PoolXADataSourceImpl()

Method Detail

createPoolWithDefaultProperties

protected void createPoolWithDefaultProperties()
                                        throws java.sql.SQLException

Overrides:

createPoolWithDefaultProperties in class PoolDataSourceImpl

Throws:

java.sql.SQLException

getConnection

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

Description copied from class: PoolDataSourceImpl

Attempts to obtain a database connection.

Specified by:

getConnection in interface javax.sql.DataSource

Overrides:

getConnection in class PoolDataSourceImpl

Returns:

A Connection to the database.

Throws:

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

getConnection

public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException

Description copied from class: PoolDataSourceImpl

Attempts to obtain a database connection.

Specified by:

getConnection in interface javax.sql.DataSource

Overrides:

getConnection in class PoolDataSourceImpl

Parameters:

username - The database user on whose behalf the connection is being made.

password - The user's password.

Returns:

A Connection to the database.

Throws:

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

getConnection

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

Description copied from class: PoolDataSourceImpl

Attempts to obtain a database connection with the requested connection labels.

Specified by:

getConnection in interface PoolDataSource

Overrides:

getConnection in class PoolDataSourceImpl

Parameters:

labels - The requested connection labels.

Returns:

A Connection to the database.

Throws:

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

getConnection

public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password,
                                         java.util.Properties labels)
                                  throws java.sql.SQLException

Description copied from class: PoolDataSourceImpl

Attempts to obtain a database connection with the requested connection labels.

Specified by:

getConnection in interface PoolDataSource

Overrides:

getConnection in class PoolDataSourceImpl

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.

getXAConnection

public javax.sql.XAConnection getXAConnection()
                                       throws java.sql.SQLException

Obtains an XAConnection from the embedded Universal Connection Pool instance. Each XAConnection represents a physical database connection can be used in a distributed transaction.

Specified by:

getXAConnection in interface javax.sql.XADataSource

Specified by:

getXAConnection in interface PoolXADataSource

Returns:

an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction

Throws:

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

getXAConnection

public javax.sql.XAConnection getXAConnection(java.lang.String user,
                                              java.lang.String password)
                                       throws java.sql.SQLException

Obtains an XAConnection from the embedded Universal Connection Pool instance, using the given user name and password. Each XAConnection represents a physical database connection can be used in a distributed transaction.

Specified by:

getXAConnection in interface javax.sql.XADataSource

Specified by:

getXAConnection in interface PoolXADataSource

Parameters:

user - The database user on whose behalf the connection is being made.

password - The user's password.

Returns:

an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction.

Throws:

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

getXAConnection

public javax.sql.XAConnection getXAConnection(java.util.Properties labels)
                                       throws java.sql.SQLException

Obtains an XAConnection from the embedded Universal Connection Pool instance, using the given connection labels. Each XAConnection represents a physical database connection can be used in a distributed transaction.

Specified by:

getXAConnection in interface PoolXADataSource

Parameters:

labels - The requested connection labels.

Returns:

an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction.

Throws:

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

getXAConnection

public javax.sql.XAConnection getXAConnection(java.lang.String username,
                                              java.lang.String password,
                                              java.util.Properties labels)
                                       throws java.sql.SQLException

Obtains an XAConnection from the embedded Universal Connection Pool instance, using the given user name, password, and connection labels. Each XAConnection represents a physical database connection can be used in a distributed transaction.

Specified by:

getXAConnection in interface PoolXADataSource

Parameters:

username - The database user on whose behalf the connection is being made.

password - The user's password.

labels - The requested connection labels.

Returns:

an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction.

Throws:

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

createXAConnectionBuilder

public UCPXAConnectionBuilder createXAConnectionBuilder()

Description copied from interface: PoolXADataSource

Creates a new XAConnectionBuilder instance.

Specified by:

createXAConnectionBuilder in interface PoolXADataSource

Returns:

Connection builder that builds OracleXAConnection

See Also:

oracle.ucp.jdbc.PoolDataSource#createXAConnectionBuilder()