javax.sql
Interface ConnectionPoolDataSource


public interface ConnectionPoolDataSource

A factory for PooledConnection objects. An object that implements this interface will typically be registered with a naming service that is based on the JavaTM Naming and Directory Interface (JNDI).

Since:
1.4

Method Summary
 int getLoginTimeout sample code for javax.sql.ConnectionPoolDataSource.getLoginTimeout() definition code for javax.sql.ConnectionPoolDataSource.getLoginTimeout() ()
          Retrieves the maximum time in seconds that this ConnectionPoolDataSource object will wait while attempting to connect to a database.
 PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter getLogWriter sample code for javax.sql.ConnectionPoolDataSource.getLogWriter() definition code for javax.sql.ConnectionPoolDataSource.getLogWriter() ()
          Retrieves the log writer for this ConnectionPoolDataSource object.
 PooledConnection sample code for javax.sql.PooledConnection definition code for javax.sql.PooledConnection getPooledConnection sample code for javax.sql.ConnectionPoolDataSource.getPooledConnection() definition code for javax.sql.ConnectionPoolDataSource.getPooledConnection() ()
          Attempts to establish a physical database connection that can be used as a pooled connection.
 PooledConnection sample code for javax.sql.PooledConnection definition code for javax.sql.PooledConnection getPooledConnection sample code for javax.sql.ConnectionPoolDataSource.getPooledConnection(java.lang.String, java.lang.String) definition code for javax.sql.ConnectionPoolDataSource.getPooledConnection(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  user, String sample code for java.lang.String definition code for java.lang.String  password)
          Attempts to establish a physical database connection that can be used as a pooled connection.
 void setLoginTimeout sample code for javax.sql.ConnectionPoolDataSource.setLoginTimeout(int) definition code for javax.sql.ConnectionPoolDataSource.setLoginTimeout(int) (int seconds)
          Sets the maximum time in seconds that this ConnectionPoolDataSource object will wait while attempting to connect to a database.
 void setLogWriter sample code for javax.sql.ConnectionPoolDataSource.setLogWriter(java.io.PrintWriter) definition code for javax.sql.ConnectionPoolDataSource.setLogWriter(java.io.PrintWriter) (PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter  out)
          Sets the log writer for this ConnectionPoolDataSource object to the given java.io.PrintWriter object.
 

Method Detail

getPooledConnection sample code for javax.sql.ConnectionPoolDataSource.getPooledConnection() definition code for javax.sql.ConnectionPoolDataSource.getPooledConnection()

PooledConnection sample code for javax.sql.PooledConnection definition code for javax.sql.PooledConnection  getPooledConnection()
                                     throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Attempts to establish a physical database connection that can be used as a pooled connection.

Returns:
a PooledConnection object that is a physical connection to the database that this ConnectionPoolDataSource object represents
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

getPooledConnection sample code for javax.sql.ConnectionPoolDataSource.getPooledConnection(java.lang.String, java.lang.String) definition code for javax.sql.ConnectionPoolDataSource.getPooledConnection(java.lang.String, java.lang.String)

PooledConnection sample code for javax.sql.PooledConnection definition code for javax.sql.PooledConnection  getPooledConnection(String sample code for java.lang.String definition code for java.lang.String  user,
                                     String sample code for java.lang.String definition code for java.lang.String  password)
                                     throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Attempts to establish a physical database connection that can be used as a pooled connection.

Parameters:
user - the database user on whose behalf the connection is being made
password - the user's password
Returns:
a PooledConnection object that is a physical connection to the database that this ConnectionPoolDataSource object represents
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

getLogWriter sample code for javax.sql.ConnectionPoolDataSource.getLogWriter() definition code for javax.sql.ConnectionPoolDataSource.getLogWriter()

PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter  getLogWriter()
                         throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves the log writer for this ConnectionPoolDataSource object.

The log writer is a character output stream to which all logging and tracing messages for this ConnectionPoolDataSource object are printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source- specific log writer are not printed to the log writer associated with the java.sql.DriverManager class. When a data source object is created, the log writer is initially null; in other words, the default is for logging to be disabled.

Returns:
the log writer for this ConnectionPoolDataSource object or null if logging is disabled
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
See Also:
setLogWriter(java.io.PrintWriter) sample code for javax.sql.ConnectionPoolDataSource.setLogWriter(java.io.PrintWriter) definition code for javax.sql.ConnectionPoolDataSource.setLogWriter(java.io.PrintWriter)

setLogWriter sample code for javax.sql.ConnectionPoolDataSource.setLogWriter(java.io.PrintWriter) definition code for javax.sql.ConnectionPoolDataSource.setLogWriter(java.io.PrintWriter)

void setLogWriter(PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter  out)
                  throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the log writer for this ConnectionPoolDataSource object to the given java.io.PrintWriter object.

The log writer is a character output stream to which all logging and tracing messages for this ConnectionPoolDataSource object are printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source- specific log writer are not printed to the log writer associated with the java.sql.Drivermanager class. When a data source object is created, the log writer is initially null; in other words, the default is for logging to be disabled.

Parameters:
out - the new log writer; null to disable logging
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
See Also:
getLogWriter() sample code for javax.sql.ConnectionPoolDataSource.getLogWriter() definition code for javax.sql.ConnectionPoolDataSource.getLogWriter()

setLoginTimeout sample code for javax.sql.ConnectionPoolDataSource.setLoginTimeout(int) definition code for javax.sql.ConnectionPoolDataSource.setLoginTimeout(int)

void setLoginTimeout(int seconds)
                     throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the maximum time in seconds that this ConnectionPoolDataSource object will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a ConnectionPoolDataSource object is created, the login timeout is initially zero.

Parameters:
seconds - the data source login time limit
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs.
See Also:
getLoginTimeout() sample code for javax.sql.ConnectionPoolDataSource.getLoginTimeout() definition code for javax.sql.ConnectionPoolDataSource.getLoginTimeout()

getLoginTimeout sample code for javax.sql.ConnectionPoolDataSource.getLoginTimeout() definition code for javax.sql.ConnectionPoolDataSource.getLoginTimeout()

int getLoginTimeout()
                    throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves the maximum time in seconds that this ConnectionPoolDataSource object will wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a DataSource object is created, its login timeout is initially zero.

Returns:
the data source login time limit
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs.
See Also:
setLoginTimeout(int) sample code for javax.sql.ConnectionPoolDataSource.setLoginTimeout(int) definition code for javax.sql.ConnectionPoolDataSource.setLoginTimeout(int)