Class jdbcDataSource
- All Implemented Interfaces:
Serializable
,Wrapper
,Referenceable
,CommonDataSource
,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:
- 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 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:
- JDK 1.4
- Author:
- deforest@users
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAttempts to establish a connection with the data source that thisDataSource
object represents.getConnection
(String username, String password) Attempts to establish a connection with the data source that thisDataSource
object represents.Retrieves the jdbc database connection url attribute.int
Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.Retrieves the log writer for thisDataSource
object.getUser()
Retrieves the user ID for the connection.boolean
isWrapperFor
(Class<?> iface) void
setDatabase
(String database) Assigns the value of this object's jdbc database connection url attribute.void
setLoginTimeout
(int seconds) Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.void
setLogWriter
(PrintWriter logWriter) Sets the log writer for thisDataSource
object to the givenjava.io.PrintWriter
object.void
setPassword
(String password) Sets the password to use for connecting to the databasevoid
Sets the userid<T> T
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.sql.CommonDataSource
createShardingKeyBuilder
Methods inherited from interface javax.sql.DataSource
createConnectionBuilder
-
Constructor Details
-
jdbcDataSource
public jdbcDataSource()Constructor
-
-
Method Details
-
getConnection
Attempts to establish a connection with the data source that this
DataSource
object represents.- Specified by:
getConnection
in interfaceDataSource
- Returns:
- a connection to the data source
- Throws:
SQLException
- if a database access error occurs
-
getConnection
Attempts to establish a connection with the data source that this
DataSource
object represents.- Specified by:
getConnection
in interfaceDataSource
- Parameters:
username
- the database user on whose behalf the connection is being madepassword
- the user's password- Returns:
- a connection to the data source
- Throws:
SQLException
- if a database access error occurs
-
getDatabase
Retrieves the jdbc database connection url attribute.- Returns:
- the jdbc database connection url attribute
-
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 aDataSource
object is created, the login timeout is initially zero.- Specified by:
getLoginTimeout
in interfaceCommonDataSource
- Specified by:
getLoginTimeout
in interfaceDataSource
- Returns:
- the data source login time limit
- Throws:
SQLException
- if a database access error occurs.- See Also:
-
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 aDataSource
object is created, the log writer is initially null; in other words, the default is for logging to be disabled.- Specified by:
getLogWriter
in interfaceCommonDataSource
- Specified by:
getLogWriter
in interfaceDataSource
- Returns:
- the log writer for this data source or null if logging is disabled
- Throws:
SQLException
- if a database access error occurs- See Also:
-
getReference
- Specified by:
getReference
in interfaceReferenceable
- Throws:
NamingException
-
getUser
Retrieves the user ID for the connection.- Returns:
- the user ID for the connection
-
setDatabase
Assigns the value of this object's jdbc database connection url attribute.- Parameters:
database
- the new value of this object's jdbc database connection url attribute
-
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.- Specified by:
setLoginTimeout
in interfaceCommonDataSource
- Specified by:
setLoginTimeout
in interfaceDataSource
- Parameters:
seconds
- the data source login time limit- Throws:
SQLException
- if a database access error occurs.- See Also:
-
setLogWriter
Sets the log writer for this
DataSource
object to the givenjava.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 aDataSource
object is created the log writer is initially null; in other words, the default is for logging to be disabled.- Specified by:
setLogWriter
in interfaceCommonDataSource
- Specified by:
setLogWriter
in interfaceDataSource
- Parameters:
logWriter
- the new log writer; to disable logging, set to null- Throws:
SQLException
- if a database access error occurs- See Also:
-
setPassword
Sets the password to use for connecting to the database- Parameters:
password
- the password
-
setUser
Sets the userid- Parameters:
user
- the user id
-
unwrap
- Specified by:
unwrap
in interfaceWrapper
- Throws:
SQLException
-
isWrapperFor
- Specified by:
isWrapperFor
in interfaceWrapper
- Throws:
SQLException
-
getParentLogger
- Specified by:
getParentLogger
in interfaceCommonDataSource
- Throws:
SQLFeatureNotSupportedException
-