Package oracle.ucp.jdbc
Interface ConnectionWithTimeToLiveTimeout
public interface ConnectionWithTimeToLiveTimeout
Interface supporting time-to-live connection timeout handling for JDBC
java.sql.Connections.
A time-to-live connection allows a borrowed connection to remain borrowed only for a pre-determined period of time. When this period passes, this connection is reclaimed and put back into the connection pool.
The Universal Connection Pool supports the
timeToLiveConnectionTimeout pool
property and provides TimeToLiveConnectionTimeoutCallback to
allow customized handling of TTL timed-out connections.
Applications use this interface along with the
timeToLiveConnectionTimeout
properties for complete TTL-connection handling.
-
Method Summary
Modifier and TypeMethodDescriptionvoidRegisters a time-to-live connection timeout callback with this connection.voidRemoves theTimeToLiveConnectionTimeoutCallbackobject registered with this connection, if any.
-
Method Details
-
registerTimeToLiveConnectionTimeoutCallback
void registerTimeToLiveConnectionTimeoutCallback(TimeToLiveConnectionTimeoutCallback cbk) throws SQLException Registers a time-to-live connection timeout callback with this connection.- Parameters:
cbk- TheTimeToLiveConnectionTimeoutCallbackobject to be registered.- Throws:
SQLException- If there is a callback already registered with the connection.
-
removeTimeToLiveConnectionTimeoutCallback
Removes theTimeToLiveConnectionTimeoutCallbackobject registered with this connection, if any.- Throws:
SQLException- If callback removal fails.
-