This is an old revision of the document!


Development: JDBC Interface

Overview

The Omnidex JDBC Driver is a standard-compliant JDBC driver that provides Java access to Omnidex Environments. The Omnidex JDBC Driver is supported on Microsoft Windows and Linux operating systems.

The Omnidex JDBC Classes

The Omnidex JDBC class files are stored in a jar file named Omnidex.jar, which is located in the bin subdirectory of the Omnidex home directory on a Microsoft Windows computer (%OMNIDEX_HOME%/bin/Omnidex.jar), or the lib directory on a Linux computer ($OMNIDEX_HOME/lib/Omnidex.jar).

The Omnidex JDBC classes and the java.sql classes should be imported into the Java class file. The Omnidex JDBC driver should also be loaded and registered with java.sql.DriverManager.

JDBC classes require that you import java.sql into the Java application.

import java.sql.*;

The Omnidex JDBC driver requires that you load it with the java.sql.DriverManager.

Class.forName("omnidex.jdbc.OdxJDBCDriver");

Connecting to an Omnidex Environment

Connecting to an Omnidex Environment File in JDBC simply requires referencing the Omnidex connection string in the call to DriverManager.getConnection:

Connection conn = 
  DriverManager.getConnection( "jdbc:omnidex:[server1:7555]C:\\class\\simple.xml");

It is also possible to reference a File DSN in the call to DriverManager.getConnection. File DSN's are typically used with ODBC applications, but can be useful for externalizing the connection string. Consult the ODBC File DSN Syntax Specification for instructions to build a File Datasource.

Connection conn = 
  DriverManager.getConnection( "jdbc:omnidex:simple.dsn");

From the old docs:

Pass the connection url to the DriverManager class to obtain a connection.

OdxJDBCConnection conn = (OdxJDBCConnection)DriverManager.getConnection(
"jdbc:omnidex:c:\\odxtesting\\dsn\\odx_file_ordersffl.dsn");

Notice that the Connection object returned by the DriverManager is being cast to an OdxJDBCConnection object. This is because the DriverManager returns a java.sql.Connection, not an omnidex.jdbc.OdxJDBCConnection. All of the Omnidex JDBC Driver classes implement the java.sql classes and inherit all of the constructors, methods and properties. The Omnidex JDBC classes also contain some additional methods a properties specific to Omnidex.

Using the JDBC Interface

Connecting to an Omnidex enhanced database through the Omnidex JDBC driver is the same as connecting to any other database using any other JDBC driver, with two notable exceptions:

  • The Omnidex JDBC driver must be loaded and registered with java.sql.DriverManager.
  • The connection url must point to an Omnidex Generic data source.

The java.sql classes must be imported into the Java program along with any other desired Java packages. This is because the java.sql.DriverManager is used to register the Omnidex JDBC driver. Also, the Omnidex JDBC classes throw java.sql.SQLExceptions.

import java.sql.*;

The following code snippet will load the Omnidex JDBC driver and register it with the java.sql.DriverManager. This ensures that the Omnidex JDBC driver will be used for all subsequent connections.

Class.forName("omnidex.jdbc.OdxJDBCDriver");
// Pass the connection url to the DriverManager class to obtain a connection.
Connection conn = DriverManager.getConnection(
"jdbc:omnidex:c:\\odxtesting\\dsn\\odx_file_ordersffl.dsn");

All of the Omnidex JDBC Driver classes implement the java.sql classes and inherit all of the constructors, methods and properties. The Omnidex JDBC classes also contain some additional methods and properties specific to Omnidex.

Additional Resources

See also:

 
Back to top
dev/jdbc/home.1294865014.txt.gz ยท Last modified: 2016/06/28 22:38 (external edit)