Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.sql
Interface 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

Method Summary
 int getLoginTimeout sample code for javax.sql.XADataSource.getLoginTimeout() definition code for javax.sql.XADataSource.getLoginTimeout() ()
          Retrieves the maximum time in seconds that this data source can wait while attempting to connect to a data source.
 PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter getLogWriter sample code for javax.sql.XADataSource.getLogWriter() definition code for javax.sql.XADataSource.getLogWriter() ()
          Retrieves the log writer for this XADataSource object.
 XAConnection sample code for javax.sql.XAConnection definition code for javax.sql.XAConnection getXAConnection sample code for javax.sql.XADataSource.getXAConnection() definition code for javax.sql.XADataSource.getXAConnection() ()
          Attempts to establish a physical database connection that can be used in a distributed transaction.
 XAConnection sample code for javax.sql.XAConnection definition code for javax.sql.XAConnection getXAConnection sample code for javax.sql.XADataSource.getXAConnection(java.lang.String, java.lang.String) definition code for javax.sql.XADataSource.getXAConnection(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  user, String sample code for java.lang.String definition code for java.lang.String  password)
          Attempts to establish a physical database connection, using the given user name and password.
 void setLoginTimeout sample code for javax.sql.XADataSource.setLoginTimeout(int) definition code for javax.sql.XADataSource.setLoginTimeout(int) (int seconds)
          Sets the maximum time in seconds that this data source will wait while attempting to connect to a data source.
 void setLogWriter sample code for javax.sql.XADataSource.setLogWriter(java.io.PrintWriter) definition code for javax.sql.XADataSource.setLogWriter(java.io.PrintWriter) (PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter  out)
          Sets the log writer for this XADataSource object to the given java.io.PrintWriter object.
 

Method Detail

getXAConnection sample code for javax.sql.XADataSource.getXAConnection() definition code for javax.sql.XADataSource.getXAConnection() 

XAConnection sample code for javax.sql.XAConnection definition code for javax.sql.XAConnection  getXAConnection()
                             throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException
Attempts to establish a physical database connection that can be used in a distributed transaction.

Returns:
an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

getXAConnection sample code for javax.sql.XADataSource.getXAConnection(java.lang.String, java.lang.String) definition code for javax.sql.XADataSource.getXAConnection(java.lang.String, java.lang.String) 

XAConnection sample code for javax.sql.XAConnection definition code for javax.sql.XAConnection  getXAConnection(String sample code for java.lang.String definition code for java.lang.String  user,
                             String sample code for java.lang.String definition code for java.lang.String  password)
                             throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException
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.

Parameters:
user - the database user on whose behalf the connection is being made
password - the user's password
Returns:
an XAConnection object, which represents a physical connection to a data source, that can be used in a distributed transaction
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

getLogWriter sample code for javax.sql.XADataSource.getLogWriter() definition code for javax.sql.XADataSource.getLogWriter() 

PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter  getLogWriter()
                         throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException

Retrieves the log writer for this XADataSource object.

Returns:
the log writer for this data source; null if no log writer has been set, which means that logging is disabled
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
See Also:
setLogWriter(java.io.PrintWriter) sample code for javax.sql.XADataSource.setLogWriter(java.io.PrintWriter) definition code for javax.sql.XADataSource.setLogWriter(java.io.PrintWriter)

setLogWriter sample code for javax.sql.XADataSource.setLogWriter(java.io.PrintWriter) definition code for javax.sql.XADataSource.setLogWriter(java.io.PrintWriter) 

void setLogWriter(PrintWriter sample code for java.io.PrintWriter definition code for java.io.PrintWriter  out)
                  throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException
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.

Parameters:
out - the new log writer; to disable logging, set to null
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
See Also:
getLogWriter() sample code for javax.sql.XADataSource.getLogWriter() definition code for javax.sql.XADataSource.getLogWriter()

setLoginTimeout sample code for javax.sql.XADataSource.setLoginTimeout(int) definition code for javax.sql.XADataSource.setLoginTimeout(int) 

void setLoginTimeout(int seconds)
                     throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException

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.

Parameters:
seconds - the data source login time limit
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
See Also:
getLoginTimeout() sample code for javax.sql.XADataSource.getLoginTimeout() definition code for javax.sql.XADataSource.getLoginTimeout()

getLoginTimeout sample code for javax.sql.XADataSource.getLoginTimeout() definition code for javax.sql.XADataSource.getLoginTimeout() 

int getLoginTimeout()
                    throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException
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.

Returns:
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
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
See Also:
setLoginTimeout(int) sample code for javax.sql.XADataSource.setLoginTimeout(int) definition code for javax.sql.XADataSource.setLoginTimeout(int)
Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD