CommonDataSource
public interface ConnectionPoolDataSource extends CommonDataSource
PooledConnection
objects. An object that implements this interface will typically be
registered with a naming service that is based on the
Java™ Naming and Directory Interface
(JNDI).Modifier and Type | Method | Description |
---|---|---|
default PooledConnectionBuilder |
createPooledConnectionBuilder() |
Creates a new
PooledConnectionBuilder instance |
int |
getLoginTimeout() |
Gets the maximum time in seconds that this data source can wait
while attempting to connect to a database.
|
PrintWriter |
getLogWriter() |
Retrieves the log writer for this
DataSource
object. |
PooledConnection |
getPooledConnection() |
Attempts to establish a physical database connection that can
be used as a pooled connection.
|
PooledConnection |
getPooledConnection(String user,
String password) |
Attempts to establish a physical database connection that can
be used as a pooled 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(PrintWriter out) |
Sets the log writer for this
DataSource
object to the given java.io.PrintWriter object. |
createShardingKeyBuilder, getParentLogger
PooledConnection getPooledConnection() throws SQLException
PooledConnection
object that is a physical
connection to the database that this
ConnectionPoolDataSource
object representsSQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodPooledConnection getPooledConnection(String user, String password) throws SQLException
user
- the database user on whose behalf the connection is being madepassword
- the user's passwordPooledConnection
object that is a physical
connection to the database that this
ConnectionPoolDataSource
object representsSQLException
- if a database access error occursSQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodPrintWriter getLogWriter() throws SQLException
Retrieves the log writer for this DataSource
object.
The log writer is a character output stream to which all logging
and tracing messages for this data source 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
DataSource
object is
created, the log writer is initially null; in other words, the
default is for logging to be disabled.
getLogWriter
in interface CommonDataSource
SQLException
- if a database access error occursCommonDataSource.setLogWriter(java.io.PrintWriter)
void setLogWriter(PrintWriter out) throws SQLException
Sets the log writer for this DataSource
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 data source 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
DataSource
object is created the log writer is
initially null; in other words, the default is for logging to be
disabled.
setLogWriter
in interface CommonDataSource
out
- the new log writer; to disable logging, set to nullSQLException
- if a database access error occursCommonDataSource.getLogWriter()
void setLoginTimeout(int seconds) throws 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 DataSource
object is created, the login timeout is
initially zero.
setLoginTimeout
in interface CommonDataSource
seconds
- the data source login time limitSQLException
- if a database access error occurs.CommonDataSource.getLoginTimeout()
int getLoginTimeout() throws SQLException
DataSource
object is created, the login timeout is
initially zero.getLoginTimeout
in interface CommonDataSource
SQLException
- if a database access error occurs.CommonDataSource.setLoginTimeout(int)
default PooledConnectionBuilder createPooledConnectionBuilder() throws SQLException
PooledConnectionBuilder
instanceSQLFeatureNotSupportedException
.SQLException
- if an error occurs creating the builderSQLFeatureNotSupportedException
- if the driver does not support shardingPooledConnectionBuilder
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps