Class jdbcDataSource
- java.lang.Object
-
- org.hsqldb.jdbc.jdbcDataSource
-
- All Implemented Interfaces:
java.io.Serializable
,java.sql.Wrapper
,javax.naming.Referenceable
,javax.sql.CommonDataSource
,javax.sql.DataSource
public class jdbcDataSource extends java.lang.Object implements java.io.Serializable, javax.naming.Referenceable, javax.sql.DataSource
A factory for connections to the physical data source that this
DataSource
object represents. An alternative to theDriverManager
facility, aDataSource
object is the preferred means of getting a connection. An object that implements theDataSource
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 theDriverManager
. Rather, aDataSource
object is retrieved though a lookup operation and then used to create aConnection
object. With a basic implementation, the connection obtained through aDataSource
object is identical to a connection obtained through theDriverManager
facility.- Since:
- JDK 1.4
- Author:
- deforest@users
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description jdbcDataSource()
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.sql.Connection
getConnection()
Attempts to establish a connection with the data source that thisDataSource
object represents.java.sql.Connection
getConnection(java.lang.String username, java.lang.String password)
Attempts to establish a connection with the data source that thisDataSource
object represents.java.lang.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.java.io.PrintWriter
getLogWriter()
Retrieves the log writer for thisDataSource
object.java.util.logging.Logger
getParentLogger()
javax.naming.Reference
getReference()
java.lang.String
getUser()
Retrieves the user ID for the connection.boolean
isWrapperFor(java.lang.Class<?> iface)
void
setDatabase(java.lang.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(java.io.PrintWriter logWriter)
Sets the log writer for thisDataSource
object to the givenjava.io.PrintWriter
object.void
setPassword(java.lang.String password)
Sets the password to use for connecting to the databasevoid
setUser(java.lang.String user)
Sets the userid<T> T
unwrap(java.lang.Class<T> iface)
-
-
-
Method Detail
-
getConnection
public java.sql.Connection getConnection() throws java.sql.SQLException
Attempts to establish a connection with the data source that this
DataSource
object represents.- Specified by:
getConnection
in interfacejavax.sql.DataSource
- Returns:
- a connection to the data source
- Throws:
java.sql.SQLException
- if a database access error occurs
-
getConnection
public java.sql.Connection getConnection(java.lang.String username, java.lang.String password) throws java.sql.SQLException
Attempts to establish a connection with the data source that this
DataSource
object represents.- Specified by:
getConnection
in interfacejavax.sql.DataSource
- 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:
java.sql.SQLException
- if a database access error occurs
-
getDatabase
public java.lang.String getDatabase()
Retrieves the jdbc database connection url attribute.- Returns:
- the jdbc database connection url attribute
-
getLoginTimeout
public int getLoginTimeout() throws 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 aDataSource
object is created, the login timeout is initially zero.- Specified by:
getLoginTimeout
in interfacejavax.sql.CommonDataSource
- Specified by:
getLoginTimeout
in interfacejavax.sql.DataSource
- Returns:
- the data source login time limit
- Throws:
java.sql.SQLException
- if a database access error occurs.- See Also:
setLoginTimeout(int)
-
getLogWriter
public java.io.PrintWriter getLogWriter() throws 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 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 interfacejavax.sql.CommonDataSource
- Specified by:
getLogWriter
in interfacejavax.sql.DataSource
- Returns:
- the log writer for this data source or null if logging is disabled
- Throws:
java.sql.SQLException
- if a database access error occurs- See Also:
setLogWriter(java.io.PrintWriter)
-
getReference
public javax.naming.Reference getReference() throws javax.naming.NamingException
- Specified by:
getReference
in interfacejavax.naming.Referenceable
- Throws:
javax.naming.NamingException
-
getUser
public java.lang.String getUser()
Retrieves the user ID for the connection.- Returns:
- the user ID for the connection
-
setDatabase
public void setDatabase(java.lang.String database)
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
public void setLoginTimeout(int seconds) throws 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.- Specified by:
setLoginTimeout
in interfacejavax.sql.CommonDataSource
- Specified by:
setLoginTimeout
in interfacejavax.sql.DataSource
- Parameters:
seconds
- the data source login time limit- Throws:
java.sql.SQLException
- if a database access error occurs.- See Also:
getLoginTimeout()
-
setLogWriter
public void setLogWriter(java.io.PrintWriter logWriter) throws java.sql.SQLException
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 interfacejavax.sql.CommonDataSource
- Specified by:
setLogWriter
in interfacejavax.sql.DataSource
- Parameters:
logWriter
- the new log writer; to disable logging, set to null- Throws:
java.sql.SQLException
- if a database access error occurs- See Also:
getLogWriter()
-
setPassword
public void setPassword(java.lang.String password)
Sets the password to use for connecting to the database- Parameters:
password
- the password
-
setUser
public void setUser(java.lang.String user)
Sets the userid- Parameters:
user
- the user id
-
unwrap
public <T> T unwrap(java.lang.Class<T> iface) throws java.sql.SQLException
- Specified by:
unwrap
in interfacejava.sql.Wrapper
- Throws:
java.sql.SQLException
-
isWrapperFor
public boolean isWrapperFor(java.lang.Class<?> iface) throws java.sql.SQLException
- Specified by:
isWrapperFor
in interfacejava.sql.Wrapper
- Throws:
java.sql.SQLException
-
getParentLogger
public java.util.logging.Logger getParentLogger() throws java.sql.SQLFeatureNotSupportedException
- Specified by:
getParentLogger
in interfacejavax.sql.CommonDataSource
- Throws:
java.sql.SQLFeatureNotSupportedException
-
-