Oracle JDBC API Reference
11g Release 2 ("11.2.0.3.0")

oracle.jdbc.pool
Class OracleConnectionCacheManager

java.lang.Object
  extended by oracle.jdbc.pool.OracleConnectionCacheManager

Deprecated. Use Oracle Universal Connection Pool instead. Connection Cache Manager class for the Implicit Connection Caching Mechanism.

public class OracleConnectionCacheManager
extends java.lang.Object


Field Summary
static java.lang.String BUILD_DATE
          Deprecated.  
static java.lang.String PHYSICAL_CONNECTION_CLOSED_COUNT
          Deprecated.  
static java.lang.String PHYSICAL_CONNECTION_CREATED_COUNT
          Deprecated.  
static int REFRESH_ALL_CONNECTIONS
          Deprecated.  
static int REFRESH_INVALID_CONNECTIONS
          Deprecated.  
static boolean TRACE
          Deprecated.  
 
Method Summary
 java.lang.String createCache(OracleDataSource ods, java.util.Properties cacheProperties)
          Deprecated. Use Oracle Universal Connection Pool instead. Creates a connection cache using an auto-generated Connection Cache name, and the supplied Connection Cache Properties. The Connection Cache created is associated with the DataSource Object provided.
 void createCache(java.lang.String cacheName, OracleDataSource ods, java.util.Properties cacheProperties)
          Deprecated. Use Oracle Universal Connection Pool instead. Creates a connection cache using the supplied Connection Cache name, and the Connection Cache Properties. The Connection Cache created is associated with the DataSource Object provided.
 void disableCache(java.lang.String cacheName)
          Deprecated. Use Oracle Universal Connection Pool instead. Disable a given connection cache
 void enableCache(java.lang.String cacheName)
          Deprecated. Use Oracle Universal Connection Pool instead. Enable a given connection cache
 boolean existsCache(java.lang.String cacheName)
          Deprecated. Use Oracle Universal Connection Pool instead. Check if connection cache exists.
 java.lang.String[] getCacheNameList()
          Deprecated. Use Oracle Universal Connection Pool instead. Get all the cache names managed by this connection cache manager
 java.util.Properties getCacheProperties(java.lang.String cacheName)
          Deprecated. Use Oracle Universal Connection Pool instead. Get the connection cache properties corresponding to the cache name.
static OracleConnectionCacheManager getConnectionCacheManagerInstance()
          Deprecated. Use Oracle Universal Connection Pool instead. Returns the static ConnectionCacheManager Instance. If necessary a new instance is created and returned to the caller.
 int[] getConnectionErrorCodes()
          Deprecated.  
 int getNumberOfActiveConnections(java.lang.String cacheName)
          Deprecated. Use Oracle Universal Connection Pool instead. Get the number of connections already in use (checked out connections)
 int getNumberOfAvailableConnections(java.lang.String cacheName)
          Deprecated. Use Oracle Universal Connection Pool instead. Get the number connections in the cache, that are available for use
 java.util.Map getStatistics(java.lang.String cacheName)
          Deprecated. Use Oracle Universal Connection Pool instead. Get the statistics about the implicit connection cache. The stats contains the number of connections opened and the number of connections closed.
 boolean isFatalConnectionError(java.sql.SQLException se)
          Deprecated.  
 void purgeCache(java.lang.String cacheName, boolean cleanupCheckedOutConnections)
          Deprecated. Use Oracle Universal Connection Pool instead. Purges Connections in the Connection Cache. A boolean flag indicates whether all connections in the cache are cleaned up(including checkedout connections) or just the connections in the cache
 void refreshCache(java.lang.String cacheName, int mode)
          Deprecated. Use Oracle Universal Connection Pool instead. Refreshes Connections in the Connection Cache.
 void reinitializeCache(java.lang.String cacheName, java.util.Properties cacheProperties)
          Deprecated. Use Oracle Universal Connection Pool instead. Reinitialize a connection cache using the new set of properties supplied
 void removeCache(java.lang.String cacheName, long waitTimeout)
          Deprecated. Use Oracle Universal Connection Pool instead. Removes the Connection Cache, associated with the given Connection Cache Name. When a timeout value is specified, the remove processing pauses for the specified period of time, before proceeding to remove the connection cache.
 void setConnectionErrorCodes(int[] fatalErrorCodes)
          Deprecated.  
 void setConnectionPoolDataSource(java.lang.String cacheName, javax.sql.ConnectionPoolDataSource ds)
          Deprecated. Use Oracle Universal Connection Pool instead. Sets the ConnectionPoolDataSource that may be used to create the implicit connection cache. If the connections are already created on the connection cache, then an exception is thrown. If no connections are opened, then the new ConnectionPoolDataSource is used and may overwrite the previous one, if any.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REFRESH_INVALID_CONNECTIONS

public static final int REFRESH_INVALID_CONNECTIONS
Deprecated. 
See Also:
Constant Field Values

REFRESH_ALL_CONNECTIONS

public static final int REFRESH_ALL_CONNECTIONS
Deprecated. 
See Also:
Constant Field Values

PHYSICAL_CONNECTION_CREATED_COUNT

public static final java.lang.String PHYSICAL_CONNECTION_CREATED_COUNT
Deprecated. 
See Also:
Constant Field Values

PHYSICAL_CONNECTION_CLOSED_COUNT

public static final java.lang.String PHYSICAL_CONNECTION_CLOSED_COUNT
Deprecated. 
See Also:
Constant Field Values

BUILD_DATE

public static final java.lang.String BUILD_DATE
Deprecated. 
See Also:
Constant Field Values

TRACE

public static final boolean TRACE
Deprecated. 
See Also:
Constant Field Values
Method Detail

getConnectionCacheManagerInstance

public static OracleConnectionCacheManager getConnectionCacheManagerInstance()
                                                                      throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Returns the static ConnectionCacheManager Instance. If necessary a new instance is created and returned to the caller.

Parameters:
None -
Returns:
OracleConnectionCacheManager object
Throws:
java.sql.SQLException - if a database access error occurs

createCache

public java.lang.String createCache(OracleDataSource ods,
                                    java.util.Properties cacheProperties)
                             throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Creates a connection cache using an auto-generated Connection Cache name, and the supplied Connection Cache Properties. The Connection Cache created is associated with the DataSource Object provided.

Parameters:
ods - OracleDataSource object
cacheProperties - Connection Cache Properties for this cache
Returns:
The auto-generated Connection Cache Name
Throws:
java.sql.SQLException - if a database access error occurs

createCache

public void createCache(java.lang.String cacheName,
                        OracleDataSource ods,
                        java.util.Properties cacheProperties)
                 throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Creates a connection cache using the supplied Connection Cache name, and the Connection Cache Properties. The Connection Cache created is associated with the DataSource Object provided.

Parameters:
cacheName - Connection Cache Name
ods - OracleDataSource object
cacheProperties - Connection Cache Properties for this cache
Throws:
java.sql.SQLException - if a database access error occurs

removeCache

public void removeCache(java.lang.String cacheName,
                        long waitTimeout)
                 throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Removes the Connection Cache, associated with the given Connection Cache Name. When a timeout value is specified, the remove processing pauses for the specified period of time, before proceeding to remove the connection cache.

Parameters:
cacheName - Connection Cache Name
waitTimeout - Timeout value, specified in seconds. A zero or a positive value will be the time allowed before closure of the cache. A negative timeout prompts aborting all the connections before close.
Throws:
java.sql.SQLException - if a database access error occurs

reinitializeCache

public void reinitializeCache(java.lang.String cacheName,
                              java.util.Properties cacheProperties)
                       throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Reinitialize a connection cache using the new set of properties supplied

Parameters:
cacheName - Connection Cache Name
Throws:
java.sql.SQLException - if a database access error occurs

existsCache

public boolean existsCache(java.lang.String cacheName)
                    throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Check if connection cache exists.

Parameters:
cacheName - Connection Cache Name
Returns:
true or false, depending on whether the Connection Cache exists
Throws:
java.sql.SQLException - if a database access error occurs

enableCache

public void enableCache(java.lang.String cacheName)
                 throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Enable a given connection cache

