FileDocCategorySizeDatePackage
CommonDataSource.javaAPI DocJava SE 6 API3616Tue Jun 10 00:26:32 BST 2008javax.sql

CommonDataSource

public interface CommonDataSource
Interface that defines the methods which are common between DataSource, XADataSource and ConnectionPoolDataSource.

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

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.

return
the log writer for this data source or null if logging is disabled
exception
java.sql.SQLException if a database access error occurs
see
#setLogWriter
since
1.4

public intgetLoginTimeout()
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 DataSource object is created, the login timeout is initially zero.

return
the data source login time limit
exception
SQLException if a database access error occurs.
see
#setLoginTimeout
since
1.4

public voidsetLogWriter(java.io.PrintWriter out)

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.

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

public voidsetLoginTimeout(int seconds)

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.

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