ConnectionPoolDataSource
, DataSource
, XADataSource
public interface CommonDataSource
DataSource
, XADataSource
and ConnectionPoolDataSource
.Modifier and Type | Method | Description |
---|---|---|
default ShardingKeyBuilder |
createShardingKeyBuilder() |
Creates a new ShardingKeyBuilder 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. |
Logger |
getParentLogger() |
Return the parent Logger of all the Loggers used by this data source. |
void |
setLoginTimeout |
Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. |
void |
setLogWriter |
Sets the log writer for this DataSource object to the given java.io.PrintWriter object. |
PrintWriter 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.
SQLException
- if a database access error occursvoid 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.
out
- the new log writer; to disable logging, set to nullSQLException
- if a database access error occursvoid 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.
seconds
- the data source login time limitSQLException
- if a database access error occurs.int getLoginTimeout() throws SQLException
DataSource
object is created, the login timeout is initially zero.SQLException
- if a database access error occurs.Logger getParentLogger() throws SQLFeatureNotSupportedException
SQLFeatureNotSupportedException
- if the data source does not use java.util.logging
default ShardingKeyBuilder createShardingKeyBuilder() throws SQLException
ShardingKeyBuilder
instanceSQLFeatureNotSupportedException
.SQLException
- if an error occurs creating the builderSQLFeatureNotSupportedException
- if the driver does not support this method
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/javax/sql/CommonDataSource.html