Package oracle.ucp.jdbc.oracle

Class OracleUniversalPooledConnection

java.lang.Object

oracle.ucp.common.FailoverableUniversalPooledConnectionBase

oracle.ucp.jdbc.JDBCUniversalPooledConnection

oracle.ucp.jdbc.oracle.OracleUniversalPooledConnection

All Implemented Interfaces:

Closeable, AutoCloseable, oracle.ucp.common.FailoverableUniversalPooledConnection, FailoverablePooledConnection, OracleFailoverablePooledConnection, UniversalPooledConnection

public class OracleUniversalPooledConnection
extends JDBCUniversalPooledConnection
implements OracleFailoverablePooledConnection, FailoverablePooledConnection

Field Summary

Fields

Modifier and Type	Field	Description
static int	CANCELLATION_TIMEOUT
protected Semaphore	validitySemaphore

Constructor Summary

Constructors

Constructor	Description
OracleUniversalPooledConnection(JDBCConnectionPool connectionPool, Object connection, ConnectionRetrievalInfo connectionRetrievalInfo, boolean connectionFailoverEnabled)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	abort()	TODO document abort connection
void	applyConnectionLabel(String key, String value)	Connection labels can be applied on a borrowed connection by calling this method at any time when the connection remains open.
boolean	attachServerConnection(Properties requestedLabels)
void	close()	TODO document close connection
void	close(boolean isConnectionBorrowed)	Closes the underlying physical connection.
void	detachServerConnection(String tag)
protected Properties	findUnmatchedTags(Properties requestedLabels)	Compares the requested labels and DRCP return tag and returns the unmatched tags
AbandonedConnectionTimeoutCallback	getAbandonedConnectionTimeoutCallback()	Obtains the AbandonedConnectionTimeoutCallback registered with this connection.
long	getAvailableStartTime()	Gets the time that this pooled connection became available.
long	getBorrowedStartTime()	Gets the timestamp that this pooled connection became borrowed.
ConnectionHarvestingCallback	getConnectionHarvestingCallback()	Obtains the ConnectionHarvestingCallback registered with this connection.
Properties	getConnectionInfo()
Properties	getConnectionLabels()	Retrieves all the connection labels applied on this connection.
ConnectionRetrievalInfo	getConnectionRetrievalInfo()	Gets the connection retrieval info.
int	getConnectionReuseCounter()	Gets the connection reuse counter.
long	getConnectionReuseTimestamp()	Gets the connection reuse timestamp.
String	getDatabase()
Properties	getDatabaseConnectionProperties()	Fetches the connection properties.
int	getDatabaseVersion()
String	getDataSourceInstanceName()	Gets the data source instance name from which the physical connection was retrieved.
String	getDbUniqueName()	Gets the database unique name from which the physical connection was retrieved.
oracle.ucp.common.CoreConnection	getDelegator()
String	getDRCPPLSQLCallbackName()	Returns the PL/SQL Fix-up callback name if configured for the given connection, otherwise returns Null.
String	getDRCPReturnTag()	Returns the tag associated with this DRCP pooled server.
protected String	getDRCPTag(Properties labelProperties)	Returns valid DRCP tag using the Label properties.
String	getHost()
String	getHostName()	Gets the host name from which the physical connection was retrieved.
String	getInstance()	Returns the RAC instance name that this connects to.
int	getInstanceNumber()
Date	getInstanceStartTime()
long	getLastAccessedTime()	Gets the last time, in milliseconds, that this pooled connection was used by the client.
long	getLastConnectionValidationTime()	Gets the time that this pooled connection was last validated.
long	getLastNetworkAccessTime()	Gets the time (in milliseconds) when the underlying connection last accessed the network.
Object	getPhysicalConnection()	Gets the connection.
oracle.ucp.jdbc.oracle.rlb.RLBInfo.Frame	getRlbBorrowStats()
String	getService()
String	getServiceName()	Gets the service name from which the physical connection was retrieved.
boolean[]	getShardingMode()
Connection	getSQLConnection(Object physicalConnection)
UniversalPooledConnectionStatus	getStatus()	Gets the status of the pooled connection.
TimeToLiveConnectionTimeoutCallback	getTimeToLiveConnectionTimeoutCallback()	Obtains the TimeToLiveConnectionTimeoutCallback registered with this connection.
Properties	getUnmatchedConnectionLabels(Properties requestedLabels)	This is overridden to handle DRCP tagging case.
void	handleTimeout()	TODO document handle timeouts on connection
void	heartbeat()	This method is to be called to indicate that the pooled connection is alive and being used.
protected void	initFailoverParameters()	Initializes the failover properties on this Universal Pooled Connection.
void	initPdbSession(ConnectionRetrievalInfo cri)	Initializes the connection with PDB specific settings if not already initialized.
boolean	isAvailable()	check whether a connection is "available" or not
boolean	isConnectionHarvestable()	Whether this connection is currently harvestable.
boolean	isDRCPEnabled()
boolean	isDRCPMultitagEnabled()	Returns true if multiple tags are allowed with DRCP Connection.
boolean	isMultitenantDatabase()
boolean	isNamedInstanceConnection()
boolean	isOracle()	Is this connection an Oracle connection?
boolean	isRacDataAffinityEnabled()	Checks if the connection is to a Database with RAC Affinity Enabled
boolean	isReusable()	check whether a connection is "reusable" or not
boolean	isSqlWithQueryTimeoutInProgress()	Checks whether or not the connection currently performing timed-out SQL operation
boolean	isValid(long timeout)	This method is called to check if the connection is valid or not.
boolean	isValid()	This method is called to check if the connection is valid or not.
int	labelingCost(Properties labels)	If DRCP Multi-tag is enabled then this method skips the cost calculation using labeling callback cost() It compares the expected and current labels and return 0 incase of exact match, otherwise returns Integer.MAX_VALUE value.
void	plugDelegator(oracle.ucp.common.CoreConnection delegator)
void	registerAbandonedConnectionTimeoutCallback(AbandonedConnectionTimeoutCallback cbk)	Registers an AbandonedConnectionTimeoutCallback with this connection.
void	registerConnectionHarvestingCallback(ConnectionHarvestingCallback cbk)	Registers a ConnectionHarvestingCallback with this connection.
void	registerTimeToLiveConnectionTimeoutCallback(TimeToLiveConnectionTimeoutCallback cbk)	Registers a TimeToLiveConnectionTimeoutCallback with this connection.
void	removeAbandonedConnectionTimeoutCallback()	Removes the AbandonedConnectionTimeoutCallback object registered with this connection, if any.
void	removeConnectionHarvestingCallback()	Removes the ConnectionHarvestingCallback object registered with this connection, if any.
void	removeConnectionLabel(String key)	Removes the connection label with the given key from the connection labels applied on this connection.
void	removeTimeToLiveConnectionTimeoutCallback()	Removes the TimeToLiveConnectionTimeoutCallback object registered with this connection, if any.
void	setAsNamedInstanceConnection()
boolean	setAvailable()	mark connection as "available"
void	setAvailableStartTime()	Sets the time that this pooled connection became available.
boolean	setBorrowed()	mark connection as "borrowed"
void	setBorrowedStartTime()	Sets the time that this pooled connection became borrowed to be the current system time.
void	setConnectionHarvestable(boolean isConnectionHarvestable)	Specifies whether this connection is harvestable.
void	setConnectionRetrievalInfo(ConnectionRetrievalInfo newCri)	Sets the connection retrieval info on the connection.
void	setDataSourceInstanceName(String dataSourceInstanceName)	Sets the data source instance name from which the physical connection was retrieved.
void	setDbUniqueName(String dbUniqueName)	Sets the database unique name from which the physical connection was retrieved.
void	setHostName(String hostName)	Sets the host name from which the physical connection was retrieved.
void	setLastConnectionValidationTime(long lastConnectionValidationTime)	Sets or resets the time when this pooled connection was last validated.
void	setMaxStatements(int maxStatements)	Sets the maximum number of statements that may be pooled or cached on a connection.
void	setPdbSessionInitialized(boolean initialized)	For a multitenant database, when connected to PDB, checks if the PDB session is initialized before the connection is checked out to the user.
void	setRlbBorrowStats(oracle.ucp.jdbc.oracle.rlb.RLBInfo.Frame rlbStats)
void	setServiceName(String serviceName)	Sets the service name from which the physical connection was retrieved.
boolean	setShardingKeyIfValid(OracleShardingKey key, OracleShardingKey superKey, int timeout)	No implementation in base class, will be implemented in Oracle specific connection class.
void	setSqlWithQueryTimeoutInProgress(boolean sqlWithQueryTimeoutInProgress)	Marks connection currently performing timed-out SQL operation
void	setStatus(UniversalPooledConnectionStatus status)	Sets the status of the pooled connection.
void	setStatus(UniversalPooledConnectionStatus status, String msg)
void	validate()	Validates this connection and sets corresponding status on this connection.
protected void	validateDRCPKeyAndValue(String key, String value)	Checks if the Label key and value are valid.

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

