se.entra.phantom.server

Class DriverShim

java.lang.Object

se.entra.phantom.server.DriverShim

All Implemented Interfaces:

Driver

public class DriverShim
extends Object
implements Driver

The Driver shim to be able to load a JDBC driver from the system class loader.

Call the static method registerDriver(Driver) to create a Driver shim instance and register it with the DriverManager.registerDriver(driverShim);.

This class supports JDBC 4.1 even if the code is compiled for Java 1.6 because it uses reflection for the method getParentLogger().

Author:

Christopher Mindus

Method Summary

Modifier and Type	Method and Description
boolean	acceptsURL(String url) Retrieves whether the driver thinks that it can open a connection to the given URL.
Connection	connect(String url, Properties info) Attempts to make a database connection to the given URL.
int	getMajorVersion() Retrieves the driver's major version number.
int	getMinorVersion() Gets the driver's minor version number.
Logger	getParentLogger() Return the parent Logger of all the Loggers used by this driver.
DriverPropertyInfo[]	getPropertyInfo(String url, Properties info) Gets information about the possible properties for this driver.
boolean	jdbcCompliant() Reports whether this driver is a genuine JDBC Compliant™ driver.
static Driver	registerDriver(Driver driver) Static method to register the driver with the DriverManager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

registerDriver

public static Driver registerDriver(Driver driver)
                             throws SQLException

Static method to register the driver with the DriverManager. This is required in order to get the driver shim to be loaded by the system class loader.

Parameters:

driver - The driver to register.

Returns:

The DriverShim instance of the driver.

Throws:

SQLException - For SQL errors.

connect

public Connection connect(String url,
                          Properties info)
                   throws SQLException

Attempts 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 driver manager is asked to connect to a given URL it passes the URL to each loaded driver in turn.

The driver should throw an SQLException if it is the right driver to connect to the given URL but has trouble connecting to the database.

The 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 object.

Note: If a property is specified as part of the url and is also specified in the Properties object, it is implementation-defined as to which value will take precedence. For maximum portability, an application should only specify a property once.

Specified by:

connect in interface Driver

Parameters:

url - the URL of the database to which to connect

info - a list of arbitrary string tag/value pairs as connection arguments. Normally at least a "user" and "password" property should be included.

Returns:

a Connection object that represents a connection to the URL.

Throws:

SQLException - if a database access error occurs or the url is null.

acceptsURL

public boolean acceptsURL(String url)
                   throws SQLException

Retrieves whether the driver thinks that it can open a connection to the given URL. Typically drivers will return true if they understand the sub-protocol specified in the URL and false if they do not.

Specified by:

acceptsURL in interface Driver

Parameters:

url - the URL of the database

Returns:

true if this driver understands the given URL; false otherwise

Throws:

SQLException - if a database access error occurs or the url is null

getPropertyInfo

public DriverPropertyInfo[] getPropertyInfo(String url,
                                            Properties info)
                                     throws SQLException

Gets information about the possible properties for this driver.

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 though several calls to the getPropertyInfo method.

Specified by:

getPropertyInfo in interface Driver

Parameters:

url - the URL of the database to which to connect

info - a proposed list of tag/value pairs that will be sent on connect open

Returns:

an array of DriverPropertyInfo objects describing possible properties. This array may be an empty array if no properties are required.

Throws:

SQLException - if a database access error occurs

getMajorVersion

public int getMajorVersion()

Retrieves the driver's major version number. Initially this should be 1.

Specified by:

getMajorVersion in interface Driver

Returns:

this driver's major version number.

getMinorVersion

public int getMinorVersion()

Gets the driver's minor version number. Initially this should be 0.

Specified by:

getMinorVersion in interface Driver

Returns:

this driver's minor version number.

jdbcCompliant

public boolean jdbcCompliant()

Reports whether this 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. It is expected that JDBC compliant drivers will be available for all the major commercial databases.

This method is not intended to encourage the development of non-JDBC compliant drivers, but is a recognition of the fact that some vendors are interested in using the JDBC API and framework for lightweight databases that do not support full database functionality, or for special databases such as document information retrieval where a SQL implementation may not be feasible.

Specified by:

jdbcCompliant in interface Driver

Returns:

true if this driver is JDBC Compliant; false otherwise

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

Return the parent Logger of all the Loggers used by this driver. This should be the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this driver. Configuring this Logger will affect all of the log messages generated by the driver. In the worst case, this may be the root Logger.

Specified by:

getParentLogger in interface Driver

Returns:

the parent Logger for this driver.

Throws:

SQLFeatureNotSupportedException - if the driver does not use java.util.logging.

Since:

1.7