Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: sdbc ::
interface XDriver
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XDriver
Description is the interface that every driver class must implement. Each driver should supply a service 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 object should be small and standalone so that the Driver object can be loaded and queried without bringing in vast quantities of supporting code. See also XDriverManager See also XConnection

Methods' Summary
connect | 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 driver manager is asked to connect to a given URL it passes the URL to each loaded driver in turn.
acceptsURL | returns true if 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.
getPropertyInfo | gets information about the possible properties for this driver.
getMajorVersion | gets the driver's major version number. Initially this should be 1.
getMinorVersion | gets the driver's minor version number. Initially this should be 0.

Methods' Details
connect
XConnection connect( | [in] string [in] sequence< ::com::sun::star::beans::PropertyValue > raises( | url, info ) SQLException );
Description 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 driver manager is asked to connect to a given URL it passes the URL to each loaded driver in turn. The driver should raise a SQLException if it is the right driver to connect to the given URL, but has trouble connecting to the database. The info 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. For a JDBC driver also the java class must be supplied. The property is named JavaDriverClass. Possible property value names are when supported by the driver: See also ConnectionProperties Parameter url is the URL of the database to which to connect. Parameter info a list of arbitrary string tag/value pairs as connection arguments. Normally at least a "user" and "password" property should be included. See also ConnectionProperties Returns a Connection object that represents a connection to the URL Throws SQLException if a database access error occurs
acceptsURL
boolean acceptsURL( | [in] string raises( | url ) SQLException );
Description returns true if 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. Parameter url is the URL of the database to which to connect. Returns true if this driver can connect to the given URL. Throws SQLException if a database access error occurs.
getPropertyInfo
sequence< DriverPropertyInfo > getPropertyInfo( | [in] string [in] sequence< ::com::sun::star::beans::PropertyValue > raises( | url, info ) SQLException );
Description 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 getPropertyInfo. Parameter url is the URL of the database to which to connect. Parameter info is 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
long getMajorVersion(); |  |
Description gets the driver's major version number. Initially this should be 1. Returns this driver's major version number
getMinorVersion
long getMinorVersion(); |  |
Description gets the driver's minor version number. Initially this should be 0. Returns this driver's minor version number.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.