FileDocCategorySizeDatePackage
ConnectionPoolDataSource.javaAPI DocJava SE 5 API4933Fri Aug 26 14:57:50 BST 2005javax.sql

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

Fields Summary
Constructors Summary
Methods Summary
public java.io.PrintWritergetLogWriter()
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.

return
the log writer for this ConnectionPoolDataSource object or null if logging is disabled
exception
SQLException if a database access error occurs
see
#setLogWriter

public intgetLoginTimeout()
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.

return
the data source login time limit
exception
SQLException if a database access error occurs.
see
#setLoginTimeout

public javax.sql.PooledConnectiongetPooledConnection()
Attempts to establish a physical database connection that can be used as a pooled connection.

return
a PooledConnection object that is a physical connection to the database that this ConnectionPoolDataSource object represents
exception
SQLException if a database access error occurs

public javax.sql.PooledConnectiongetPooledConnection(java.lang.String user, java.lang.String password)
Attempts to establish a physical database connection that can be used as a pooled connection.

param
user the database user on whose behalf the connection is being made
param
password the user's password
return
a PooledConnection object that is a physical connection to the database that this ConnectionPoolDataSource object represents
exception
SQLException if a database access error occurs

public voidsetLogWriter(java.io.PrintWriter out)
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.

param
out the new log writer; null to disable logging
exception
SQLException if a database access error occurs
see
#getLogWriter

public voidsetLoginTimeout(int seconds)
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.

param
seconds the data source login time limit
exception
SQLException if a database access error occurs.
see
#getLoginTimeout