com.safejdbc.api
Class Driver

java.lang.Object
  com.safejdbc.api.Driver

All Implemented Interfaces:

Driver

public final class Driver
extends Object
implements 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")

See Also:

Driver

Constructor Summary

Driver()
Construct a new driver and register it with DriverManager

Method Summary

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) Try to make a database connection to the given URL.
int	getMajorVersion() Gets the drivers major version number
int	getMinorVersion() Get the drivers minor version number
DriverPropertyInfo[]	getPropertyInfo(String url, 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.
boolean	jdbcCompliant() Report whether the driver is a genuine JDBC compliant driver.

Methods inherited from class java.lang.Object

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

Constructor Detail

Driver

public Driver()
       throws SQLException

Construct a new driver and register it with DriverManager

Throws:

SQLException - if a SQL Exception occurs.

Method Detail

connect

public Connection connect(String url,
                          Properties info)
                   throws 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.

Specified by:

connect in interface Driver

Parameters:

url - the URL of the database to connect to

info - a list of arbitrary tag/value pairs as connection arguments

Returns:

a connection to the URL or null if it isnt us

Throws:

SQLException - if a database access error occurs

See Also:

Driver.connect(java.lang.String, java.util.Properties)

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 subprotocol specified in the URL and false if they do not.

Specified by:

acceptsURL in interface Driver

Parameters:

url - the URL of the driver

Returns:

true if this driver accepts the given URL

Throws:

SQLException - if a database-access error occurs (Dont know why it would *shrug*)

See Also:

Driver.acceptsURL(java.lang.String)

getPropertyInfo

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

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

Specified by:

getPropertyInfo in interface Driver

Parameters:

url - the Url of the database to connect to

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

See Also:

Driver.getPropertyInfo(java.lang.String, java.util.Properties)

getMajorVersion

public int getMajorVersion()

Gets the drivers major version number

Specified by:

getMajorVersion in interface Driver

Returns:

the drivers major version number

getMinorVersion

public int getMinorVersion()

Get the drivers minor version number

Specified by:

getMinorVersion in interface Driver

Returns:

the drivers minor version number

jdbcCompliant

public 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 SafeJDBC, this is not yet possible, as we are not full SQL92 compliant (yet).

Specified by:

jdbcCompliant in interface Driver