XDriver Interface Reference

is the interface that every driver class must implement. More...

import"XDriver.idl";

Inheritance diagram for XDriver:

Public Member Functions
XConnection	connect ([in]string url, [in]sequence< com::sun::star::beans::PropertyValue > info) raises (SQLException)
	attempts to make a database connection to the given URL. More...
boolean	acceptsURL ([in]string url) raises (SQLException)
	returns TRUE if the driver thinks that it can open a connection to the given URL. More...
sequence< DriverPropertyInfo >	getPropertyInfo ([in]string url, [in] sequence< com::sun::star::beans::PropertyValue > info) raises (SQLException)
	gets information about the possible properties for this driver. More...
long	getMajorVersion ()
	gets the driver's major version number. More...
long	getMinorVersion ()
	gets the driver's minor version number. More...
Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...
void	acquire ()
	increases the reference counter by one. More...
void	release ()
	decreases the reference counter by one. More...

Detailed 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

com::sun::star::sdbc::XDriverManager

com::sun::star::sdbc::XConnection

Member Function Documentation

acceptsURL()

boolean acceptsURL	(	[in] string	url	)
raises	(	SQLException
	)

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.

Parameters

url	is the URL of the database to which to connect.

Returns

TRUE if this driver can connect to the given URL.

Exceptions

SQLException

if a database access error occurs.

connect()

XConnection connect	(	[in] string	url,
		[in] sequence< com::sun::star::beans::PropertyValue >	info
	)
raises	(	SQLException
	)

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 com::sun::star::sdbc::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 in the property named JavaDriverClass, and a class path (a space-separated list of URLs) needed to locate that class can optionally be supplied in a property named JavaDriverClassPath. Possible property value names are when supported by the driver:

See also

com::sun::star::sdbc::ConnectionProperties

Parameters

url	is the URL of the database to which to connect.
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

com::sun::star::sdbc::ConnectionProperties

Returns

a Connection object that represents a connection to the URL

Exceptions

SQLException

if a database access error occurs

getMajorVersion()

long getMajorVersion

(

)

gets the driver's major version number.

Initially this should be 1.

Returns

this driver's major version number

getMinorVersion()

long getMinorVersion

(

)

gets the driver's minor version number.

Initially this should be 0.

Returns

this driver's minor version number.

getPropertyInfo()

sequence<DriverPropertyInfo> getPropertyInfo	(	[in] string	url,
		[in] sequence< com::sun::star::beans::PropertyValue >	info
	)
raises	(	SQLException
	)

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.

Parameters

url	is the URL of the database to which to connect.
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.

Exceptions

SQLException

if a database access error occurs.

---

The documentation for this interface was generated from the following file:

• com/sun/star/sdbc/XDriver.idl