BEA Systems, Inc.

weblogic.jdbc.extensions
Interface WLConnection


public interface WLConnection

Contains methods to interact with the Statement Cache


Method Summary
 boolean clearCallableStatement(String sql)
          Clears a callable statement from the Statement Cache
 boolean clearCallableStatement(String sql, int resType, int resConcurrency)
          Clears a callable statement from the Statement Cache
 boolean clearPreparedStatement(String sql)
          Clears a prepared statement from the Statement Cache
 boolean clearPreparedStatement(String sql, int resType, int resConcurrency)
          Clears a prepared statement from the Statement Cache
 void clearStatementCache()
          Clears the statement cache.
 String getPoolName()
          Returns the name of the connection pool to which this connection belongs to.
 Connection getVendorConnection()
          Returns the underlying physical connection (the vendor connection) from a pooled database connection (a logical connection).
 void setFailed()
          Force this connection to be destroyed by connection pool
 

Method Detail

clearStatementCache

void clearStatementCache()
                         throws SQLException
Clears the statement cache.

Throws:
SQLException - - if a database access error occurs

getVendorConnection

Connection getVendorConnection()
                               throws SQLException
Returns the underlying physical connection (the vendor connection) from a pooled database connection (a logical connection).

Returns:
java.sql.Connection
Throws:
SQLException - - if a database access error occurs

clearCallableStatement

boolean clearCallableStatement(String sql)
                               throws SQLException
Clears a callable statement from the Statement Cache

Parameters:
sql - - an SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string.
Returns:
true - statement found and removed from cache
false - statement not found in cache. This is not always an erroneous condition as it can happen if statement caching is diabled, or the statement got ejected from the cache to make space for another.
Throws:
SQLException - - if a database access error occurs

clearCallableStatement

boolean clearCallableStatement(String sql,
                               int resType,
                               int resConcurrency)
                               throws SQLException
Clears a callable statement from the Statement Cache

Parameters:
sql - - an SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string.
resSetType - - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resSetConcurrency - - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
Returns:
true - statement found and removed from cache
false - statement not found in cache. This is not always an erroneous condition as it can happen if statement caching is diabled, or the statement got ejected from the cache to make space for another.
Throws:
SQLException - - if a database access error occurs

clearPreparedStatement

boolean clearPreparedStatement(String sql)
                               throws SQLException
Clears a prepared statement from the Statement Cache

Parameters:
sql - - an SQL statement that may contain one or more '?' IN parameter placeholders
Returns:
true - statement found and removed from cache
false - statement not found in cache. This is not always an erroneous condition as it can happen if statement caching is diabled, or the statement got ejected from the cache to make space for another.
Throws:
SQLException - - if a database access error occurs

clearPreparedStatement

boolean clearPreparedStatement(String sql,
                               int resType,
                               int resConcurrency)
                               throws SQLException
Clears a prepared statement from the Statement Cache

Parameters:
sql - - an SQL statement that may contain one or more '?' IN parameter placeholders
resSetType - - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resSetConcurrency - - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
Returns:
true - statement found and removed from cache
false - statement not found in cache. This is not always an erroneous condition as it can happen if statement caching is diabled, or the statement got ejected from the cache to make space for another.
Throws:
SQLException - - if a database access error occurs

getPoolName

String getPoolName()
Returns the name of the connection pool to which this connection belongs to.


setFailed

void setFailed()
               throws SQLException
Force this connection to be destroyed by connection pool

Throws:
SQLException - - if a connection pool error happen

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs92
Copyright 2006 BEA Systems Inc.