1.51.2

interbase.interclient
Class XADataSource

java.lang.Object
  |
  +--interbase.interclient.XADataSource

public class XADataSource
extends Object
implements javax.sql.XADataSource

A factory for XAConnection objects. An object that implements the XADataSource interface is typically registered with a JNDI service provider.

Since:
JDBC 2 Standard Extension, proposed for future release, not yet supported
Version:
Std Ext 0.7, JTA 0.9

Constructor Summary
XADataSource()
           
 
Method Summary
 int getLoginTimeout()
          Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
 PrintWriter getLogWriter()
          Get the log writer for this data source.
 javax.sql.XAConnection getXAConnection()
          Attempt to establish a database connection.
 javax.sql.XAConnection getXAConnection(String user, String password)
          Attempt to establish a database connection.
 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 out)
          Set the log writer for this data source.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XADataSource

public XADataSource()
Method Detail

getXAConnection

public javax.sql.XAConnection getXAConnection()
                                       throws SQLException
Attempt to establish a database connection.
Specified by:
getXAConnection in interface javax.sql.XADataSource
Returns:
a Connection to the database
Throws:
SQLException - if a database-access error occurs.
Since:
JDBC 2 Standard Extension, proposed for future release, not yet supported

getXAConnection

public javax.sql.XAConnection getXAConnection(String user,
                                              String password)
                                       throws SQLException

Attempt to establish a database connection.

Specified by:
getXAConnection in interface javax.sql.XADataSource
Parameters:
user - the database user on whose behalf the Connection is being made
password - the user's password
Returns:
a Connection to the database
Throws:
SQLException - if a database-access error occurs.
Since:
JDBC 2 Standard Extension, proposed for future release, not yet supported

getLogWriter

public PrintWriter getLogWriter()
                         throws SQLException

Get the log writer for this data source.

The log writer is a character output stream to which all logging and tracing messages for this data source object instance 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 data source object is created the log writer is initially null, in other words, logging is disabled.

Specified by:
getLogWriter in interface javax.sql.XADataSource
Returns:
the log writer for this data source, null if disabled
Throws:
SQLException - if a database-access error occurs.
Since:
JDBC 2 Standard Extension, proposed for future release, not yet supported

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws SQLException

Set the log writer for this data source.

The log writer is a character output stream to which all logging and tracing messages for this data source object instance 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 data source object is created the log writer is initially null, in other words, logging is disabled.

Specified by:
setLogWriter in interface javax.sql.XADataSource
Parameters:
out - the new log writer; to disable, set to null
Throws:
SQLException - if a database-access error occurs.
Since:
JDBC 2 Standard Extension, proposed for future release, not yet supported

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 data source object is created the login timeout is initially zero.

Specified by:
setLoginTimeout in interface javax.sql.XADataSource
Parameters:
seconds - the data source login time limit
Throws:
SQLException - if a database access error occurs.
Since:
JDBC 2 Standard Extension, proposed for future release, not yet supported

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 data source object is created the login timeout is initially zero.
Specified by:
getLoginTimeout in interface javax.sql.XADataSource
Returns:
the data source login time limit
Throws:
SQLException - if a database access error occurs.
Since:
JDBC 2 Standard Extension, proposed for future release, not yet supported

1.51.2

Send comments or suggestions to interclient@interbase.com