Package oracle.ucp.jdbc

Interface PoolXADataSource

All Superinterfaces:

CommonDataSource, DataSource, Diagnosable, PoolDataSource, Wrapper, XADataSource

All Known Implementing Classes:

PoolXADataSourceImpl

public interface PoolXADataSource
extends PoolDataSource, XADataSource

A Universal Connection Pool-enabled XA data source. See PoolDataSource for standard data source and connection pool properties that are supported.

See Also:

• PoolDataSource
• UniversalConnectionPool

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.ucp.jdbc.PoolDataSource

PoolDataSource.HostnameResolver

Field Summary

Fields inherited from interface oracle.ucp.jdbc.PoolDataSource

SYSTEM_PROPERTY_AFFINITY_STRICT, SYSTEM_PROPERTY_BEGIN_REQUEST_AT_CONNECTION_CREATION, SYSTEM_PROPERTY_CONNECTION_CREATION_RETRY_DELAY, SYSTEM_PROPERTY_CREATE_CONNECTION_IN_BORROW_THREAD, SYSTEM_PROPERTY_DESTROY_ON_RELOAD, SYSTEM_PROPERTY_DIAGNOSTIC_BUFFER_SIZE, SYSTEM_PROPERTY_DIAGNOSTIC_ENABLE_LOGGING, SYSTEM_PROPERTY_DIAGNOSTIC_ENABLE_TRACE, SYSTEM_PROPERTY_DIAGNOSTIC_ERROR_CODES_TO_WATCH_LIST, SYSTEM_PROPERTY_DIAGNOSTIC_LOGGING_LEVEL, SYSTEM_PROPERTY_ENABLE_SHUTDOWN_HOOK, SYSTEM_PROPERTY_FAN_ENABLED, SYSTEM_PROPERTY_IMITATE_ASYNC_BORROW, SYSTEM_PROPERTY_MAX_INIT_THREADS, SYSTEM_PROPERTY_PRE_WLS1212_COMPATIBLE, SYSTEM_PROPERTY_RLB_INOPERABILITY_TIMEOUT, SYSTEM_PROPERTY_SELFTUNING, SYSTEM_PROPERTY_TIMERS_AFFECT_ALL_CONNECTIONS, SYSTEM_PROPERTY_WLS_JTA, SYSTEM_PROPERTY_XML_CONFIG_FILE, UCP_ABANDONED_CONNECTION_TIMEOUT, UCP_COMMIT_ON_CONNECTION_RETURN, UCP_CONNECTION_AFFINITY_CALLBACK, UCP_CONNECTION_CREATION_CONSUMER, 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_VALIDATION_TIMEOUT, UCP_CONNECTION_WAIT_DURATION, UCP_CONNECTION_WAIT_TIMEOUT, UCP_CREATE_CONNECTION_IN_BORROW_THREAD, 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_IDLE, 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_READONLY_INSTANCE_ALLOWED, UCP_ROLE_NAME, UCP_SECONDS_TO_TRUST_IDLE_CONNECTION, UCP_SERVER_NAME, UCP_SERVICE_NAME, UCP_SHARDING_MODE, UCP_SQL_FOR_VALIDATE_CONNECTION, UCP_TIME_TO_LIVE_CONNECTION_TIMEOUT, UCP_TIMEOUT_CHECK_INTERVAL, UCP_URL, UCP_USER, UCP_VALIDATE_CONNECTION_ON_BORROW

Method Summary

Modifier and Type	Method	Description
UCPXAConnectionBuilder	createXAConnectionBuilder()	Creates a new XAConnectionBuilder instance.
XAConnection	getXAConnection()	Obtains an XA connection from the embedded Universal Connection Pool instance.
XAConnection	getXAConnection(String user, String password)	Obtains an XA connection from the embedded Universal Connection Pool instance, using the given user name and password.
XAConnection	getXAConnection(String username, String password, Properties labels)	Obtains an XA connection from the embedded Universal Connection Pool instance, using the given user name, password, and connection labels.
XAConnection	getXAConnection(Properties labels)	Obtains an XA connection from the embedded Universal Connection Pool instance, using the given connection labels.

Methods inherited from interface javax.sql.CommonDataSource

getParentLogger

Methods inherited from interface javax.sql.DataSource

getConnection, getConnection, getLoginTimeout, getLogWriter, setLoginTimeout, setLogWriter

Methods inherited from interface oracle.ucp.diagnostics.Diagnosable

beginCurrentSql, debug, debug, endCurrentSql, format, getDiagnosable, isLoggingLevelFinest, resumeLogging, secure, suspendLogging, trace, trace

Methods inherited from interface oracle.ucp.jdbc.PoolDataSource

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

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Methods inherited from interface javax.sql.XADataSource

getLoginTimeout, getLogWriter, setLoginTimeout, setLogWriter

Method Details

getXAConnection

XAConnection getXAConnection()
                      throws SQLException

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

Specified by:

getXAConnection in interface XADataSource

Returns:

An XAConnection object that can be used in a distributed transaction.

Throws:

SQLException - if a database access error occurs.

getXAConnection

XAConnection getXAConnection(String user,
 String password)
                      throws SQLException

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

Specified by:

getXAConnection in interface XADataSource

Parameters:

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

password - The user's password.

Returns:

An XAConnection object that can be used in a distributed transaction.

Throws:

SQLException - if a database access error occurs.

getXAConnection

XAConnection getXAConnection(Properties labels)
                      throws SQLException

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

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:

SQLException - if a database access error occurs.

getXAConnection

XAConnection getXAConnection(String username,
 String password,
 Properties labels)
                      throws SQLException

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

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 that can be used in a distributed transaction.

Throws:

SQLException - if a database access error occurs.

createXAConnectionBuilder

UCPXAConnectionBuilder createXAConnectionBuilder()

Creates a new XAConnectionBuilder instance.

Specified by:

createXAConnectionBuilder in interface XADataSource

Returns:

The XAConnectionBuilder instance that was created