Connecting Using the DriverManager and a Database URL

Apache OpenOffice Developer's Guide

Database Access

< Previous Section

Next Section >

• Architecture
• Example: Querying the Bibliography Database

• Data Sources in Apache OpenOffice API

• DataSources

• The DataSource Service
• Queries

• Adding and Editing Predefined Queries
• Runtime Settings For Predefined Queries
• The SingleSelectQueryComposer
• The SQLQueryComposer

• Forms and Reports
• Document Links
• Tables and Columns

• Connections

• Connecting Through a DataSource
• Connecting Using the DriverManager and a Database URL
• Connecting Through a Specific Driver
• Driver Specifics

• The SDBC Driver for JDBC
• The SDBC Driver for ODBC
• The SDBC Driver for Adabas D
• The SDBC Driver for ADO
• The SDBC Driver for dBase
• The SDBC Driver for Flat File Formats
• The SDBC Driver for Apache OpenOffice Calc Files
• The SDBC Driver for address books
• The SDBC Driver for embedded HSQL databases

• Connection Pooling
• Piggyback Connections

• Manipulating the Data

• The RowSet Service

• Usage
• Events and Other Notifications
• Clones of the RowSet Service

• Statements

• Creating Statements
• Inserting and Updating Data
• Getting Data from a Table

• Result Sets

• Retrieving Values from Result Sets
• Moving the Result Set Cursor
• Using the getXXX Methods
• Scrollable Result Sets
• Modifiable Result Sets
• Update
• Insert
• Delete
• Seeing Changes in Result Sets

• ResultSetMetaData
• Using Prepared Statements
• PreparedStatement From DataSource Queries

• Database Design

• Using DDL to Change the Database Design
• Using SDBCX to Access the Database Design

• Catalog Service
• Table Service
• Column Service
• Index Service
• Key Service
• View Service
• Group Service
• User Service
• The Descriptor Pattern
• Adding an Index
• Creating a User
• Adding a Group

• Using DBMS Features

• Stored Procedures

• Writing Database Drivers

• SDBC Driver
• Driver Service
• Connection Service
• XDatabaseMetaData Interface
• Statements
• Support Scalar Functions

• Open Group CLI Numeric Functions
• Open Group CLI String Functions
• Open Group CLI Time and Date Functions
• Open Group CLI System Functions
• Open Group CLI Conversion Functions

• Handling Unsupported Functionality
• Extending Database Drivers

< Previous Page

Next Page >

The database context and establishing connections to a database even if there is no data source for it in OpenOffice.org API can be avoided.

To create a connection ask the driver manager for it. The com.sun.star.sdbc.DriverManager manages database drivers. The methods of its interface com.sun.star.sdbc.XDriverManager are used to connect to a database using a database URL:

 // establish connection
 com::sun::star::sdbc::XConnection getConnection( [in] string url)
 com::sun::star::sdbc::XConnection getConnectionWithInfo( [in] string url, 
         [in] sequence < com::sun::star::beans::PropertyValue > info)
 
 // timeout for connection failure
 void setLoginTimeout( [in] long seconds)
 long getLoginTimeout()

Additionally, the driver manager enumerates all available drivers, and is used to register and deregister drivers. A URL that identifies a driver and contains information about the database to connect to must be known. The DriverManager chooses the first registered driver that accepts this URL. The following line of code illustrates it generally:

 Connection xConnection = DriverManager.getConnection(url);

The structure of the URL consists of a protocol name, followed by the driver specific sub-protocol. The data source administration dialog shows the latest supported protocols. Some protocols are platform dependent. For example, ADO is only supported on Windows.

The URLs and conditions for the various drivers are explained in section Driver Specifics below.

Frequently a connection needs additional information, such as a user name, password or character set. Use the method getConnectionWithInfo() to provide this information. The method getConnectionWithInfo() takes a sequence of com.sun.star.beans.PropertyValue structs. Usually user and password are supported. For other connection info properties, refer to the section Driver Specifics.

 // create the DriverManager
 Object driverManager = xMultiServiceFactory.createInstance("com.sun.star.sdbc.DriverManager");
 
 // query for the interface XDriverManager
 com.sun.star.sdbc.XDriverManager xDriverManager;
 
 xDriverManager = (XDriverManager)UnoRuntime.queryInterface(
     XDriverManager.class, driverManager);
 
 if (xDriverManager != null) {
     // first create the database URL
     String adabasURL = "sdbc:adabas::MYDB0";
   
     // create the necessary sequence of PropertyValue structs for user and password
     com.sun.star.beans.PropertyValue [] adabasProps = new com.sun.star.beans.PropertyValue[] { 
         new com.sun.star.beans.PropertyValue("user", 0, "Scott",
             com.sun.star.beans.PropertyState.DIRECT_VALUE),
         new com.sun.star.beans.PropertyValue("password", 0, "huutsch",
             com.sun.star.beans.PropertyState.DIRECT_VALUE)
         };
 
     // now create a connection to Adabas
     XConnection xConnection = xDriverManager.getConnectionWithInfo(adabasURL, adabasProps);
     
     if (adabasConnection != null) {
         System.out.println("Connection was created!");
     
         // now we dispose the connection to close it
         XComponent xComponent = (XComponent)UnoRuntime.queryInterface(
             XComponent.class, xConnection );
     
         if (xComponent != null) {
             // connection must be disposed to avoid memory leaks
             xComponent.dispose();
             System.out.println("Connection disposed!");
         }
     } else {
         System.out.println("Connection could not be created!");
     }
 }

Content on this page is licensed under the Public Documentation License (PDL).