getStatus, setStatus

Methods inherited from interface oracle.ucp.common.FailoverableUniversalPooledConnection

isFailoverEnabled

Methods inherited from class oracle.ucp.common.FailoverableUniversalPooledConnectionBase

isFailoverEnabled

Methods inherited from class oracle.ucp.jdbc.JDBCUniversalPooledConnection

getMaxStatements

Methods inherited from class java.lang.Object

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

Field Detail

CANCELLATION_TIMEOUT

public static final int CANCELLATION_TIMEOUT

See Also:

Constant Field Values

validitySemaphore

protected final Semaphore validitySemaphore

Constructor Detail

OracleUniversalPooledConnection

public OracleUniversalPooledConnection(JDBCConnectionPool connectionPool,
                                       Object connection,
                                       ConnectionRetrievalInfo connectionRetrievalInfo,
                                       boolean connectionFailoverEnabled)
                                throws UniversalConnectionPoolException

Constructor.

Parameters:

connection - The connection.

connectionRetrievalInfo - The connection retrieval info used to create this connection.

connectionFailoverEnabled - true if failover is enabled for this pooled connection. false otherwise.

Throws:

UniversalConnectionPoolException - if connection or connection retrieval info is null.

Method Detail

validate

public void validate()

Validates this connection and sets corresponding status on this connection. Possibly incurs a round-trip to the resource.

Specified by:

validate in interface UniversalPooledConnection

Overrides:

validate in class JDBCUniversalPooledConnection

isValid

public boolean isValid()

This method is called to check if the connection is valid or not. Also checks the validity of the shard keys for this connection

Specified by:

isValid in interface UniversalPooledConnection

Returns:

true if connection is valid, false otherwise

getLastNetworkAccessTime

public long getLastNetworkAccessTime()

Gets the time (in milliseconds) when the underlying connection last accessed the network.

Specified by:

getLastNetworkAccessTime in interface UniversalPooledConnection

Returns:

The time (in milliseconds) when the underlying connection last accessed the network.

setShardingKeyIfValid

public boolean setShardingKeyIfValid(OracleShardingKey key,
                                     OracleShardingKey superKey,
                                     int timeout)

Description copied from class: JDBCUniversalPooledConnection

No implementation in base class, will be implemented in Oracle specific connection class. Just redirecting the validation to isValid(timeout)

Overrides:

setShardingKeyIfValid in class JDBCUniversalPooledConnection

Parameters:

key - sharding key to be set on the connection

superKey - super sharding key to be set on the connection

timeout - timeout associated with the validation check

Returns:

true if the connection is valid and the sharding keys are valid for this connection ,false if any of the two criteria fail.

See Also:

oracle.ucp.common.UniversalPooledConnectionImpl#isValid(oracle.jdbc.OracleShardingKey, oracle.jdbc.OracleShardingKey, int)

initFailoverParameters

protected void initFailoverParameters()
                               throws UniversalConnectionPoolException

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

Initializes the failover properties on this Universal Pooled Connection.

Overrides:

initFailoverParameters in class JDBCUniversalPooledConnection

Throws:

UniversalConnectionPoolException

getInstanceNumber

public int getInstanceNumber()

Specified by:

getInstanceNumber in interface FailoverablePooledConnection

getDataSourceInstanceName

public String getDataSourceInstanceName()

Description copied from interface: OracleFailoverablePooledConnection

Gets the data source instance name from which the physical connection was retrieved. Valid only if failover is enabled.

Specified by:

getDataSourceInstanceName in interface OracleFailoverablePooledConnection

Returns:

The data source instance name from which the physical connection was retrieved. Valid only if failover is enabled. May be null.

setDataSourceInstanceName

public void setDataSourceInstanceName(String dataSourceInstanceName)

Description copied from interface: OracleFailoverablePooledConnection

Sets the data source instance name from which the physical connection was retrieved. Valid only if failover is enabled.

Specified by:

setDataSourceInstanceName in interface OracleFailoverablePooledConnection

getDbUniqueName

