|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hsqldb.jdbc.JDBCDataSource
public class JDBCDataSource
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:
Connection
object
Connection
object that will automatically participate in connection pooling. This
implementation works with a middle-tier connection pooling manager.
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.
Constructor Summary | |
---|---|
JDBCDataSource()
Constructor |
Method Summary | ||
---|---|---|
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. |
|
int |
getLoginTimeout()
Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. |
|
PrintWriter |
getLogWriter()
Retrieves the log writer for this DataSource
object. |
|
Reference |
getReference()
|
|
String |
getUser()
Retrieves the user ID for the connection. |
|
boolean |
isWrapperFor(Class<?> iface)
Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. |
|
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 this DataSource
object to the given java.io.PrintWriter object. |
|
void |
setPassword(String password)
Sets the password to use for connecting to the database |
|
void |
setUser(String user)
Sets the userid |
|
|
unwrap(Class<T> iface)
Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JDBCDataSource()
Method Detail |
---|
public Connection getConnection() throws SQLException
Attempts to establish a connection with the data source that
this DataSource
object represents.
getConnection
in interface DataSource
SQLException
- if a database access error occurspublic Connection getConnection(String username, String password) throws SQLException
Attempts to establish a connection with the data source that
this DataSource
object represents.
getConnection
in interface DataSource
username
- the database user on whose behalf the connection is
being madepassword
- the user's password
SQLException
- if a database access error occurspublic <T> T unwrap(Class<T> iface) throws SQLException
unwrap
recursively on the wrapped object
or a proxy for that result. If the receiver is not a
wrapper and does not implement the interface, then an SQLException
is thrown.
unwrap
in interface Wrapper
iface
- A Class defining an interface that the result must implement.
SQLException
- If no object found that implements the interfacepublic boolean isWrapperFor(Class<?> iface) throws SQLException
isWrapperFor
on the wrapped
object. If this does not implement the interface and is not a wrapper, return false.
This method should be implemented as a low-cost operation compared to unwrap
so that
callers can use this method to avoid expensive unwrap
calls that may fail. If this method
returns true then calling unwrap
with the same argument should succeed.
isWrapperFor
in interface Wrapper
iface
- a Class defining an interface.
SQLException
- if an error occurs while determining whether this is a wrapper
for an object with the given interface.public String getDatabase()
public int getLoginTimeout() throws SQLException
DataSource
object is created, the login timeout is
initially zero.
getLoginTimeout
in interface CommonDataSource
SQLException
- if a database access error occurs.setLoginTimeout(int)
,
setLoginTimeout(int)
public 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.
getLogWriter
in interface CommonDataSource
SQLException
- if a database access error occurssetLogWriter(java.io.PrintWriter)
public Reference getReference() throws NamingException
getReference
in interface Referenceable
NamingException
public String getUser()
public void setDatabase(String database)
database
- the new value of this object's jdbc database connection
url attributepublic 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.
setLoginTimeout
in interface CommonDataSource
seconds
- the data source login time limit
SQLException
- if a database access error occurs.getLoginTimeout()
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.
setLogWriter
in interface CommonDataSource
logWriter
- the new log writer; to disable logging, set to null
SQLException
- if a database access error occursgetLogWriter()
public void setPassword(String password)
password
- the passwordpublic void setUser(String user)
user
- the user id
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |