public class Driver
extends java.lang.Object
implements java.sql.Driver
The Java SQL framework allows for multiple database drivers. Each driver should supply a class that implements the Driver interface
The DriverManager will try to load as many drivers as it can find and then for any given connection request, it will ask each driver in turn to try to connect to the target URL.
It is strongly recommended that each Driver class should be small and standalone so that the Driver class can be loaded and queried without bringing in vast quantities of supporting code.
When a Driver class is loaded, it should create an instance of itself and register it with the DriverManager. This means that a user can load and register a driver by doing Class.forName("foo.bah.Driver")
PGConnection
,
Driver
Modifier and Type | Class and Description |
---|---|
private static class |
Driver.ConnectThread
Perform a connect in a separate thread; supports getting the results from the original thread
while enforcing a login timeout.
|
Modifier and Type | Field and Description |
---|---|
private static java.lang.String |
DEFAULT_PORT |
private java.util.Properties |
defaultProperties |
private static java.util.logging.Logger |
LOGGER |
private static java.lang.String |
loggerHandlerFile |
private static java.util.logging.Logger |
PARENT_LOGGER |
private static Driver |
registeredDriver |
private static SharedTimer |
SHARED_TIMER |
Constructor and Description |
---|
Driver() |
Modifier and Type | Method and Description |
---|---|
boolean |
acceptsURL(java.lang.String url)
Returns true if the driver thinks it can open a connection to the given URL.
|
java.sql.Connection |
connect(java.lang.String url,
java.util.Properties info)
Try to make a database connection to the given URL.
|
private static java.lang.String |
database(java.util.Properties props) |
static void |
deregister()
According to JDBC specification, this driver is registered against
DriverManager when
the class is loaded. |
private java.util.Properties |
getDefaultProperties() |
int |
getMajorVersion() |
int |
getMinorVersion() |
java.util.logging.Logger |
getParentLogger() |
java.sql.DriverPropertyInfo[] |
getPropertyInfo(java.lang.String url,
java.util.Properties info)
The getPropertyInfo method is intended to allow a generic GUI tool to discover what properties
it should prompt a human for in order to get enough information to connect to a database.
|
static SharedTimer |
getSharedTimer() |
static java.lang.String |
getVersion()
Deprecated.
use
getMajorVersion() and getMinorVersion() instead |
private static HostSpec[] |
hostSpecs(java.util.Properties props) |
static boolean |
isRegistered() |
boolean |
jdbcCompliant()
Report whether the driver is a genuine JDBC compliant driver.
|
private java.util.Properties |
loadDefaultProperties() |
private static java.sql.Connection |
makeConnection(java.lang.String url,
java.util.Properties props)
Create a connection from URL and properties.
|
static java.sql.SQLFeatureNotSupportedException |
notImplemented(java.lang.Class<?> callClass,
java.lang.String functionName)
This method was added in v6.5, and simply throws an SQLException for an unimplemented method.
|
static java.util.Properties |
parseURL(java.lang.String url,
java.util.Properties defaults)
Constructs a new DriverURL, splitting the specified URL into its component parts.
|
static void |
register()
Register the driver against
DriverManager . |
private void |
setupLoggerFromProperties(java.util.Properties props)
Setup java.util.logging.Logger using connection properties.
|
private static long |
timeout(java.util.Properties props) |
private static java.lang.String |
user(java.util.Properties props) |
private static Driver registeredDriver
private static final java.util.logging.Logger PARENT_LOGGER
private static final java.util.logging.Logger LOGGER
private static final SharedTimer SHARED_TIMER
private static final java.lang.String DEFAULT_PORT
private java.util.Properties defaultProperties
private static java.lang.String loggerHandlerFile
private java.util.Properties getDefaultProperties() throws java.io.IOException
java.io.IOException
private java.util.Properties loadDefaultProperties() throws java.io.IOException
java.io.IOException
public java.sql.Connection connect(java.lang.String url, java.util.Properties info) throws java.sql.SQLException
Try to make a database connection to the given URL. The driver should return "null" if it realizes it is the wrong kind of driver to connect to the given URL. This will be common, as when the JDBC driverManager is asked to connect to a given URL, it passes the URL to each loaded driver in turn.
The driver should raise an SQLException if it is the right driver to connect to the given URL, but has trouble connecting to the database.
The java.util.Properties argument can be used to pass arbitrary string tag/value pairs as connection arguments.
Normally, at least "user" and "password" properties should be included in the properties. For a
list of supported character encoding , see
http://java.sun.com/products/jdk/1.2/docs/guide/internat/encoding.doc.html Note that you will
probably want to have set up the Postgres database itself to use the same encoding, with the
-E <encoding>
argument to createdb.
Our protocol takes the forms:
jdbc:postgresql://host:port/database?param1=val1&...
connect
in interface java.sql.Driver
url
- the URL of the database to connect toinfo
- a list of arbitrary tag/value pairs as connection argumentsjava.sql.SQLException
- if a database access error occurs or the url is
null
Driver.connect(java.lang.String, java.util.Properties)
private void setupLoggerFromProperties(java.util.Properties props)
Setup java.util.logging.Logger using connection properties.
props
- Connection Propertiesprivate static java.sql.Connection makeConnection(java.lang.String url, java.util.Properties props) throws java.sql.SQLException
url
- the original URLprops
- the parsed/defaulted connection propertiesjava.sql.SQLException
- if the connection could not be madepublic boolean acceptsURL(java.lang.String url)
acceptsURL
in interface java.sql.Driver
url
- the URL of the driverDriver.acceptsURL(java.lang.String)
public java.sql.DriverPropertyInfo[] getPropertyInfo(java.lang.String url, java.util.Properties info)
The getPropertyInfo method is intended to allow a generic GUI tool to discover what properties it should prompt a human for in order to get enough information to connect to a database.
Note that depending on the values the human has supplied so far, additional values may become necessary, so it may be necessary to iterate through several calls to getPropertyInfo
getPropertyInfo
in interface java.sql.Driver
url
- the Url of the database to connect toinfo
- a proposed list of tag/value pairs that will be sent on connect open.Driver.getPropertyInfo(java.lang.String, java.util.Properties)
public int getMajorVersion()
getMajorVersion
in interface java.sql.Driver
public int getMinorVersion()
getMinorVersion
in interface java.sql.Driver
@Deprecated public static java.lang.String getVersion()
getMajorVersion()
and getMinorVersion()
insteadpublic boolean jdbcCompliant()
Report whether the driver is a genuine JDBC compliant driver. A driver may only report "true" here if it passes the JDBC compliance tests, otherwise it is required to return false. JDBC compliance requires full support for the JDBC API and full support for SQL 92 Entry Level.
For PostgreSQL, this is not yet possible, as we are not SQL92 compliant (yet).
jdbcCompliant
in interface java.sql.Driver
public static java.util.Properties parseURL(java.lang.String url, java.util.Properties defaults)
url
- JDBC URL to parsedefaults
- Default propertiesprivate static HostSpec[] hostSpecs(java.util.Properties props)
private static java.lang.String user(java.util.Properties props)
private static java.lang.String database(java.util.Properties props)
private static long timeout(java.util.Properties props)
public static java.sql.SQLFeatureNotSupportedException notImplemented(java.lang.Class<?> callClass, java.lang.String functionName)
callClass
- the call ClassfunctionName
- the name of the unimplemented function with the type of its argumentspublic java.util.logging.Logger getParentLogger()
getParentLogger
in interface java.sql.Driver
public static SharedTimer getSharedTimer()
public static void register() throws java.sql.SQLException
DriverManager
. This is done automatically when the class is
loaded. Dropping the driver from DriverManager's list is possible using deregister()
method.java.lang.IllegalStateException
- if the driver is already registeredjava.sql.SQLException
- if registering the driver failspublic static void deregister() throws java.sql.SQLException
DriverManager
when
the class is loaded. To avoid leaks, this method allow unregistering the driver so that the
class can be gc'ed if necessary.java.lang.IllegalStateException
- if the driver is not registeredjava.sql.SQLException
- if deregistering the driver failspublic static boolean isRegistered()
true
if the driver is registered against DriverManager