org.jcreme.sql
Class WrappingDriverManager

java.lang.Object
  org.jcreme.sql.WrappingDriverManager

public class WrappingDriverManager

extends java.lang.Object

This class is intended to wrap the original DriverManager so that all the connections are returned from a wrapping driver. It enables to specify a Driver that will provide all the connections (WrappedConnection for instance). The Driver can also make use of ConnectionPools.

Version:

$Revision: 1.1 $

Author:

$Author: dbregeon $

Method Summary

static void	deregisterDriver(java.sql.Driver driver) Drops a driver from the DriverManager's list.
static java.sql.Connection	getConnection(java.lang.String url) Attempts to establish a connection to the given database URL.
static java.sql.Connection	getConnection(java.lang.String url, java.util.Properties info) Attempts to establish a connection to the given database URL.
static java.sql.Connection	getConnection(java.lang.String url, java.lang.String user, java.lang.String password) Attempts to establish a connection to the given database URL.
static java.sql.Driver	getDriver(java.lang.String url) Attempts to locate a driver that understands the given URL.
static java.util.Enumeration	getDrivers() Retrieves an Enumeration with all of the currently loaded JDBC drivers to which the current caller has access.
static int	getLoginTimeout() Gets the maximum time in seconds that a driver can wait when attempting to log in to a database.
static java.io.PrintWriter	getLogWriter() Retrieves the log writer.
static void	println(java.lang.String message) Prints a message to the current JDBC log stream.
static void	registerDriver(java.sql.Driver driver) Registers the given driver with the DriverManager.
static void	setLoginTimeout(int seconds) Sets the maximum time in seconds that a driver will wait while attempting to connect to a database.
static void	setLogWriter(java.io.PrintWriter out) Sets the logging/tracing PrintWriter object that is used by the DriverManager and all drivers.
static void	setWrappingDriver(java.sql.Driver driver) Enables to set the Driver that is used to wrap the connections.

Methods inherited from class java.lang.Object

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

Method Detail

getLogWriter

public static java.io.PrintWriter getLogWriter()

Retrieves the log writer. The getLogWriter and setLogWriter methods should be used instead of the get/setlogStream methods, which are deprecated.

Returns:

a java.io.PrintWriter object

Since:

1.2

See Also:

setLogWriter(java.io.PrintWriter)

getConnection

public static java.sql.Connection getConnection(java.lang.String url)
                                         throws java.sql.SQLException

Attempts to establish a connection to the given database URL. The DriverManager attempts to select an appropriate driver from the set of registered JDBC drivers.

Parameters:

url - a database url of the form jdbc:subprotocol:subname

Returns:

a connection to the URL

Throws:

java.sql.SQLException - if a database access error occurs

setLogWriter

public static void setLogWriter(java.io.PrintWriter out)

Sets the logging/tracing PrintWriter object that is used by the DriverManager and all drivers.

There is a minor versioning problem created by the introduction of the method setLogWriter. The method setLogWriter cannot create a PrintStream object that will be returned by getLogStream ---the Java platform does not provide a backward conversion. As a result, a new application that uses setLogWriter and also uses a JDBC 1.0 driver that uses getLogStream will likely not see debugging information written by that driver.

In the Java 2 SDK, Standard Edition, version 1.3 release, this method checks to see that there is an SQLPermission object before setting the logging stream. If a SecurityManager exists and its checkPermission method denies setting the log writer, this method throws a java.lang.SecurityException.

Parameters:

out - the new logging/tracing PrintStream object; null to disable logging and tracing

Throws:

java.lang.SecurityException - if a security manager exists and its checkPermission method denies setting the log writer

Since:

1.2

See Also:

SecurityManager.checkPermission(java.security.Permission), getLogWriter()

getConnection

public static java.sql.Connection getConnection(java.lang.String url,
                                                java.util.Properties info)
                                         throws java.sql.SQLException

Attempts to establish a connection to the given database URL. The DriverManager attempts to select an appropriate driver from the set of registered JDBC drivers.

Parameters:

url - a database url of the form jdbc:subprotocol:subname

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 to the URL

Throws:

java.sql.SQLException - if a database access error occurs

getConnection

public static java.sql.Connection getConnection(java.lang.String url,
                                                java.lang.String user,
                                                java.lang.String password)
                                         throws java.sql.SQLException

Attempts to establish a connection to the given database URL. The DriverManager attempts to select an appropriate driver from the set of registered JDBC drivers.

Parameters:

url - a database url of the form jdbc:subprotocol:subname

user - the database user on whose behalf the connection is being made

password - the user's password

Returns:

a connection to the URL

Throws:

java.sql.SQLException - if a database access error occurs

getDriver

public static java.sql.Driver getDriver(java.lang.String url)
                                 throws java.sql.SQLException

Attempts to locate a driver that understands the given URL. The DriverManager attempts to select an appropriate driver from the set of registered JDBC drivers.

Parameters:

url - a database URL of the form jdbc:subprotocol:subname

Returns:

a Driver object representing a driver that can connect to the given URL

Throws:

java.sql.SQLException - if a database access error occurs

registerDriver

public static void registerDriver(java.sql.Driver driver)
                           throws java.sql.SQLException

Registers the given driver with the DriverManager. A newly-loaded driver class should call the method registerDriver to make itself known to the DriverManager.

Parameters:

driver - the new JDBC Driver that is to be registered with the DriverManager

Throws:

java.sql.SQLException - if a database access error occurs

deregisterDriver

public static void deregisterDriver(java.sql.Driver driver)
                             throws java.sql.SQLException

Drops a driver from the DriverManager's list. Applets can only deregister drivers from their own classloaders.

Parameters:

driver - the JDBC Driver to drop

Throws:

java.sql.SQLException - if a database access error occurs

getDrivers

public static java.util.Enumeration getDrivers()

Retrieves an Enumeration with all of the currently loaded JDBC drivers to which the current caller has access.

Note: The classname of a driver can be found using d.getClass().getName()

Returns:

the list of JDBC Drivers loaded by the caller's class loader

setLoginTimeout

public static void setLoginTimeout(int seconds)

Sets the maximum time in seconds that a driver will wait while attempting to connect to a database.

Parameters:

seconds - the login time limit in seconds

See Also:

getLoginTimeout()

getLoginTimeout

public static int getLoginTimeout()

Gets the maximum time in seconds that a driver can wait when attempting to log in to a database.

Returns:

the driver login time limit in seconds

See Also:

setLoginTimeout(int)

println

public static void println(java.lang.String message)

Prints a message to the current JDBC log stream.

Parameters:

message - a log or tracing message

setWrappingDriver

public static void setWrappingDriver(java.sql.Driver driver)

Enables to set the Driver that is used to wrap the connections.

Parameters:

driver - the driver that will provide the connections.