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 * <pre> 49 * <code>Class.forName("foo.bah.Driver")</code> 50 * </pre> 51 * 52 * @see DriverManager 53 * @see Connection 54 */ 55 public interface Driver { 56 57 /** 58 * Attempts to make a database connection to the given URL. 59 * The driver should return "null" if it realizes it is the wrong kind 60 * of driver to connect to the given URL. This will be common, as when 61 * the JDBC driver manager is asked to connect to a given URL it passes 62 * the URL to each loaded driver in turn. 63 * 64 * <P>The driver should throw an <code>SQLException</code> if it is the right 65 * driver to connect to the given URL but has trouble connecting to 66 * the database. 67 * 68 * <P>The {@code Properties} argument can be used to pass 69 * arbitrary string tag/value pairs as connection arguments. 70 * Normally at least "user" and "password" properties should be 71 * included in the {@code Properties} object. 72 * <p> 73 * <B>Note:</B> If a property is specified as part of the {@code url} and 74 * is also specified in the {@code Properties} object, it is 75 * implementation-defined as to which value will take precedence. For 76 * maximum portability, an application should only specify a property once. 77 * 78 * @param url the URL of the database to which to connect 79 * @param info a list of arbitrary string tag/value pairs as 80 * connection arguments. Normally at least a "user" and 81 * "password" property should be included. 82 * @return a <code>Connection</code> object that represents a 83 * connection to the URL 84 * @exception SQLException if a database access error occurs or the url is 85 * {@code null} 86 */ 87 Connection connect(String url, java.util.Properties info) 88 throws SQLException; 89 90 /** 91 * Retrieves whether the driver thinks that it can open a connection 92 * to the given URL. Typically drivers will return <code>true</code> if they 93 * understand the sub-protocol specified in the URL and <code>false</code> if 94 * they do not. 95 * 96 * @param url the URL of the database 97 * @return <code>true</code> if this driver understands the given URL; 98 * <code>false</code> otherwise 99 * @exception SQLException if a database access error occurs or the url is 100 * {@code null} 101 */ 102 boolean acceptsURL(String url) throws SQLException; 103 104 105 /** 106 * Gets information about the possible properties for this driver. 107 * <P> 108 * The <code>getPropertyInfo</code> method is intended to allow a generic 109 * GUI tool to discover what properties it should prompt 110 * a human for in order to get 111 * enough information to connect to a database. Note that depending on 112 * the values the human has supplied so far, additional values may become 113 * necessary, so it may be necessary to iterate though several calls 114 * to the <code>getPropertyInfo</code> method. 115 * 116 * @param url the URL of the database to which to connect 117 * @param info a proposed list of tag/value pairs that will be sent on 118 * connect open 119 * @return an array of <code>DriverPropertyInfo</code> objects describing 120 * possible properties. This array may be an empty array if 121 * no properties are required. 122 * @exception SQLException if a database access error occurs 123 */ 124 DriverPropertyInfo[] getPropertyInfo(String url, java.util.Properties info) 125 throws SQLException; 126 127 128 /** 129 * Retrieves the driver's major version number. Initially this should be 1. 130 * 131 * @return this driver's major version number 132 */ 133 int getMajorVersion(); 134 135 /** 136 * Gets the driver's minor version number. Initially this should be 0. 137 * @return this driver's minor version number 138 */ 139 int getMinorVersion(); 140 141 142 /** 143 * Reports whether this driver is a genuine JDBC 144 * Compliant<sup><font size=-2>TM</font></sup> driver. 145 * A driver may only report <code>true</code> here if it passes the JDBC 146 * compliance tests; otherwise it is required to return <code>false</code>. 147 * <P> 148 * JDBC compliance requires full support for the JDBC API and full support 149 * for SQL 92 Entry Level. It is expected that JDBC compliant drivers will 150 * be available for all the major commercial databases. 151 * <P> 152 * This method is not intended to encourage the development of non-JDBC 153 * compliant drivers, but is a recognition of the fact that some vendors 154 * are interested in using the JDBC API and framework for lightweight 155 * databases that do not support full database functionality, or for 156 * special databases such as document information retrieval where a SQL 157 * implementation may not be feasible. 158 * @return <code>true</code> if this driver is JDBC Compliant; <code>false</code> 159 * otherwise 160 */ 161 boolean jdbcCompliant(); 162 163 //------------------------- JDBC 4.1 ----------------------------------- 164 165 /** 166 * Return the parent Logger of all the Loggers used by this driver. This 167 * should be the Logger farthest from the root Logger that is 168 * still an ancestor of all of the Loggers used by this driver. Configuring 169 * this Logger will affect all of the log messages generated by the driver. 170 * In the worst case, this may be the root Logger. 171 * 172 * @return the parent Logger for this driver 173 * @throws SQLFeatureNotSupportedException if the driver does not use <code>java.util.logging<code>. 174 * @since 1.7 175 */ 176 public Logger getParentLogger() throws SQLFeatureNotSupportedException; 177 178 //------------------------- JDBC 4.2 ----------------------------------- 179 180 /** 181 * Releases any resources that the driver may hold. This method is called by 182 * {@linkplain DriverManager#deregisterDriver} 183 * <p> 184 * The default implementation will be a no-op 185 * <p> 186 * If a security manager exists and its {@code checkPermission} denies 187 * permission, then a {@code SecurityException} will be thrown. 188 * @throws SecurityException if a security manager exists and its 189 * {@code checkPermission} method denies permission to deregister a driver. 190 * 191 * @see SecurityManager#checkPermission 192 * @see DriverManager#deregisterDriver 193 * @since 1.8 194 */ 195 default void deregisterDriver() { 196 // Default method takes no action 197 } 198 }