Connecting Through a DataSource

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 >

Data sources in the database context of OpenOffice.org API offer two methods to establish a connection, a non-interactive and an interactive procedure. Use the com.sun.star.sdbc.XDataSource interface to connect. It consists of:

 // establish connection
 com::sun::star::sdbc::XConnection getConnection( 
                 [in] string user, [in] string password)
 
 // timeout for connection failure
 void setLoginTimeout( [in] long seconds)
 long getLoginTimeout()

If a database does not support logins, pass empty strings to getConnection(). For instance, use getConnection() against dBase data sources like Bibliography:

 XNameAccess xNameAccess = (XNameAccess)UnoRuntime.queryInterface(
     XNameAccess.class, _rMSF.createInstance("com.sun.star.sdb.DatabaseContext"));
 
 // we use the Bibliography data source
 XDataSource xDS = (XDataSource)UnoRuntime.queryInterface(
     XDataSource.class, xNameAccess.getByName("Bibliography"));
 
 // simple way to connect
 XConnection xConnection = xDS.getConnection("", "");

However if the database expects a login procedure, hard code the user and password, although this is not advisable. Data sources support an advanced login concept. Their interface com.sun.star.sdb.XCompletedConnection starts an interactive login, if necessary:

 com::sun::star::sdbc::XConnection connectWithCompletion(
                 [in] com::sun::star::task::XInteractionHandler handler)

When you call connectWithCompletion(), OpenOffice.org API shows the common login dialog to the user if the data source property IsPasswordRequired is true. The login dialog is part of the com.sun.star.sdb.InteractionHandler provided by the global service factory.

 // logs into a database and returns a connection
 // expects a reference to the global service manager
 com.sun.star.sdbc.XConnection logon(XMultiServiceFactory _rMSF) throws com.sun.star.uno.Exception {
 
     // retrieve the DatabaseContext and get its com.sun.star.container.XNameAccess interface
     XNameAccess xNameAccess = (XNameAccess)UnoRuntime.queryInterface(
         XNameAccess.class, _rMSF.createInstance("com.sun.star.sdb.DatabaseContext"));
     
     // get an Adabas D data source Ada01 generated in the GUI
     Object dataSource = xNameAccess.getByName("Ada01");
     
     // create a com.sun.star.sdb.InteractionHandler and get its XInteractionHandler interface
     Object interactionHandler = _rMSF.createInstance("com.sun.star.sdb.InteractionHandler");
     XInteractionHandler xInteractionHandler = (XInteractionHandler)UnoRuntime.queryInterface(
         XInteractionHandler.class, interactionHandler);
     
     // query for the XCompletedConnection interface of the data source
     XCompletedConnection xCompletedConnection = (XCompletedConnection)UnoRuntime.queryInterface(
         XCompletedConnection.class, dataSource);
     
     // connect with interactive login
     XConnection xConnection = xCompletedConnection.connectWithCompletion(xInteractionHandler);
     
     return XConnection;
 }

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