OpenJDK 27 · javax.sql.DataSource · APIdia, the JavaDoc alternative

A factory for connections to the physical data source that this DataSource object represents. An alternative to the DriverManager facility, a DataSource object is the preferred means of getting a connection. An object that implements the DataSource interface will typically be registered with a naming service based on the Java Naming and Directory (JNDI) API.

The DataSource interface is implemented by a driver vendor. There are three types of implementations:

Basic implementation -- produces a standard Connection object
Connection pooling implementation -- produces a Connection object that will automatically participate in connection pooling. This implementation works with a middle-tier connection pooling manager.
Distributed transaction implementation -- produces a Connection object that may be used for distributed transactions and almost always participates in connection pooling. This implementation works with a middle-tier transaction manager and almost always with a connection pooling manager.

A DataSource object has properties that can be modified when necessary. For example, if the data source is moved to a different server, the property for the server can be changed. The benefit is that because the data source's properties can be changed, any code accessing that data source does not need to be changed.

A driver that is accessed via a DataSource object does not register itself with the DriverManager. Rather, a DataSource object is retrieved through a lookup operation and then used to create a Connection object. With a basic implementation, the connection obtained through a DataSource object is identical to a connection obtained through the DriverManager facility.

An implementation of DataSource must include a public no-arg constructor.

Method Summary

Modifier and Type	Method and Description
public default ConnectionBuilder	Returns: The ConnectionBuilder instance that was created createConnectionBuilder() Create a new `ConnectionBuilder` instance
public Connection	Returns: a connection to the data source getConnection() Attempts to establish a connection with the data source that this `DataSource` object represents.
public Connection	Returns: a connection to the data source getConnection(String the database user on whose behalf the connection is being made username, String the user's password password) Attempts to establish a connection with the data source that this `DataSource` object represents.
public int	getLoginTimeout() Redeclares javax.sql.CommonDataSource.getLoginTimeout. Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
public PrintWriter	getLogWriter() Redeclares javax.sql.CommonDataSource.getLogWriter. Retrieves the log writer for this `DataSource` object.
public void	setLoginTimeout(int seconds) Redeclares javax.sql.CommonDataSource.setLoginTimeout. Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
public void	setLogWriter(PrintWriter out) Redeclares javax.sql.CommonDataSource.setLogWriter. Sets the log writer for this `DataSource` object to the given `java.io.PrintWriter` object.

Inherited from java.sql.Wrapper:: isWrapperFor unwrap
Inherited from javax.sql.CommonDataSource:: createShardingKeyBuilder getParentLogger

Method Detail

createConnectionBuilder back to summary

createConnectionBuilder	back to summary
public default ConnectionBuilder createConnectionBuilder() throws SQLException Create a new `ConnectionBuilder` instance Implementation Specification The default implementation will throw a `SQLFeatureNotSupportedException` Returns:ConnectionBuilder The ConnectionBuilder instance that was created Exceptions SQLException: if an error occurs creating the builder SQLFeatureNotSupportedException: if the driver does not support sharding Since 9 See Also `ConnectionBuilder`

public default ConnectionBuilder createConnectionBuilder() throws SQLException

Create a new ConnectionBuilder instance

Implementation Specification

The default implementation will throw a SQLFeatureNotSupportedException

Returns:ConnectionBuilder

The ConnectionBuilder instance that was created

Exceptions

SQLException:: if an error occurs creating the builder
SQLFeatureNotSupportedException:: if the driver does not support sharding

Since

See Also

ConnectionBuilder

getConnection back to summary

getConnection	back to summary
public Connection getConnection() throws SQLException Attempts to establish a connection with the data source that this `DataSource` object represents. Returns:Connection a connection to the data source Exceptions SQLException: if a database access error occurs SQLTimeoutException: when the driver has determined that the timeout value specified by the `setLoginTimeout` method has been exceeded and has at least tried to cancel the current database connection attempt

public Connection getConnection() throws SQLException

Attempts to establish a connection with the data source that this DataSource object represents.

Returns:Connection

a connection to the data source

Exceptions

SQLException:: if a database access error occurs
SQLTimeoutException:: when the driver has determined that the timeout value specified by the setLoginTimeout method has been exceeded and has at least tried to cancel the current database connection attempt

getConnection back to summary

getConnection	back to summary
public Connection getConnection(String username, String password) throws SQLException Attempts to establish a connection with the data source that this `DataSource` object represents. Parameters username:String the database user on whose behalf the connection is being made password:String the user's password Returns:Connection a connection to the data source Exceptions SQLException: if a database access error occurs SQLTimeoutException: when the driver has determined that the timeout value specified by the `setLoginTimeout` method has been exceeded and has at least tried to cancel the current database connection attempt Since 1.4

public Connection getConnection(String username, String password) throws SQLException

Attempts to establish a connection with the data source that this DataSource object represents.

Parameters

username:String: the database user on whose behalf the connection is being made
password:String: the user's password

Returns:Connection

a connection to the data source

Exceptions

SQLException:: if a database access error occurs
SQLTimeoutException:: when the driver has determined that the timeout value specified by the setLoginTimeout method has been exceeded and has at least tried to cancel the current database connection attempt

Since

1.4

getLoginTimeout back to summary

getLoginTimeout	back to summary
public int getLoginTimeout() throws SQLException Redeclares javax.sql.CommonDataSource.getLoginTimeout. Doc from javax.sql.CommonDataSource.getLoginTimeout. 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 `DataSource` object is created, the login timeout is initially zero. Annotations @Override Exceptions SQLException: if a database access error occurs. Since 1.4

public int getLoginTimeout() throws SQLException

Redeclares javax.sql.CommonDataSource.getLoginTimeout.

Doc from javax.sql.CommonDataSource.getLoginTimeout.

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 DataSource object is created, the login timeout is initially zero.

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs.

Since

1.4

getLogWriter back to summary

getLogWriter	back to summary
public PrintWriter getLogWriter() throws SQLException Redeclares javax.sql.CommonDataSource.getLogWriter. Doc from javax.sql.CommonDataSource.getLogWriter. 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. Annotations @Override Exceptions SQLException: if a database access error occurs Since 1.4

public PrintWriter getLogWriter() throws SQLException

Redeclares javax.sql.CommonDataSource.getLogWriter.

Doc from javax.sql.CommonDataSource.getLogWriter.

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.

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

Since

1.4

setLoginTimeout back to summary

setLoginTimeout	back to summary
public void setLoginTimeout(int seconds) throws SQLException Redeclares javax.sql.CommonDataSource.setLoginTimeout. Doc from javax.sql.CommonDataSource.setLoginTimeout. 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. Annotations @Override Exceptions SQLException: if a database access error occurs. Since 1.4

public void setLoginTimeout(int seconds) throws SQLException

Redeclares javax.sql.CommonDataSource.setLoginTimeout.

Doc from javax.sql.CommonDataSource.setLoginTimeout.

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.

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs.

Since

1.4

setLogWriter back to summary

setLogWriter	back to summary
public void setLogWriter(PrintWriter out) throws SQLException Redeclares javax.sql.CommonDataSource.setLogWriter. Doc from javax.sql.CommonDataSource.setLogWriter. 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. Annotations @Override Exceptions SQLException: if a database access error occurs Since 1.4

public void setLogWriter(PrintWriter out) throws SQLException

Redeclares javax.sql.CommonDataSource.setLogWriter.

Doc from javax.sql.CommonDataSource.setLogWriter.

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.

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

Since

1.4

public Interface DataSource

Method Summary

Method Detail