public String getDbUniqueName()

Description copied from interface: OracleFailoverablePooledConnection

Gets the database unique name from which the physical connection was retrieved. Valid only if failover is enabled.

Specified by:

getDbUniqueName in interface OracleFailoverablePooledConnection

Returns:

The database unique name from which the physical connection was retrieved. Valid only if failover is enabled. May be null.

setDbUniqueName

public void setDbUniqueName(String dbUniqueName)

Description copied from interface: OracleFailoverablePooledConnection

Sets the database unique name from which the physical connection was retrieved. Valid only if failover is enabled.

Specified by:

setDbUniqueName in interface OracleFailoverablePooledConnection

getHostName

public String getHostName()

Description copied from interface: OracleFailoverablePooledConnection

Gets the host name from which the physical connection was retrieved. Valid only if failover is enabled.

Specified by:

getHostName in interface OracleFailoverablePooledConnection

Returns:

The host name from which the physical connection was retrieved. Valid only if failover is enabled. May be null.

setHostName

public void setHostName(String hostName)

Description copied from interface: OracleFailoverablePooledConnection

Sets the host name from which the physical connection was retrieved. Valid only if failover is enabled.

Specified by:

setHostName in interface OracleFailoverablePooledConnection

getServiceName

public String getServiceName()

Description copied from interface: OracleFailoverablePooledConnection

Gets the service name from which the physical connection was retrieved. Valid only if failover is enabled.

Specified by:

getServiceName in interface OracleFailoverablePooledConnection

Returns:

The service name from which the physical connection was retrieved. Valid only if failover is enabled. May be null.

setServiceName

public void setServiceName(String serviceName)

Description copied from interface: OracleFailoverablePooledConnection

Sets the service name from which the physical connection was retrieved. Valid only if failover is enabled.

Specified by:

setServiceName in interface OracleFailoverablePooledConnection

setMaxStatements

public void setMaxStatements(int maxStatements)
                      throws SQLException

Description copied from class: JDBCUniversalPooledConnection

Sets the maximum number of statements that may be pooled or cached on a connection. This is used to enable the statement pooling.

Overrides:

setMaxStatements in class JDBCUniversalPooledConnection

Parameters:

maxStatements - maximum number of statements to be pooled.

Throws:

SQLException - Exception occurred during the process of setting maximum statements that may be pooled on a connection.

abort

public void abort()

Description copied from interface: UniversalPooledConnection

TODO document abort connection

Specified by:

abort in interface FailoverablePooledConnection

Specified by:

abort in interface UniversalPooledConnection

handleTimeout

public void handleTimeout()

Description copied from interface: UniversalPooledConnection

TODO document handle timeouts on connection

Specified by:

handleTimeout in interface UniversalPooledConnection

getSQLConnection

public Connection getSQLConnection(Object physicalConnection)
                            throws SQLException

Overrides:

getSQLConnection in class JDBCUniversalPooledConnection

Throws:

SQLException

setAvailable

public boolean setAvailable()

Description copied from interface: UniversalPooledConnection

mark connection as "available"

Specified by:

setAvailable in interface UniversalPooledConnection

Returns:

true, if it was previously "borrowed", false otherwise

attachServerConnection

public boolean attachServerConnection(Properties requestedLabels)
                               throws SQLException

Throws:

SQLException

detachServerConnection

public void detachServerConnection(String tag)
                            throws SQLException

Throws:

SQLException

getDRCPTag

protected String getDRCPTag(Properties labelProperties)
                     throws SQLException

Returns valid DRCP tag using the Label properties. The tag has to be in key1=value1;key2=value2.. format. If label value is NULL then the String "NULL" is used as default DRCP tag value.

Parameters:

labelProperties -

Returns:

drcpTag

Throws:

SQLException

validateDRCPKeyAndValue

protected void validateDRCPKeyAndValue(String key,
                                       String value)
                                throws SQLException

Checks if the Label key and value are valid. The key and label can not have = or ; character. If any of the key or value is not valid then SQLException is thrown.

Parameters:

key -

value -

Throws:

SQLException

isDRCPEnabled

public boolean isDRCPEnabled()
                      throws SQLException

Throws:

SQLException

isDRCPMultitagEnabled

public boolean isDRCPMultitagEnabled()
                              throws SQLException

Returns true if multiple tags are allowed with DRCP Connection.

Returns:

true if DRCP multitagging is enabled.

