1 /*
2 * Copyright (c) 1996, 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 java.sql;
27
28 import java.util.logging.Logger;
29
30 /**
31 * The interface that every driver class must implement.
32 * <P>The Java SQL framework allows for multiple database drivers.
33 *
34 * <P>Each driver should supply a class that implements
35 * the Driver interface.
36 *
37 * <P>The DriverManager will try to load as many drivers as it can
38 * find and then for any given connection request, it will ask each
39 * driver in turn to try to connect to the target URL.
40 *
41 * <P>It is strongly recommended that each Driver class should be
42 * small and standalone so that the Driver class can be loaded and
43 * queried without bringing in vast quantities of supporting code.
44 *
45 * <P>When a Driver class is loaded, it should create an instance of
46 * itself and register it with the DriverManager. This means that a
47 * user can load and register a driver by calling:
48 * <p>
49 * {@code Class.forName("foo.bah.Driver")}
50 * <p>
51 * A JDBC driver may create a {@linkplain DriverAction} implementation in order
52 * to receive notifications when {@linkplain DriverManager#deregisterDriver} has
53 * been called.
54 * @see DriverManager
55 * @see Connection
56 * @see DriverAction
57 */
58 public interface Driver {
59
60 /**
61 * Attempts to make a database connection to the given URL.
62 * The driver should return "null" if it realizes it is the wrong kind
63 * of driver to connect to the given URL. This will be common, as when
64 * the JDBC driver manager is asked to connect to a given URL it passes
65 * the URL to each loaded driver in turn.
66 *
67 * <P>The driver should throw an <code>SQLException</code> if it is the right
68 * driver to connect to the given URL but has trouble connecting to
69 * the database.
70 *
71 * <P>The {@code Properties} argument can be used to pass
72 * arbitrary string tag/value pairs as connection arguments.
73 * Normally at least "user" and "password" properties should be
74 * included in the {@code Properties} object.
75 * <p>
76 * <B>Note:</B> If a property is specified as part of the {@code url} and
77 * is also specified in the {@code Properties} object, it is
78 * implementation-defined as to which value will take precedence. For
79 * maximum portability, an application should only specify a property once.
80 *
81 * @param url the URL of the database to which to connect
82 * @param info a list of arbitrary string tag/value pairs as
83 * connection arguments. Normally at least a "user" and
84 * "password" property should be included.
85 * @return a <code>Connection</code> object that represents a
86 * connection to the URL
87 * @exception SQLException if a database access error occurs or the url is
88 * {@code null}
89 */
90 Connection connect(String url, java.util.Properties info)
91 throws SQLException;
92
93 /**
94 * Retrieves whether the driver thinks that it can open a connection
95 * to the given URL. Typically drivers will return <code>true</code> if they
96 * understand the sub-protocol specified in the URL and <code>false</code> if
97 * they do not.
98 *
99 * @param url the URL of the database
100 * @return <code>true</code> if this driver understands the given URL;
101 * <code>false</code> otherwise
102 * @exception SQLException if a database access error occurs or the url is
103 * {@code null}
104 */
105 boolean acceptsURL(String url) throws SQLException;
106
107
108 /**
109 * Gets information about the possible properties for this driver.
110 * <P>
111 * The <code>getPropertyInfo</code> method is intended to allow a generic
112 * GUI tool to discover what properties it should prompt
113 * a human for in order to get
114 * enough information to connect to a database. Note that depending on
115 * the values the human has supplied so far, additional values may become
116 * necessary, so it may be necessary to iterate though several calls
117 * to the <code>getPropertyInfo</code> method.
118 *
119 * @param url the URL of the database to which to connect
120 * @param info a proposed list of tag/value pairs that will be sent on
121 * connect open
122 * @return an array of <code>DriverPropertyInfo</code> objects describing
123 * possible properties. This array may be an empty array if
124 * no properties are required.
125 * @exception SQLException if a database access error occurs
126 */
127 DriverPropertyInfo[] getPropertyInfo(String url, java.util.Properties info)
128 throws SQLException;
129
130
131 /**
132 * Retrieves the driver's major version number. Initially this should be 1.
133 *
134 * @return this driver's major version number
135 */
136 int getMajorVersion();
137
138 /**
139 * Gets the driver's minor version number. Initially this should be 0.
140 * @return this driver's minor version number
141 */
142 int getMinorVersion();
143
144
145 /**
146 * Reports whether this driver is a genuine JDBC
147 * Compliant™ driver.
148 * A driver may only report <code>true</code> here if it passes the JDBC
149 * compliance tests; otherwise it is required to return <code>false</code>.
150 * <P>
151 * JDBC compliance requires full support for the JDBC API and full support
152 * for SQL 92 Entry Level. It is expected that JDBC compliant drivers will
153 * be available for all the major commercial databases.
154 * <P>
155 * This method is not intended to encourage the development of non-JDBC
156 * compliant drivers, but is a recognition of the fact that some vendors
157 * are interested in using the JDBC API and framework for lightweight
158 * databases that do not support full database functionality, or for
159 * special databases such as document information retrieval where a SQL
160 * implementation may not be feasible.
161 * @return <code>true</code> if this driver is JDBC Compliant; <code>false</code>
162 * otherwise
163 */
164 boolean jdbcCompliant();
165
166 //------------------------- JDBC 4.1 -----------------------------------
167
168 /**
169 * Return the parent Logger of all the Loggers used by this driver. This
170 * should be the Logger farthest from the root Logger that is
171 * still an ancestor of all of the Loggers used by this driver. Configuring
172 * this Logger will affect all of the log messages generated by the driver.
173 * In the worst case, this may be the root Logger.
174 *
175 * @return the parent Logger for this driver
176 * @throws SQLFeatureNotSupportedException if the driver does not use
177 * {@code java.util.logging}.
178 * @since 1.7
179 */
180 public Logger getParentLogger() throws SQLFeatureNotSupportedException;
181 }