Package Summary  Overview Summary

class:XADataSource [NONE]

  • All Superinterfaces:
    CommonDataSource


                                                    
                                public interface XADataSource
    extends CommonDataSource
                                                
    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 Interface™ (JNDI).

    An implementation of XADataSource must include a public no-arg constructor.

    Since:
    1.4

method:getXAConnection() [NONE]

  • getXAConnection

                                                XAConnection getXAConnection()
                          throws 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 - if a database access error occurs
    SQLFeatureNotSupportedException - if the JDBC driver does not support this method
    SQLTimeoutException - when the driver has determined that the timeout value specified by the setLoginTimeout method has been exceeded and has at least tried to cancel the current database connection attempt
    Since:
    1.4

method:getXAConnection(java.lang.String, java.lang.String) [NONE]

  • getXAConnection

                                                XAConnection getXAConnection(java.lang.String user,
                                 java.lang.String password)
                          throws 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 - if a database access error occurs
    SQLFeatureNotSupportedException - if the JDBC driver does not support this method
    SQLTimeoutException - when the driver has determined that the timeout value specified by the setLoginTimeout method has been exceeded and has at least tried to cancel the current database connection attempt
    Since:
    1.4

method:getLogWriter() [ADDED]

  • getLogWriter

                                                java.io.PrintWriter getLogWriter()throwsSQLException
                                            

    RetrievesthelogwriterforthisDataSourceobject.

    Thelogwriterisacharacteroutputstreamtowhichallloggingandtracingmessagesforthisdatasourcewillbeprinted.Thisincludesmessagesprintedbythemethodsofthisobject,messagesprintedbymethodsofotherobjectsmanufacturedbythisobject,andsoon.Messagesprintedtoadatasourcespecificlogwriterarenotprintedtothelogwriterassociatedwiththejava.sql.DriverManagerclass.WhenaDataSourceobjectiscreated,thelogwriterisinitiallynull;inotherwords,thedefaultisforloggingtobedisabled.

    Specifiedby:
    getLogWriter ininterface CommonDataSource
    Returns:
    thelogwriterforthisdatasourceornullifloggingisdisabled
    Throws:
    SQLException-ifadatabaseaccesserroroccurs
    Since:
    1.4
    SeeAlso:
    CommonDataSource.setLogWriter(java.io.PrintWriter)

method:setLogWriter(java.io.PrintWriter) [ADDED]

  • setLogWriter

                                                void setLogWriter(java.io.PrintWriter out)throwsSQLException
                                            

    SetsthelogwriterforthisDataSourceobjecttothegivenjava.io.PrintWriterobject.

    Thelogwriterisacharacteroutputstreamtowhichallloggingandtracingmessagesforthisdatasourcewillbeprinted.Thisincludesmessagesprintedbythemethodsofthisobject,messagesprintedbymethodsofotherobjectsmanufacturedbythisobject,andsoon.Messagesprintedtoadatasource-specificlogwriterarenotprintedtothelogwriterassociatedwiththejava.sql.DriverManagerclass.WhenaDataSourceobjectiscreatedthelogwriterisinitiallynull;inotherwords,thedefaultisforloggingtobedisabled.

    Specifiedby:
    setLogWriter ininterface CommonDataSource
    Parameters:
    out-thenewlogwriter;todisablelogging,settonull
    Throws:
    SQLException-ifadatabaseaccesserroroccurs
    Since:
    1.4
    SeeAlso:
    CommonDataSource.getLogWriter()

method:setLoginTimeout(int) [ADDED]

  • setLoginTimeout

                                                void setLoginTimeout(int seconds)throwsSQLException
                                            

    Setsthemaximumtimeinsecondsthatthisdatasourcewillwaitwhileattemptingtoconnecttoadatabase.Avalueofzerospecifiesthatthetimeoutisthedefaultsystemtimeoutifthereisone;otherwise,itspecifiesthatthereisnotimeout.WhenaDataSourceobjectiscreated,thelogintimeoutisinitiallyzero.

    Specifiedby:
    setLoginTimeout ininterface CommonDataSource
    Parameters:
    seconds-thedatasourcelogintimelimit
    Throws:
    SQLException-ifadatabaseaccesserroroccurs.
    Since:
    1.4
    SeeAlso:
    CommonDataSource.getLoginTimeout()

method:getLoginTimeout() [ADDED]

  • getLoginTimeout

                                                int getLoginTimeout()throwsSQLException
                                            
    Getsthemaximumtimeinsecondsthatthisdatasourcecanwaitwhileattemptingtoconnecttoadatabase.Avalueofzeromeansthatthetimeoutisthedefaultsystemtimeoutifthereisone;otherwise,itmeansthatthereisnotimeout.WhenaDataSourceobjectiscreated,thelogintimeoutisinitiallyzero.
    Specifiedby:
    getLoginTimeout ininterface CommonDataSource
    Returns:
    thedatasourcelogintimelimit
    Throws:
    SQLException-ifadatabaseaccesserroroccurs.
    Since:
    1.4
    SeeAlso:
    CommonDataSource.setLoginTimeout(int)

method:createXAConnectionBuilder() [ADDED]