javax.sql
Interface DataSource


public interface DataSource

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 JavaTM Naming and Directory (JNDI) API.

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

  1. Basic implementation -- produces a standard Connection object
  2. Connection pooling implementation -- produces a Connection object that will automatically participate in connection pooling. This implementation works with a middle-tier connection pooling manager.
  3. 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 though 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.

Since:
1.4

Method Summary
 Connection sample code for java.sql.Connection definition code for java.sql.Connection getConnection sample code for javax.sql.DataSource.getConnection() definition code for javax.sql.DataSource.getConnection() ()
          Attempts to establish a connection with the data source that this DataSource object represents.
 Connection sample code for java.sql.Connection definition code for java.sql.Connection getConnection sample code for javax.sql.DataSource.getConnection(java.lang.String, java.lang.String) definition code for javax.sql.DataSource.getConnection(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  username, String sample code for java.lang.String definition code for java.lang.String  password)
          Attempts to establish a connection with the data source that this DataSource object represents.
 int getLoginTimeout sample code for javax.sql.DataSource.getLoginTimeout() definition code for javax.sql.DataSource.getLoginTimeout() ()
          Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
 PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter getLogWriter sample code for javax.sql.DataSource.getLogWriter() definition code for javax.sql.DataSource.getLogWriter() ()
          Retrieves the log writer for this DataSource object.
 void setLoginTimeout sample code for javax.sql.DataSource.setLoginTimeout(int) definition code for javax.sql.DataSource.setLoginTimeout(int) (int seconds)
          Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
 void setLogWriter sample code for javax.sql.DataSource.setLogWriter(java.io.PrintWriter) definition code for javax.sql.DataSource.setLogWriter(java.io.PrintWriter) (PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter  out)
          Sets the log writer for this DataSource object to the given java.io.PrintWriter object.
 

Method Detail

getConnection sample code for javax.sql.DataSource.getConnection() definition code for javax.sql.DataSource.getConnection()

Connection sample code for java.sql.Connection definition code for java.sql.Connection  getConnection()
                         throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 

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

Returns:
a connection to the data source
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

getConnection sample code for javax.sql.DataSource.getConnection(java.lang.String, java.lang.String) definition code for javax.sql.DataSource.getConnection(java.lang.String, java.lang.String)

Connection sample code for java.sql.Connection definition code for java.sql.Connection  getConnection(String sample code for java.lang.String definition code for java.lang.String  username,
                         String sample code for java.lang.String definition code for java.lang.String  password)
                         throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 

Attempts to establish a connection with the data source that this DataSource object 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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

getLogWriter sample code for javax.sql.DataSource.getLogWriter() definition code for javax.sql.DataSource.getLogWriter()

PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter  getLogWriter()
                         throws SQLException sample code for java.sql.SQLException definition code for java.sql.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.

Returns:
the log writer for this data source or null if logging is disabled
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
See Also:
setLogWriter(java.io.PrintWriter) sample code for javax.sql.DataSource.setLogWriter(java.io.PrintWriter) definition code for javax.sql.DataSource.setLogWriter(java.io.PrintWriter)

setLogWriter sample code for javax.sql.DataSource.setLogWriter(java.io.PrintWriter) definition code for javax.sql.DataSource.setLogWriter(java.io.PrintWriter)

void setLogWriter(PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter  out)
                  throws SQLException sample code for java.sql.SQLException definition code for java.sql.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.

Parameters:
out - the new log writer; to disable logging, set to null
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
See Also:
getLogWriter() sample code for javax.sql.DataSource.getLogWriter() definition code for javax.sql.DataSource.getLogWriter()

setLoginTimeout sample code for javax.sql.DataSource.setLoginTimeout(int) definition code for javax.sql.DataSource.setLoginTimeout(int)

void setLoginTimeout(int seconds)
                     throws SQLException sample code for java.sql.SQLException definition code for java.sql.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.

Parameters:
seconds - the data source login time limit
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs.
See Also:
getLoginTimeout() sample code for javax.sql.DataSource.getLoginTimeout() definition code for javax.sql.DataSource.getLoginTimeout()

getLoginTimeout sample code for javax.sql.DataSource.getLoginTimeout() definition code for javax.sql.DataSource.getLoginTimeout()

int getLoginTimeout()
                    throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
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.

Returns:
the data source login time limit
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs.
See Also:
setLoginTimeout(int) sample code for javax.sql.DataSource.setLoginTimeout(int) definition code for javax.sql.DataSource.setLoginTimeout(int)