| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.hsqldb.jdbc.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 | |
|  java.sql.Connection | getConnection()Attempts to establish a connection with the data source that this DataSourceobject represents. | 
|  java.sql.Connection | getConnection(java.lang.String username,
              java.lang.String password)Attempts to establish a connection with the data source that this DataSourceobject 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 this DataSourceobject. | 
|  javax.naming.Reference | getReference() | 
|  java.lang.String | getUser()Retrieves the user ID for the connection. | 
|  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 this DataSourceobject to the givenjava.io.PrintWriterobject. | 
|  void | setPassword(java.lang.String password)Sets the password to use for connecting to the database | 
|  void | setUser(java.lang.String user)Sets the userid | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
public jdbcDataSource()
| Method Detail | 
public java.sql.Connection getConnection()
                                  throws java.sql.SQLException
Attempts to establish a connection with the data source that
 this DataSource object represents.
getConnection in interface javax.sql.DataSourcejava.sql.SQLException - if a database access error occurs
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.
getConnection in interface javax.sql.DataSourceusername - the database user on whose behalf the connection is
  being madepassword - the user's password
java.sql.SQLException - if a database access error occurspublic java.lang.String getDatabase()
public int getLoginTimeout()
                    throws java.sql.SQLException
DataSource object is created, the login timeout is
 initially zero.
getLoginTimeout in interface javax.sql.DataSourcejava.sql.SQLException - if a database access error occurs.setLoginTimeout(int)
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 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 javax.sql.DataSourcejava.sql.SQLException - if a database access error occurssetLogWriter(java.io.PrintWriter)
public javax.naming.Reference getReference()
                                    throws javax.naming.NamingException
getReference in interface javax.naming.Referenceablejavax.naming.NamingExceptionpublic java.lang.String getUser()
public void setDatabase(java.lang.String database)
database - the new value of this object's jdbc database connection
      url attribute
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.
setLoginTimeout in interface javax.sql.DataSourceseconds - the data source login time limit
java.sql.SQLException - if a database access error occurs.getLoginTimeout()
public void setLogWriter(java.io.PrintWriter logWriter)
                  throws 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.
setLogWriter in interface javax.sql.DataSourcelogWriter - the new log writer; to disable logging, set to null
java.sql.SQLException - if a database access error occursgetLogWriter()public void setPassword(java.lang.String password)
password - the passwordpublic void setUser(java.lang.String user)
user - the user id| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||