CommonDataSource.java revision 2362
0N/A/*
553N/A * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
0N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
553N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
553N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0N/A * or visit www.oracle.com if you need additional information or have any
0N/A * questions.
0N/A */
0N/A
0N/Apackage javax.sql;
0N/A
0N/Aimport java.sql.SQLException;
0N/Aimport java.io.PrintWriter;
0N/A
0N/A/**
0N/A * Interface that defines the methods which are common between <code>DataSource</code>,
0N/A * <code>XADataSource</code> and <code>ConnectionPoolDataSource</code>.
0N/A *<p>
0N/A */
0N/Apublic interface CommonDataSource {
0N/A
0N/A /**
0N/A * <p>Retrieves the log writer for this <code>DataSource</code>
0N/A * object.
0N/A *
0N/A * <p>The log writer is a character output stream to which all logging
139N/A * and tracing messages for this data source will be
0N/A * printed. This includes messages printed by the methods of this
0N/A * object, messages printed by methods of other objects manufactured
0N/A * by this object, and so on. Messages printed to a data source
0N/A * specific log writer are not printed to the log writer associated
0N/A * with the <code>java.sql.DriverManager</code> class. When a
0N/A * <code>DataSource</code> object is
0N/A * created, the log writer is initially null; in other words, the
0N/A * default is for logging to be disabled.
0N/A *
0N/A * @return the log writer for this data source or null if
0N/A * logging is disabled
0N/A * @exception java.sql.SQLException if a database access error occurs
0N/A * @see #setLogWriter
0N/A * @since 1.4
0N/A */
0N/A java.io.PrintWriter getLogWriter() throws SQLException;
0N/A
0N/A /**
0N/A * <p>Sets the log writer for this <code>DataSource</code>
* object to the given <code>java.io.PrintWriter</code> object.
*
* <p>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 <code>java.sql.DriverManager</code> class. When a
* <code>DataSource</code> 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
*/
void setLogWriter(java.io.PrintWriter out) throws SQLException;
/**
* <p>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 <code>DataSource</code> 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
*/
void setLoginTimeout(int seconds) 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 <code>DataSource</code> 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
*/
int getLoginTimeout() throws SQLException;
}