FileDocCategorySizeDatePackage
XADataSource.javaAPI DocJava SE 5 API4400Fri Aug 26 14:57:50 BST 2005javax.sql

XADataSource

public interface XADataSource
A factory for XAConnection objects that is used internally. An object that implements the XADataSource interface is typically registered with a naming service that uses the Java Naming and Directory InterfaceTM (JNDI).
since
1.4

Fields Summary
Constructors Summary
Methods Summary
public java.io.PrintWritergetLogWriter()

Retrieves the log writer for this XADataSource object.

return
the log writer for this data source; null if no log writer has been set, which means that logging is disabled
exception
SQLException if a database access error occurs
see
#setLogWriter

public intgetLoginTimeout()
Retrieves the maximum time in seconds that this data source can wait while attempting to connect to a data source. 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.

return
the number of seconds that is the login time limit for this XADataSource object or zero if there is no no timeout limit or the timeout limit is the default system timeout limit if there is one
exception
SQLException if a database access error occurs
see
#setLoginTimeout

public javax.sql.XAConnectiongetXAConnection()
Attempts to establish a physical database connection that can be used in a distributed transaction.

return
an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction
exception
SQLException if a database access error occurs

public javax.sql.XAConnectiongetXAConnection(java.lang.String user, java.lang.String password)
Attempts to establish a physical database connection, using the given user name and password. The connection that is returned is one that can be used in a distributed transaction.

param
user the database user on whose behalf the connection is being made
param
password the user's password
return
an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction
exception
SQLException if a database access error occurs

public voidsetLogWriter(java.io.PrintWriter out)
Sets the log writer for this XADataSource 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 XADataSource object 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 log writer that is specific to a data source 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.

param
out the new log writer; to disable logging, set to null
exception
SQLException if a database access error occurs
see
#getLogWriter

public voidsetLoginTimeout(int seconds)

Sets the maximum time in seconds that this data source will wait while attempting to connect to a data source. 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.

param
seconds the data source login time limit
exception
SQLException if a database access error occurs
see
#getLoginTimeout