Class DriverManager

java.lang.Object
java.sql.DriverManager
public classDriverManagerextendsObject
The basic service for managing a set of JDBC drivers.

NOTE: TheDataSource interface, provides another way to connect to a data source. The use of aDataSource object is the preferred means of connecting to a data source.

As part of its initialization, theDriverManager class will attempt to load available JDBC drivers by using:

  • Thejdbc.drivers system property which contains a colon separated list of fully qualified class names of JDBC drivers. Each driver is loaded using thesystem class loader:
    • jdbc.drivers=foo.bah.Driver:wombat.sql.Driver:bad.taste.ourDriver
  • Service providers of thejava.sql.Driver class, that are loaded via the service-provider loading mechanism.

Implementation Note:
DriverManager initialization 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 methodgetConnection is called, theDriverManager will 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 Details

    • getLogWriter

      public static PrintWriter getLogWriter()
      Retrieves the log writer. ThegetLogWriter andsetLogWriter methods should be used instead of theget/setlogStream methods, which are deprecated.
      Returns:
      ajava.io.PrintWriter object
      Since:
      1.2
      See Also:

    • setLogWriter

      public static void setLogWriter(PrintWriter out)
      Sets the logging/tracingPrintWriter object that is used by theDriverManager and all drivers.
      Parameters:
      out - the new logging/tracingPrintStream object;null to disable logging and tracing
      Since:
      1.2
      See Also:

    • getConnection

      public static Connection getConnection(String url,Properties info) throwsSQLException
      Attempts to establish a connection to the given database URL. TheDriverManager attempts to select an appropriate driver from the set of registered JDBC drivers.

      Note: If a property is specified as part of theurl and is also specified in theProperties object, 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 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:
      SQLException - if a database access error occurs or the url isnull
      SQLTimeoutException - when the driver has determined that the timeout value specified by thesetLoginTimeout method 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) throwsSQLException
      Attempts to establish a connection to the given database URL. TheDriverManager attempts to select an appropriate driver from the set of registered JDBC drivers.

      Note: If theuser orpassword property 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: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:
      SQLException - if a database access error occurs or the url isnull
      SQLTimeoutException - when the driver has determined that the timeout value specified by thesetLoginTimeout method has been exceeded and has at least tried to cancel the current database connection attempt

    • getConnection

      public static Connection getConnection(String url) throwsSQLException
      Attempts to establish a connection to the given database URL. TheDriverManager 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:
      SQLException - if a database access error occurs or the url isnull
      SQLTimeoutException - when the driver has determined that the timeout value specified by thesetLoginTimeout method has been exceeded and has at least tried to cancel the current database connection attempt

    • getDriver

      public static Driver getDriver(String url) throwsSQLException
      Attempts to locate a driver that understands the given URL. TheDriverManager attempts to select an appropriate driver from the set of registered JDBC drivers.
      Parameters:
      url - a database URL of the formjdbc:subprotocol:subname
      Returns:
      aDriver object representing a driver that can connect to the given URL
      Throws:
      SQLException - if a database access error occurs

    • registerDriver

      public static void registerDriver(Driver driver) throwsSQLException
      Registers the given driver with theDriverManager. A newly-loaded driver class should call the methodregisterDriver to 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 occurs
      NullPointerException - ifdriver is null

    • registerDriver

      public static void registerDriver(Driver driver,DriverAction da) throwsSQLException
      Registers the given driver with theDriverManager. A newly-loaded driver class should call the methodregisterDriver to 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
      da - theDriverAction implementation to be used whenDriverManager#deregisterDriver is called
      Throws:
      SQLException - if a database access error occurs
      NullPointerException - ifdriver is null
      Since:
      1.8

    • deregisterDriver

      public static void deregisterDriver(Driver driver) throwsSQLException
      Removes the specified driver from theDriverManager's list of registered drivers.

      If anull value 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 aDriverAction instance 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

      public static Enumeration<Driver> 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 usingd.getClass().getName()

      Returns:
      the list of JDBC Drivers loaded by the caller's class loader
      See Also:

    • drivers

      public static Stream<Driver> drivers()
      Retrieves a Stream with all of the currently loaded JDBC drivers to which the current caller has access.
      Returns:
      the stream of JDBC Drivers loaded by the caller's class loader
      Since:
      9

    • 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(since="1.2")public static void setLogStream(PrintStream out)
      Deprecated.
      UsesetLogWriter
      Sets the logging/tracing PrintStream that is used by theDriverManager and all drivers.
      Parameters:
      out - the new logging/tracing PrintStream; to disable, set tonull
      See Also:

    • getLogStream

      @Deprecated(since="1.2")public static PrintStream getLogStream()
      Deprecated.
      UsegetLogWriter
      Retrieves the logging/tracing PrintStream that is used by theDriverManager and all drivers.
      Returns:
      the logging/tracing PrintStream; if disabled, isnull
      See Also:

    • println

      public static void println(String message)
      Prints a message to the current JDBC log stream.
      Parameters:
      message - a log or tracing message