public interface HarvestableConnection
java.sql.Connections
.
Connection Harvesting allows the Universal Connection Pool to actively
return borrowed connections to the pool when a user-specified
threshold for harvesting is met or when the pool has reached
its max capacity yet all connections in the pool are borrowed.
Users have the option for specifying whether a borrowed connection
is harvestable, as well as providing customized cleanup actions on
harvestable connections.
Applications use this interface along with the harvesting properties
and callbacks for complete connection harvesting functions.PoolDataSource
,
ConnectionHarvestingCallback
Modifier and Type | Method and Description |
---|---|
boolean |
isConnectionHarvestable()
Specifies whether this connection is harvestable.
|
void |
registerConnectionHarvestingCallback(ConnectionHarvestingCallback cbk)
Registers a ConnectionHarvestingCallback with the this connection.
|
void |
removeConnectionHarvestingCallback()
Removes the ConnectionHarvestingCallback object registered with this
connection, if any.
|
void |
setConnectionHarvestable(boolean isConnectionHarvestable)
Specifies whether this connection is harvestable.
|
void setConnectionHarvestable(boolean isConnectionHarvestable) throws SQLException
isConnectionHarvestable
- Whether this connection is harvestable.SQLException
- If this connection was closed.boolean isConnectionHarvestable() throws SQLException
True
if so and false
otherwise.SQLException
- If an error occurs.void registerConnectionHarvestingCallback(ConnectionHarvestingCallback cbk) throws SQLException
cbk
- The ConnectionHarvestingCallback object to be registered.SQLException
- If there is a callback already
registered with the connection.void removeConnectionHarvestingCallback() throws SQLException
SQLException
- If callback removal fails.