FileDocCategorySizeDatePackage
ConnectionPoolDataSource.javaAPI DocAndroid 1.5 API5732Wed May 06 22:41:06 BST 2009javax.sql

ConnectionPoolDataSource

public interface ConnectionPoolDataSource
An interface for the creation of {@code ConnectionPoolDataSource} objects. Used internally within the package.

A class which implements the {@code ConnectionPoolDataSource} interface is typically registered with a JNDI naming service directory and is retrieved from there by name.

since
Android 1.0

Fields Summary
Constructors Summary
Methods Summary
public java.io.PrintWritergetLogWriter()
Gets the log writer for this {@code ConnectionPoolDataSource}.

The log writer is a stream to which all log and trace messages are sent from this {@code ConnectionPoolDataSource}. The log writer can be {@code null}, in which case the log and trace capture is disabled. The default value for the log writer when an {@code ConnectionPoolDataSource} is created is {@code null}. Note that the log writer for an {@code ConnectionPoolDataSource} is not the same as the log writer used by a {@code DriverManager}.

return
a {@code PrintWriter} which is the log writer for this {@code ConnectionPoolDataSource}. Can be {@code null}, in which case log writing is disabled for this {@code ConnectionPoolDataSource}.
throws
SQLException if there is a problem accessing the database.
since
Android 1.0

public intgetLoginTimeout()
Gets the login timeout value for this {@code ConnectionPoolDataSource}. The login timeout is the maximum time in seconds that the {@code ConnectionPoolDataSource} will wait when opening a connection to a database. A timeout value of 0 implies either the system default timeout value (if there is one) or that there is no timeout. The default value for the login timeout is {@code 0}.

return
the login timeout value in seconds.
throws
SQLException if there is a problem accessing the database.
since
Android 1.0

public javax.sql.PooledConnectiongetPooledConnection()
Creates a connection to a database which can then be used as a pooled connection.

return
a {@code PooledConnection} which represents the connection to the database.
throws
SQLException if there is a problem accessing the database.
since
Android 1.0

public javax.sql.PooledConnectiongetPooledConnection(java.lang.String theUser, java.lang.String thePassword)
Creates a connection to a database, using the supplied user name and password, which can then be used as a pooled connection.

param
theUser the a user name for the database login.
param
thePassword the password associated with the user identified by {@code theUser}.
return
a {@code PooledConnection} object which represents the connection to the database.
throws
SQLException if there is a problem accessing the database.
since
Android 1.0

public voidsetLogWriter(java.io.PrintWriter theWriter)
Sets the log writer for this {@code ConnectionPoolDataSource}.

The log writer is a stream to which all log and trace messages are sent from this {@code ConnectionPoolDataSource}. The log writer can be {@code null}, in which case log and trace capture is disabled. The default value for the log writer, when a {@code ConnectionPoolDataSource} is created, is {@code null}. Note that the log writer for a {@code ConnectionPoolDataSource} is not the same as the log writer used by a {@code DriverManager}.

param
theWriter is the log writer for this {@code ConnectionPoolDataSource}.
throws
SQLException if there is a problem accessing the database.
since
Android 1.0

public voidsetLoginTimeout(int theTimeout)
Sets the login timeout value for this {@code ConnectionPoolDataSource}. The login timeout is the maximum time in seconds that the {@code ConnectionPoolDataSource} will wait when opening a connection to a database. A timeout value of 0 implies either the system default timeout value (if there is one) or that there is no timeout. The default value for the login timeout is 0.

param
theTimeout the new login timeout value in seconds.
throws
SQLException if there is a problem accessing the database.
since
Android 1.0