org.hsqldb.jdbc
Class jdbcDataSource
java.lang.Object
org.hsqldb.jdbc.jdbcDataSource
- DataSource, Referenceable, Serializable
public class jdbcDataSource
extends java.lang.Object
implements Serializable, Referenceable, 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
Java
TM 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.
Connection | getConnection() - Attempts to establish a connection with the data source that
this
DataSource object represents.
|
Connection | getConnection(String username, String password) - Attempts to establish a connection with the data source that
this
DataSource object represents.
|
String | getDatabase() - Retrieves the jdbc database connection url attribute.
|
java.io.PrintWriter | getLogWriter() - Retrieves the log writer for this
DataSource
object.
|
int | getLoginTimeout() - Gets the maximum time in seconds that this data source can wait
while attempting to connect to a database.
|
Reference | getReference()
|
String | getUser() - Retrieves the user ID for the connection.
|
void | setDatabase(String database) - Assigns the value of this object's jdbc database connection
url attribute.
|
void | setLogWriter(PrintWriter logWriter) - Sets the log writer for this
DataSource
object to the given java.io.PrintWriter object.
|
void | setLoginTimeout(int seconds) - Sets the maximum time in seconds that this data source will wait
while attempting to connect to a database.
|
void | setPassword(String password) - Sets the password to use for connecting to the database
|
void | setUser(String user) - Sets the userid
|
jdbcDataSource
public jdbcDataSource()
Constructor
getConnection
public Connection getConnection()
throws SQLException
Attempts to establish a connection with the data source that
this DataSource
object represents.
- a connection to the data source
getConnection
public Connection getConnection(String username,
String password)
throws SQLException
Attempts to establish a connection with the data source that
this DataSource
object represents.
username
- the database user on whose behalf the connection is
being madepassword
- the user's password
- a connection to the data source
getDatabase
public String getDatabase()
Retrieves the jdbc database connection url attribute.
- the jdbc database connection url attribute
getLogWriter
public java.io.PrintWriter getLogWriter()
throws 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.
- the log writer for this data source or null if
logging is disabled
getLoginTimeout
public int getLoginTimeout()
throws 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.
- the data source login time limit
getReference
public Reference getReference()
throws NamingException
getUser
public String getUser()
Retrieves the user ID for the connection.
- the user ID for the connection
setDatabase
public void setDatabase(String database)
Assigns the value of this object's jdbc database connection
url attribute.
database
- the new value of this object's jdbc database connection
url attribute
setLogWriter
public void setLogWriter(PrintWriter logWriter)
throws 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.
logWriter
- the new log writer; to disable logging, set to null
setLoginTimeout
public void setLoginTimeout(int seconds)
throws 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.
seconds
- the data source login time limit
setPassword
public void setPassword(String password)
Sets the password to use for connecting to the database
setUser
public void setUser(String user)
Sets the userid
Copyright B) 2001 - 2005 HSQL Development Group. All Rights Reserved.