Java 2 Platform EE v1.3: Interface ConnectionPoolDataSource - Java Platform, Enterprise Edition v1.3.1 API Specifications
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
javax.sql
Interface ConnectionPoolDataSource
- public interface ConnectionPoolDataSource
A ConnectionPoolDataSource object is a factory for PooledConnection objects. An object that implements this interface will typically be registered with a JNDI service.
| Method Summary | |
int |
getLoginTimeout()
Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. |
java.io.PrintWriter |
getLogWriter()
Get the log writer for this data source. |
PooledConnection |
getPooledConnection()
Attempt to establish a database connection. |
PooledConnection |
getPooledConnection(java.lang.String user,
java.lang.String password)
Attempt to establish a database connection. |
void |
setLoginTimeout(int seconds)
Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. |
void |
setLogWriter(java.io.PrintWriter out)
Set the log writer for this data source. |
| Method Detail |
getPooledConnection
public PooledConnection getPooledConnection() throws java.sql.SQLException
Attempt to establish a database connection.
- Returns:
- a Connection to the database
- Throws:
java.sql.SQLException- if a database-access error occurs.
getPooledConnection
public PooledConnection getPooledConnection(java.lang.String user, java.lang.String password) throws java.sql.SQLException
Attempt to establish a database connection.
- Parameters:
user- the database user on whose behalf the Connection is being madepassword- the user's password- Returns:
- a Connection to the database
- Throws:
java.sql.SQLException- if a database-access error occurs.
getLogWriter
public java.io.PrintWriter getLogWriter()
throws java.sql.SQLException
Get the log writer for this data source.
The log writer is a character output stream to which all logging and tracing messages for this data source object instance will be 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, logging is disabled.
- Returns:
- the log writer for this data source, null if disabled
- Throws:
java.sql.SQLException- if a database-access error occurs.
setLogWriter
public void setLogWriter(java.io.PrintWriter out)
throws java.sql.SQLException
Set the log writer for this data source.
The log writer is a character output stream to which all logging and tracing messages for this data source object instance will be 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, logging is disabled.
- Parameters:
out- the new log writer; to disable, set to null- Throws:
java.sql.SQLException- if a database-access error occurs.
setLoginTimeout
public void setLoginTimeout(int seconds)
throws java.sql.SQLException
Sets the maximum time in seconds that this data source 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 data source object is created the login timeout is initially zero.
- Parameters:
seconds- the data source login time limit- Throws:
java.sql.SQLException- if a database access error occurs.
getLoginTimeout
public int getLoginTimeout()
throws java.sql.SQLException
- Gets the maximum time in seconds that this data source can 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 data source object is created the login timeout is
initially zero.
- Returns:
- the data source login time limit
- Throws:
java.sql.SQLException- if a database access error occurs.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||