- 
- 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 through 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 SummaryAll Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ConnectionBuildercreateConnectionBuilder()Create a newConnectionBuilderinstanceConnectiongetConnection()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.intgetLoginTimeout()Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.PrintWritergetLogWriter()Retrieves the log writer for thisDataSourceobject.voidsetLoginTimeout(int seconds)Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.voidsetLogWriter(PrintWriter out)Sets the log writer for thisDataSourceobject to the givenjava.io.PrintWriterobject.- 
Methods declared in interface javax.sql.CommonDataSourcecreateShardingKeyBuilder, getParentLogger
 - 
Methods declared in interface java.sql.WrapperisWrapperFor, unwrap
 
- 
 
- 
- 
- 
Method Detail- 
getConnectionConnection 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 the- setLoginTimeoutmethod has been exceeded and has at least tried to cancel the current database connection attempt
 
 - 
getConnectionConnection 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 the- setLoginTimeoutmethod has been exceeded and has at least tried to cancel the current database connection attempt
- Since:
- 1.4
 
 - 
getLogWriterPrintWriter getLogWriter() throws SQLException Retrieves the log writer for this DataSourceobject.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.DriverManagerclass. When aDataSourceobject is created, the log writer is initially null; in other words, the default is for logging to be disabled.- Specified by:
- getLogWriterin interface- CommonDataSource
- Returns:
- the log writer for this data source or null if logging is disabled
- Throws:
- SQLException- if a database access error occurs
- Since:
- 1.4
- See Also:
- CommonDataSource.setLogWriter(java.io.PrintWriter)
 
 - 
setLogWritervoid setLogWriter(PrintWriter out) throws SQLException Sets the log writer for this DataSourceobject to the givenjava.io.PrintWriterobject.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.DriverManagerclass. When aDataSourceobject is created the log writer is initially null; in other words, the default is for logging to be disabled.- Specified by:
- setLogWriterin interface- CommonDataSource
- Parameters:
- out- the new log writer; to disable logging, set to null
- Throws:
- SQLException- if a database access error occurs
- Since:
- 1.4
- See Also:
- CommonDataSource.getLogWriter()
 
 - 
setLoginTimeoutvoid setLoginTimeout(int seconds) throws SQLExceptionSets 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 DataSourceobject is created, the login timeout is initially zero.- Specified by:
- setLoginTimeoutin interface- CommonDataSource
- Parameters:
- seconds- the data source login time limit
- Throws:
- SQLException- if a database access error occurs.
- Since:
- 1.4
- See Also:
- CommonDataSource.getLoginTimeout()
 
 - 
getLoginTimeoutint getLoginTimeout() throws SQLExceptionGets 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 aDataSourceobject is created, the login timeout is initially zero.- Specified by:
- getLoginTimeoutin interface- CommonDataSource
- Returns:
- the data source login time limit
- Throws:
- SQLException- if a database access error occurs.
- Since:
- 1.4
- See Also:
- CommonDataSource.setLoginTimeout(int)
 
 - 
createConnectionBuilderdefault ConnectionBuilder createConnectionBuilder() throws SQLException Create a newConnectionBuilderinstance- Implementation Requirements:
- The default implementation will throw a SQLFeatureNotSupportedException
- Returns:
- The ConnectionBuilder instance that was created
- Throws:
- SQLException- if an error occurs creating the builder
- SQLFeatureNotSupportedException- if the driver does not support sharding
- Since:
- 9
- See Also:
- ConnectionBuilder
 
 
- 
 
-