Parameters:
cacheName - Connection Cache Name
Throws:
java.sql.SQLException - if a database access error occurs

disableCache

public void disableCache(java.lang.String cacheName)
                  throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Disable a given connection cache

Parameters:
cacheName - Connection Cache Name
Throws:
java.sql.SQLException - if a database access error occurs

refreshCache

public void refreshCache(java.lang.String cacheName,
                         int mode)
                  throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Refreshes Connections in the Connection Cache.

Parameters:
cacheName - Connection Cache Name
mode - The operation to be done on the cache. Operation modes are, REFRESH_INVALID_CONNECTIONS - Refresh invalid connection on the node which is down. REFRESH_ALL_CONNECTIONS - Refresh all connection on the node which is down.
Throws:
java.sql.SQLException - if a database access error occurs

purgeCache

public void purgeCache(java.lang.String cacheName,
                       boolean cleanupCheckedOutConnections)
                throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Purges Connections in the Connection Cache. A boolean flag indicates whether all connections in the cache are cleaned up(including checkedout connections) or just the connections in the cache

Parameters:
cacheName - Connection Cache Name
Throws:
java.sql.SQLException - if a database access error occurs

getCacheProperties

public java.util.Properties getCacheProperties(java.lang.String cacheName)
                                        throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Get the connection cache properties corresponding to the cache name.

Parameters:
cacheName - Connection Cache Name
Returns:
Connection Cache Properties
Throws:
java.sql.SQLException - if a database access error occurs

getCacheNameList

public java.lang.String[] getCacheNameList()
                                    throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Get all the cache names managed by this connection cache manager

Parameters:
None -
Returns:
List of Connection Cache Names, returned as a String Array
Throws:
java.sql.SQLException - if a database access error occurs

getNumberOfAvailableConnections

public int getNumberOfAvailableConnections(java.lang.String cacheName)
                                    throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Get the number connections in the cache, that are available for use

Parameters:
cacheName - Connection Cache Name
Returns:
Number of Connections in the Cache
Throws:
java.sql.SQLException - if a database access error occurs

getNumberOfActiveConnections

public int getNumberOfActiveConnections(java.lang.String cacheName)
                                 throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Get the number of connections already in use (checked out connections)

Parameters:
cacheName - Connection Cache Name
Returns:
Number of Connections checked out
Throws:
java.sql.SQLException - if a database access error occurs

setConnectionPoolDataSource

public void setConnectionPoolDataSource(java.lang.String cacheName,
                                        javax.sql.ConnectionPoolDataSource ds)
                                 throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Sets the ConnectionPoolDataSource that may be used to create the implicit connection cache. If the connections are already created on the connection cache, then an exception is thrown. If no connections are opened, then the new ConnectionPoolDataSource is used and may overwrite the previous one, if any.

Parameters:
cacheName - Connection Cache Name
ds - a datasource from which the Implicit Cache can create PooledConnections.
Throws:
java.sql.SQLException - A ConnectionPoolDataSource object already exists and connections are already open.

isFatalConnectionError

public boolean isFatalConnectionError(java.sql.SQLException se)
Deprecated. 

setConnectionErrorCodes

public void setConnectionErrorCodes(int[] fatalErrorCodes)
                             throws java.sql.SQLException
Deprecated. 
Throws:
java.sql.SQLException

getConnectionErrorCodes

public int[] getConnectionErrorCodes()
                              throws java.sql.SQLException
Deprecated. 
Throws:
java.sql.SQLException

getStatistics

public java.util.Map getStatistics(java.lang.String cacheName)
                            throws java.sql.SQLException
Deprecated. Use Oracle Universal Connection Pool instead. Get the statistics about the implicit connection cache. The stats contains the number of connections opened and the number of connections closed.

Parameters:
cacheName - Name of the cache
Returns:
A map file containing the value of key: CONNECTION_CREATED_COUNT Number of connections opened. key: CONNECTION_CLOSED_COUNT Number of connections closed.
Throws:
java.sql.SQLException

Oracle JDBC API Reference
11g Release 2 ("11.2.0.3.0")

Copyright © 1998, 2007, Oracle. All rights reserved.