1 /*
2 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javax.sql;
27
28 import java.sql.SQLException;
29 import java.io.PrintWriter;
30 import java.sql.SQLFeatureNotSupportedException;
31 import java.util.logging.Logger;
32
33 /**
34 * Interface that defines the methods which are common between <code>DataSource</code>,
35 * <code>XADataSource</code> and <code>ConnectionPoolDataSource</code>.
36 *
37 * @since 1.6
38 */
39 public interface CommonDataSource {
40
41 /**
42 * <p>Retrieves the log writer for this <code>DataSource</code>
43 * object.
44 *
45 * <p>The log writer is a character output stream to which all logging
46 * and tracing messages for this data source will be
47 * printed. This includes messages printed by the methods of this
48 * object, messages printed by methods of other objects manufactured
49 * by this object, and so on. Messages printed to a data source
50 * specific log writer are not printed to the log writer associated
51 * with the <code>java.sql.DriverManager</code> class. When a
52 * <code>DataSource</code> object is
53 * created, the log writer is initially null; in other words, the
54 * default is for logging to be disabled.
55 *
56 * @return the log writer for this data source or null if
57 * logging is disabled
58 * @exception java.sql.SQLException if a database access error occurs
59 * @see #setLogWriter
60 * @since 1.4
61 */
62 java.io.PrintWriter getLogWriter() throws SQLException;
63
64 /**
65 * <p>Sets the log writer for this <code>DataSource</code>
66 * object to the given <code>java.io.PrintWriter</code> object.
67 *
68 * <p>The log writer is a character output stream to which all logging
69 * and tracing messages for this data source will be
70 * printed. This includes messages printed by the methods of this
71 * object, messages printed by methods of other objects manufactured
72 * by this object, and so on. Messages printed to a data source-
73 * specific log writer are not printed to the log writer associated
74 * with the <code>java.sql.DriverManager</code> class. When a
75 * <code>DataSource</code> object is created the log writer is
76 * initially null; in other words, the default is for logging to be
77 * disabled.
78 *
79 * @param out the new log writer; to disable logging, set to null
80 * @exception SQLException if a database access error occurs
81 * @see #getLogWriter
82 * @since 1.4
83 */
84 void setLogWriter(java.io.PrintWriter out) throws SQLException;
85
86 /**
87 * <p>Sets the maximum time in seconds that this data source will wait
88 * while attempting to connect to a database. A value of zero
89 * specifies that the timeout is the default system timeout
90 * if there is one; otherwise, it specifies that there is no timeout.
91 * When a <code>DataSource</code> object is created, the login timeout is
92 * initially zero.
93 *
94 * @param seconds the data source login time limit
95 * @exception SQLException if a database access error occurs.
96 * @see #getLoginTimeout
97 * @since 1.4
98 */
99 void setLoginTimeout(int seconds) throws SQLException;
100
101 /**
102 * Gets the maximum time in seconds that this data source can wait
103 * while attempting to connect to a database. A value of zero
104 * means that the timeout is the default system timeout
105 * if there is one; otherwise, it means that there is no timeout.
106 * When a <code>DataSource</code> object is created, the login timeout is
107 * initially zero.
108 *
109 * @return the data source login time limit
110 * @exception SQLException if a database access error occurs.
111 * @see #setLoginTimeout
112 * @since 1.4
113 */
114 int getLoginTimeout() throws SQLException;
115
116 //------------------------- JDBC 4.1 -----------------------------------
117
118 /**
119 * Return the parent Logger of all the Loggers used by this data source. This
120 * should be the Logger farthest from the root Logger that is
121 * still an ancestor of all of the Loggers used by this data source. Configuring
122 * this Logger will affect all of the log messages generated by the data source.
123 * In the worst case, this may be the root Logger.
124 *
125 * @return the parent Logger for this data source
126 * @throws SQLFeatureNotSupportedException if the data source does not use
127 * {@code java.util.logging}
128 * @since 1.7
129 */
130 public Logger getParentLogger() throws SQLFeatureNotSupportedException;
131 }