Throws:

SQLException

getDRCPReturnTag

public String getDRCPReturnTag()
                        throws UniversalConnectionPoolException

Returns the tag associated with this DRCP pooled server. If multiple tags are used, they will be separated by a semicolon. If tagging is not enabled or not available or if this connection is currently not attached to any DRCP pooled server then this method returns null.

Throws:

SQLException

UniversalConnectionPoolException

getDRCPPLSQLCallbackName

public String getDRCPPLSQLCallbackName()
                                throws UniversalConnectionPoolException

Returns the PL/SQL Fix-up callback name if configured for the given connection, otherwise returns Null.

Throws:

SQLException

UniversalConnectionPoolException

getUnmatchedConnectionLabels

public Properties getUnmatchedConnectionLabels(Properties requestedLabels)
                                        throws UniversalConnectionPoolException

This is overridden to handle DRCP tagging case. In case of DRCP tagging the match is a boolean value unlike UCP which has partial match. So this override will make UCP behave match as boolean.

Specified by:

getUnmatchedConnectionLabels in interface UniversalPooledConnection

Parameters:

requestedLabels - The requested labels that borrowed this connection from the pool.

Returns:

A java.util.Properties object storing all the requested labels that did not match the labels applied on this connection. Returns null if there are none.

Throws:

UniversalConnectionPoolException - If this connection was closed.

findUnmatchedTags

protected Properties findUnmatchedTags(Properties requestedLabels)
                                throws UniversalConnectionPoolException

Compares the requested labels and DRCP return tag and returns the unmatched tags

Parameters:

requestedLabels -

Returns:

new java.util.Properties instance which has only unmatched tags

Throws:

UniversalConnectionPoolException

getDatabaseVersion

public int getDatabaseVersion()
                       throws UniversalConnectionPoolException

Specified by:

getDatabaseVersion in interface FailoverablePooledConnection

Throws:

UniversalConnectionPoolException

isNamedInstanceConnection

public boolean isNamedInstanceConnection()

Specified by:

isNamedInstanceConnection in interface FailoverablePooledConnection

setAsNamedInstanceConnection

public void setAsNamedInstanceConnection()

Specified by:

setAsNamedInstanceConnection in interface FailoverablePooledConnection

getInstance

public String getInstance()

Returns the RAC instance name that this connects to.

Specified by:

getInstance in interface FailoverablePooledConnection

Returns:

The RAC instance name.

getService

public String getService()

Specified by:

getService in interface FailoverablePooledConnection

getHost

public String getHost()

Specified by:

getHost in interface FailoverablePooledConnection

getDatabase

public String getDatabase()

Specified by:

getDatabase in interface FailoverablePooledConnection

close

public void close(boolean isConnectionBorrowed)
           throws UniversalConnectionPoolException

Closes the underlying physical connection.

Specified by:

close in interface FailoverablePooledConnection

Throws:

UniversalConnectionPoolException

getInstanceStartTime

public Date getInstanceStartTime()

Specified by:

getInstanceStartTime in interface FailoverablePooledConnection

getConnectionInfo

public Properties getConnectionInfo()
                             throws UniversalConnectionPoolException

Specified by:

getConnectionInfo in interface FailoverablePooledConnection

Throws:

UniversalConnectionPoolException

getRlbBorrowStats

public oracle.ucp.jdbc.oracle.rlb.RLBInfo.Frame getRlbBorrowStats()

setRlbBorrowStats

public void setRlbBorrowStats(oracle.ucp.jdbc.oracle.rlb.RLBInfo.Frame rlbStats)

isMultitenantDatabase

public boolean isMultitenantDatabase()

getShardingMode

public boolean[] getShardingMode()

isRacDataAffinityEnabled

public boolean isRacDataAffinityEnabled()

Checks if the connection is to a Database with RAC Affinity Enabled

Returns:

true if connected to a database with RAC Affinity enabled, false otherwise

getDatabaseConnectionProperties

public Properties getDatabaseConnectionProperties()

Fetches the connection properties.

Specified by:

getDatabaseConnectionProperties in interface UniversalPooledConnection

setPdbSessionInitialized

public void setPdbSessionInitialized(boolean initialized)

For a multitenant database, when connected to PDB, checks if the PDB session is initialized before the connection is checked out to the user.

Parameters:

initialized - false if connected to a Multitenant database and if the session is not initialized, true otherwise. (Internal API)

