Class DriverManager
NOTE: The DataSource interface, provides
another way to connect to a data source.
The use of a DataSource object is the preferred means of
connecting to a data source.
As part of its initialization, the DriverManager class will
attempt to load available JDBC drivers by using:
- The
jdbc.driverssystem property which contains a colon separated list of fully qualified class names of JDBC drivers. Each driver is loaded using the system class loader:jdbc.drivers=foo.bah.Driver:wombat.sql.Driver:bad.taste.ourDriver
- Service providers of the
java.sql.Driverclass, that are loaded via the service-provider loading mechanism.
- Implementation Note:
DriverManagerinitialization is done lazily and looks up service providers using the thread context class loader. The drivers loaded and available to an application will depend on the thread context class loader of the thread that triggers driver initialization byDriverManager.When the method
getConnectionis called, theDriverManagerwill attempt to locate a suitable driver from amongst those loaded at initialization and those loaded explicitly using the same class loader as the current application.- Since:
- 1.1
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic voidderegisterDriver(Driver driver) Removes the specified driver from theDriverManager's list of registered drivers.drivers()Retrieves a Stream with all of the currently loaded JDBC drivers to which the current caller has access.static ConnectiongetConnection(String url) Attempts to establish a connection to the given database URL.static ConnectiongetConnection(String url, String user, String password) Attempts to establish a connection to the given database URL.static ConnectiongetConnection(String url, Properties info) Attempts to establish a connection to the given database URL.static DriverAttempts to locate a driver that understands the given URL.static Enumeration<Driver> Retrieves an Enumeration with all of the currently loaded JDBC drivers to which the current caller has access.static intGets the maximum time in seconds that a driver can wait when attempting to log in to a database.static PrintStreamDeprecated.static PrintWriterRetrieves the log writer.static voidPrints a message to the current JDBC log stream.static voidregisterDriver(Driver driver) Registers the given driver with theDriverManager.static voidregisterDriver(Driver driver, DriverAction da) Registers the given driver with theDriverManager.static voidsetLoginTimeout(int seconds) Sets the maximum time in seconds that a driver will wait while attempting to connect to a database once the driver has been identified.static voidsetLogStream(PrintStream out) Deprecated.UsesetLogWriterstatic voidsetLogWriter(PrintWriter out) Sets the logging/tracingPrintWriterobject that is used by theDriverManagerand all drivers.
-
Method Details
-
getLogWriter
Retrieves the log writer. ThegetLogWriterandsetLogWritermethods should be used instead of theget/setlogStreammethods, which are deprecated.- Returns:
- a
java.io.PrintWriterobject - Since:
- 1.2
- See Also:
-
setLogWriter
Sets the logging/tracingPrintWriterobject that is used by theDriverManagerand all drivers.- Parameters:
out- the new logging/tracingPrintStreamobject;nullto disable logging and tracing- Since:
- 1.2
- See Also:
-
getConnection
Attempts to establish a connection to the given database URL. TheDriverManagerattempts to select an appropriate driver from the set of registered JDBC drivers.Note: If a property is specified as part of the
urland is also specified in thePropertiesobject, it is implementation-defined as to which value will take precedence. For maximum portability, an application should only specify a property once.- Parameters:
url- a database url of the formjdbc:subprotocol:subnameinfo- 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:
SQLException- if a database access error occurs or the url isnullSQLTimeoutException- when the driver has determined that the timeout value specified by thesetLoginTimeoutmethod has been exceeded and has at least tried to cancel the current database connection attempt
-
getConnection
public static Connection getConnection(String url, String user, String password) throws SQLException Attempts to establish a connection to the given database URL. TheDriverManagerattempts to select an appropriate driver from the set of registered JDBC drivers.Note: If the
userorpasswordproperty are also specified as part of theurl, it is implementation-defined as to which value will take precedence. For maximum portability, an application should only specify a property once.- Parameters:
url- a database url of the formjdbc:subprotocol:subnameuser- the database user on whose behalf the connection is being madepassword- the user's password- Returns:
- a connection to the URL
- Throws:
SQLException- if a database access error occurs or the url isnullSQLTimeoutException- when the driver has determined that the timeout value specified by thesetLoginTimeoutmethod has been exceeded and has at least tried to cancel the current database connection attempt
-
getConnection
Attempts to establish a connection to the given database URL. TheDriverManagerattempts to select an appropriate driver from the set of registered JDBC drivers.- Parameters:
url- a database url of the formjdbc:subprotocol:subname- Returns:
- a connection to the URL
- Throws:
SQLException- if a database access error occurs or the url isnullSQLTimeoutException- when the driver has determined that the timeout value specified by thesetLoginTimeoutmethod has been exceeded and has at least tried to cancel the current database connection attempt
-
getDriver
Attempts to locate a driver that understands the given URL. TheDriverManagerattempts to select an appropriate driver from the set of registered JDBC drivers.- Parameters:
url- a database URL of the formjdbc:subprotocol:subname- Returns:
- a
Driverobject representing a driver that can connect to the given URL - Throws:
SQLException- if a database access error occurs
-
registerDriver
Registers the given driver with theDriverManager. A newly-loaded driver class should call the methodregisterDriverto make itself known to theDriverManager. If the driver is currently registered, no action is taken.- Parameters:
driver- the new JDBC Driver that is to be registered with theDriverManager- Throws:
SQLException- if a database access error occursNullPointerException- ifdriveris null
-
registerDriver
Registers the given driver with theDriverManager. A newly-loaded driver class should call the methodregisterDriverto make itself known to theDriverManager. If the driver is currently registered, no action is taken.- Parameters:
driver- the new JDBC Driver that is to be registered with theDriverManagerda- theDriverActionimplementation to be used whenDriverManager#deregisterDriveris called- Throws:
SQLException- if a database access error occursNullPointerException- ifdriveris null- Since:
- 1.8
-
deregisterDriver
Removes the specified driver from theDriverManager's list of registered drivers.If a
nullvalue is specified for the driver to be removed, then no action is taken.If the specified driver is not found in the list of registered drivers, then no action is taken. If the driver was found, it will be removed from the list of registered drivers.
If a
DriverActioninstance was specified when the JDBC driver was registered, its deregister method will be called prior to the driver being removed from the list of registered drivers.- Parameters:
driver- the JDBC Driver to remove- Throws:
SQLException- if a database access error occurs
-
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
- See Also:
-
drivers
-
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 once the driver has been identified.- Parameters:
seconds- the login time limit in seconds; zero means there is no limit- See Also:
-
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:
-
setLogStream
Deprecated.UsesetLogWriterSets the logging/tracing PrintStream that is used by theDriverManagerand all drivers.- Parameters:
out- the new logging/tracing PrintStream; to disable, set tonull- See Also:
-
getLogStream
Deprecated.UsegetLogWriterRetrieves the logging/tracing PrintStream that is used by theDriverManagerand all drivers.- Returns:
- the logging/tracing PrintStream; if disabled, is
null - See Also:
-
println
Prints a message to the current JDBC log stream.- Parameters:
message- a log or tracing message
-
getLogWriter