Interface DataSource
-
- All Superinterfaces:
- CommonDataSource, Wrapper
public interface DataSource extends CommonDataSource, Wrapper
A factory for connections to the physical data source that this
DataSourceobject represents. An alternative to theDriverManagerfacility, aDataSourceobject is the preferred means of getting a connection. An object that implements theDataSourceinterface will typically be registered with a naming service based on the Java™ Naming and Directory (JNDI) API.The
DataSourceinterface is implemented by a driver vendor. There are three types of implementations:- Basic implementation -- produces a standard
Connectionobject - Connection pooling implementation -- produces a
Connectionobject that will automatically participate in connection pooling. This implementation works with a middle-tier connection pooling manager. - Distributed transaction implementation -- produces a
Connectionobject 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
DataSourceobject 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
DataSourceobject does not register itself with theDriverManager. Rather, aDataSourceobject is retrieved though a lookup operation and then used to create aConnectionobject. With a basic implementation, the connection obtained through aDataSourceobject is identical to a connection obtained through theDriverManagerfacility.An implementation of
DataSourcemust include a public no-arg constructor.- Since:
- 1.4
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description ConnectiongetConnection()Attempts to establish a connection with the data source that thisDataSourceobject represents.ConnectiongetConnection(String username, String password)Attempts to establish a connection with the data source that thisDataSourceobject represents.-
Methods inherited from interface javax.sql.CommonDataSource
getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter
-
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
-
-
-
-
Method Detail
getConnection
Connection getConnection() throws SQLException
Attempts to establish a connection with the data source that this
DataSourceobject represents.- Returns:
- a connection to the data source
- Throws:
-
SQLException- if a database access error occurs -
SQLTimeoutException- when the driver has determined that the timeout value specified by thesetLoginTimeoutmethod has been exceeded and has at least tried to cancel the current database connection attempt
getConnection
Connection getConnection(String username, String password) throws SQLException
Attempts to establish a connection with the data source that this
DataSourceobject represents.- Parameters:
-
username- the database user on whose behalf the connection is being made -
password- the user's password - Returns:
- a connection to the data source
- Throws:
-
SQLException- if a database access error occurs -
SQLTimeoutException- when the driver has determined that the timeout value specified by thesetLoginTimeoutmethod has been exceeded and has at least tried to cancel the current database connection attempt - Since:
- 1.4
-
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, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