initPdbSession

public void initPdbSession(ConnectionRetrievalInfo cri)
                    throws SQLException

Initializes the connection with PDB specific settings if not already initialized. Currently the only PDB specific initialization is setting the PDB roles and passwords as specified on the datasource or the connection request.

Throws:

SQLException - if there any exception during initialization

labelingCost

public int labelingCost(Properties labels)

If DRCP Multi-tag is enabled then this method skips the cost calculation using labeling callback cost() It compares the expected and current labels and return 0 incase of exact match, otherwise returns Integer.MAX_VALUE value.

Specified by:

labelingCost in interface UniversalPooledConnection

Returns:

cost of that labeling

getPhysicalConnection

public Object getPhysicalConnection()

Gets the connection.

Specified by:

getPhysicalConnection in interface UniversalPooledConnection

Returns:

The connection. Never null.

getConnectionRetrievalInfo

public ConnectionRetrievalInfo getConnectionRetrievalInfo()

Gets the connection retrieval info.

Specified by:

getConnectionRetrievalInfo in interface UniversalPooledConnection

Returns:

The connection retrieval info. Never null.

setConnectionRetrievalInfo

public void setConnectionRetrievalInfo(ConnectionRetrievalInfo newCri)

Description copied from interface: UniversalPooledConnection

Sets the connection retrieval info on the connection.

Specified by:

setConnectionRetrievalInfo in interface UniversalPooledConnection

Parameters:

newCri - -new CRI to be used for this connection

heartbeat

public void heartbeat()

This method is to be called to indicate that the pooled connection is alive and being used.

Specified by:

heartbeat in interface UniversalPooledConnection

setSqlWithQueryTimeoutInProgress

public void setSqlWithQueryTimeoutInProgress(boolean sqlWithQueryTimeoutInProgress)

Marks connection currently performing timed-out SQL operation

Specified by:

setSqlWithQueryTimeoutInProgress in interface UniversalPooledConnection

Parameters:

set - true if timed-out SQL operation is in progress

isSqlWithQueryTimeoutInProgress

public boolean isSqlWithQueryTimeoutInProgress()

Checks whether or not the connection currently performing timed-out SQL operation

Specified by:

isSqlWithQueryTimeoutInProgress in interface UniversalPooledConnection

Returns:

true if timed-out SQL operation is in progress

isValid

public boolean isValid(long timeout)
                throws SQLException

This method is called to check if the connection is valid or not.

Parameters:

timeout - connection validation timeout in seconds.

Returns:

true if connection is valid, false otherwise.

Throws:

SQLException

getLastAccessedTime

public long getLastAccessedTime()

Gets the last time, in milliseconds, that this pooled connection was used by the client. This time is updated when the heartbeat method is called.

Specified by:

getLastAccessedTime in interface UniversalPooledConnection

Returns:

The last time, in milliseconds, that this pooled connection was used by the client.

getStatus

public UniversalPooledConnectionStatus getStatus()

Gets the status of the pooled connection.

Specified by:

getStatus in interface UniversalPooledConnection

Returns:

The status of the pooled connection.

setStatus

public void setStatus(UniversalPooledConnectionStatus status)
               throws UniversalConnectionPoolException

Sets the status of the pooled connection.

Specified by:

setStatus in interface UniversalPooledConnection

Parameters:

status - The status of the pooled connection.

Throws:

UniversalConnectionPoolException - if an error occurs setting the status.

setStatus

public void setStatus(UniversalPooledConnectionStatus status,
                      String msg)

getAvailableStartTime

public long getAvailableStartTime()

Gets the time that this pooled connection became available.

Specified by:

getAvailableStartTime in interface UniversalPooledConnection

Returns:

The time that this pooled connection became available.

setAvailableStartTime

public void setAvailableStartTime()

Sets the time that this pooled connection became available.

Specified by:

setAvailableStartTime in interface UniversalPooledConnection

getBorrowedStartTime

public long getBorrowedStartTime()

Gets the timestamp that this pooled connection became borrowed.

Specified by:

getBorrowedStartTime in interface UniversalPooledConnection

Returns:

The time that this pooled connection became available.

setBorrowedStartTime

public void setBorrowedStartTime()

Sets the time that this pooled connection became borrowed to be the current system time.

Specified by:

setBorrowedStartTime in interface UniversalPooledConnection

getLastConnectionValidationTime

public long getLastConnectionValidationTime()

Gets the time that this pooled connection was last validated.

Specified by:

getLastConnectionValidationTime in interface UniversalPooledConnection

Returns:

The time that this pooled connection was last validated.

setLastConnectionValidationTime

public void setLastConnectionValidationTime(long lastConnectionValidationTime)

Sets or resets the time when this pooled connection was last validated.

Specified by:

setLastConnectionValidationTime in interface UniversalPooledConnection

applyConnectionLabel

public void applyConnectionLabel(String key,
                                 String value)
                          throws UniversalConnectionPoolException

Connection labels can be applied on a borrowed connection by calling this method at any time when the connection remains open. Applying connection labels is cumulative; each time this method is called, the supplied key/value pair is added to those connection labels already applied. However, for each particular label key, only the last applied value is retained. Applying connection labels on a closed connection throws UniversalConnectionPoolException.

Specified by:

applyConnectionLabel in interface UniversalPooledConnection

Parameters:

key - The key of the connection label to be applied. Cannot be null or an empty string.

value - The value of the connection label to be applied. Can be null or an empty string.

Throws:

UniversalConnectionPoolException - If this connection was closed or the key is null or an empty string.

removeConnectionLabel

public void removeConnectionLabel(String key)
                           throws UniversalConnectionPoolException

Removes the connection label with the given key from the connection labels applied on this connection. This method does nothing if there is no applied label with the specified key.

Specified by:

removeConnectionLabel in interface UniversalPooledConnection

Parameters:

key - The key of the connection label to be removed. Cannot be null or an empty string.

Throws:

UniversalConnectionPoolException - If this connection was closed or the key is null or an empty string.

getConnectionLabels

public Properties getConnectionLabels()
                               throws UniversalConnectionPoolException

Retrieves all the connection labels applied on this connection. Any change to the result Properties object does not affect the labels applied to this connection.

Specified by:

getConnectionLabels in interface UniversalPooledConnection

Returns:

A java.util.Properties object storing all the applied labels as key/value pairs. Returns null if there are no applied labels on this connection.

Throws:

UniversalConnectionPoolException - If this connection was closed.

setConnectionHarvestable

public void setConnectionHarvestable(boolean isConnectionHarvestable)
                              throws UniversalConnectionPoolException

Specifies whether this connection is harvestable.

Specified by:

setConnectionHarvestable in interface UniversalPooledConnection

Parameters:

isConnectionHarvestable - Whether this connection is harvestable.

Throws:

UniversalConnectionPoolException - If this connection was closed.

isConnectionHarvestable

public boolean isConnectionHarvestable()

Whether this connection is currently harvestable.

Specified by:

isConnectionHarvestable in interface UniversalPooledConnection

Returns:

A boolean indicating whether this connection is harvestable. True if so and false otherwise.

registerConnectionHarvestingCallback

public void registerConnectionHarvestingCallback(ConnectionHarvestingCallback cbk)
                                          throws UniversalConnectionPoolException

Registers a ConnectionHarvestingCallback with this connection.

Specified by:

registerConnectionHarvestingCallback in interface UniversalPooledConnection

Parameters:

cbk - The ConnectionHarvestingCallback object to be registered.

Throws:

UniversalConnectionPoolException - If there is a callback already registered with the connection.

removeConnectionHarvestingCallback

public void removeConnectionHarvestingCallback()
                                        throws UniversalConnectionPoolException

Removes the ConnectionHarvestingCallback object registered with this connection, if any.

Specified by:

removeConnectionHarvestingCallback in interface UniversalPooledConnection

Throws:

UniversalConnectionPoolException - If callback removal fails.

getConnectionHarvestingCallback

public ConnectionHarvestingCallback getConnectionHarvestingCallback()
                                                             throws UniversalConnectionPoolException

Obtains the ConnectionHarvestingCallback registered with this connection.

Specified by:

getConnectionHarvestingCallback in interface UniversalPooledConnection

Returns:

The ConnectionHarvestingCallback object registered. Null if none.

Throws:

UniversalConnectionPoolException - If an error occurs.

registerAbandonedConnectionTimeoutCallback

public void registerAbandonedConnectionTimeoutCallback(AbandonedConnectionTimeoutCallback cbk)
                                                throws UniversalConnectionPoolException

Registers an AbandonedConnectionTimeoutCallback with this connection.

Specified by:

registerAbandonedConnectionTimeoutCallback in interface UniversalPooledConnection

Parameters:

cbk - The AbandonedConnectionTimeoutCallback object to be registered.

Throws:

UniversalConnectionPoolException - If there is a callback already registered with the connection.

removeAbandonedConnectionTimeoutCallback

public void removeAbandonedConnectionTimeoutCallback()
                                              throws UniversalConnectionPoolException

Removes the AbandonedConnectionTimeoutCallback object registered with this connection, if any.

Specified by:

removeAbandonedConnectionTimeoutCallback in interface UniversalPooledConnection

Throws:

UniversalConnectionPoolException - If callback removal fails.

getAbandonedConnectionTimeoutCallback

public AbandonedConnectionTimeoutCallback getAbandonedConnectionTimeoutCallback()
                                                                         throws UniversalConnectionPoolException

Obtains the AbandonedConnectionTimeoutCallback registered with this connection.

Specified by:

getAbandonedConnectionTimeoutCallback in interface UniversalPooledConnection

Returns:

The AbandonedConnectionTimeoutCallback object registered. Null if none.

Throws:

UniversalConnectionPoolException - If an error occurs.

registerTimeToLiveConnectionTimeoutCallback

public void registerTimeToLiveConnectionTimeoutCallback(TimeToLiveConnectionTimeoutCallback cbk)
                                                 throws UniversalConnectionPoolException

Registers a TimeToLiveConnectionTimeoutCallback with this connection.

Specified by:

registerTimeToLiveConnectionTimeoutCallback in interface UniversalPooledConnection

Parameters:

cbk - The TimeToLiveConnectionTimeoutCallback object to be registered.

Throws:

UniversalConnectionPoolException - If there is a callback already registered with the connection.

removeTimeToLiveConnectionTimeoutCallback

public void removeTimeToLiveConnectionTimeoutCallback()
                                               throws UniversalConnectionPoolException

Removes the TimeToLiveConnectionTimeoutCallback object registered with this connection, if any.

Specified by:

removeTimeToLiveConnectionTimeoutCallback in interface UniversalPooledConnection

Throws:

UniversalConnectionPoolException - If callback removal fails.

getTimeToLiveConnectionTimeoutCallback

public TimeToLiveConnectionTimeoutCallback getTimeToLiveConnectionTimeoutCallback()
                                                                           throws UniversalConnectionPoolException

Obtains the TimeToLiveConnectionTimeoutCallback registered with this connection.

Specified by:

getTimeToLiveConnectionTimeoutCallback in interface UniversalPooledConnection

Returns:

The TimeToLiveConnectionTimeoutCallback object registered. Null if none.

Throws:

UniversalConnectionPoolException - If an error occurs.

getConnectionReuseCounter

public int getConnectionReuseCounter()

Gets the connection reuse counter.

Returns:

the m_connectionReuseCounter.

getConnectionReuseTimestamp

public long getConnectionReuseTimestamp()

Gets the connection reuse timestamp.

Returns:

the m_connectionReuseTimestamp.

isReusable

public boolean isReusable()

Description copied from interface: UniversalPooledConnection

check whether a connection is "reusable" or not

Specified by:

isReusable in interface UniversalPooledConnection

Returns:

true, if it is "reusable", false otherwise

close

public void close()

Description copied from interface: UniversalPooledConnection

TODO document close connection

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface UniversalPooledConnection

isAvailable

public boolean isAvailable()

Description copied from interface: UniversalPooledConnection

check whether a connection is "available" or not

Specified by:

isAvailable in interface UniversalPooledConnection

Returns:

true, if it is "available", false otherwise

setBorrowed

public boolean setBorrowed()

Description copied from interface: UniversalPooledConnection

mark connection as "borrowed"

Specified by:

setBorrowed in interface UniversalPooledConnection

Returns:

true, if it was previously "available", false otherwise

plugDelegator

public void plugDelegator(oracle.ucp.common.CoreConnection delegator)

Specified by:

plugDelegator in interface UniversalPooledConnection

getDelegator

public oracle.ucp.common.CoreConnection getDelegator()

Specified by:

getDelegator in interface UniversalPooledConnection

isOracle

public boolean isOracle()

Description copied from interface: UniversalPooledConnection

Is this connection an Oracle connection?

Specified by:

isOracle in interface UniversalPooledConnection

Returns:

true, if Oracle connection, otherwise (for non-oracle data sources) returns false