Configuration Specifics for JDBC Drivers

Enterprise Server is designed to support connectivity to any database management system by using a corresponding JDBC driver.

• JDBC Drivers, Full Support

• JDBC Drivers, Limited Support

JDBC Drivers, Full Support

The following JDBC driver and database combinations have been tested and are supported for container-managed persistence:

• Sun GlassFish JDBC Driver for DB2 Databases

• Sun GlassFish JDBC Driver for Oracle 8.1.7 and 9.x Databases

• Sun GlassFish JDBC Driver for Microsoft SQL Server Databases

• Sun GlassFish JDBC Driver for Sybase Databases

• IBM DB2 Type 2 Driver

• Java DB/Derby Type 4 Driver

• JConnect Type 4 Driver for Sybase ASE 12.5 Databases

• MM MySQL Type 4 Driver (Non-XA)

To see the most current list of supported JDBC drivers, refer to the Sun GlassFish Enterprise Server v3 Prelude Release Notes.

Sun GlassFish JDBC Driver for DB2 Databases

The JAR files for this driver are smbase.jar, smdb2.jar, and smutil.jar. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: DB2

• DataSource Classname: com.sun.sql.jdbcx.db2.DB2DataSource

• Properties:

  • serverName – Specify the host name or IP address of the database server.

  • portNumber – Specify the port number of the database server.

  • databaseName – Set as appropriate.

  • user – Set as appropriate.

  • password – Set as appropriate.

• URL: jdbc:sun:db2://serverName:portNumber;databaseName=databaseName

Sun GlassFish JDBC Driver for Oracle 8.1.7 and 9.x Databases

The JAR files for this driver are smbase.jar, smoracle.jar, and smutil.jar. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Oracle

• DataSource Classname: com.sun.sql.jdbcx.oracle.OracleDataSource

• Properties:

  • serverName – Specify the host name or IP address of the database server.

  • portNumber – Specify the port number of the database server.

  • SID – Set as appropriate.

  • user – Set as appropriate.

  • password – Set as appropriate.

• URL: jdbc:sun:oracle://serverName[:portNumber][;SID=databaseName]

Sun GlassFish JDBC Driver for Microsoft SQL Server Databases

The JAR files for this driver are smbase.jar, smsqlserver.jar, and smutil.jar. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Microsoft SQL Server

• DataSource Classname: com.sun.sql.jdbcx.sqlserver.SQLServerDataSource

• Properties:

  • serverName – Specify the host name or IP address and the port of the database server.

  • portNumber – Specify the port number of the database server.

  • user – Set as appropriate.

  • password – Set as appropriate.

  • selectMethod – Set to cursor.

• URL: jdbc:sun:sqlserver://serverName[:portNumber]

Sun GlassFish JDBC Driver for Sybase Databases

The JAR files for this driver are smbase.jar, smsybase.jar, and smutil.jar. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Sybase

• DataSource Classname: com.sun.sql.jdbcx.sybase.SybaseDataSource

• Properties:

  • serverName – Specify the host name or IP address of the database server.

  • portNumber – Specify the port number of the database server.

  • databaseName – Set as appropriate. This is optional.

  • user – Set as appropriate.

  • password – Set as appropriate.

• URL: jdbc:sun:sybase://serverName[:portNumber]

IBM DB2 Type 2 Driver

The JAR files for the DB2 driver are db2jcc.jar, db2jcc_license_cu.jar, and db2java.zip. Set your environment variables . For example:

LD_LIBRARY_PATH=/usr/db2user/sqllib/lib:${j2ee.home}/lib
DB2DIR=/opt/IBM/db2/V8.2
DB2INSTANCE=db2user
INSTHOME=/usr/db2user
VWSPATH=/usr/db2user/sqllib
THREADS_FLAG=native

Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: DB2

• DataSource Classname: com.ibm.db2.jcc.DB2SimpleDataSource

• Properties:

  • databaseName - Set as appropriate.

  • user – Set as appropriate.

  • password – Set as appropriate.

  • driverType – Set to 2.

  • deferPrepares – Set to false.

Java DB/Derby Type 4 Driver

The JAR file for the Java DB/Derby driver is derbyclient.jar. (Java DB is based upon Apache Derby.) Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Java DB/Derby

• DataSource Classname: Specify one of the following:

  org.apache.derby.jdbc.ClientDataSource
  org.apache.derby.jdbc.ClientXADataSource

• Properties:

  • serverName – Specify the host name or IP address of the database server.

  • portNumber – Specify the port number of the database server if it is different from the default.

  • databaseName – Specify the name of the database.

  • user - Specify the database user.

    This is only necessary if Derby is configured to use authentication. Derby does not use authentication by default. When the user is provided, it is the name of the schema where the tables reside.

  • password – Specify the database password.

    This is only necessary if Java DB/Derby is configured to use authentication.

• URL: jdbc:derby://serverName:portNumber/databaseName;create=true

  Include the ;create=true part only if you want the database to be created if it does not exist.

JConnect Type 4 Driver for Sybase ASE 12.5 Databases

The JAR file for the Sybase driver is jconn2.jar. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Sybase

• DataSource Classname: Specify one of the following:

  com.sybase.jdbc2.jdbc.SybDataSource
  com.sybase.jdbc2.jdbc.SybXADataSource

• Properties:

  • serverName – Specify the host name or IP address of the database server.

  • portNumber – Specify the port number of the database server.

  • databaseName – Set as appropriate. Do not specify the complete URL, only the database name.

  • user – Set as appropriate.

  • password – Set as appropriate.

  • BE_AS_JDBC_COMPLIANT_AS_POSSIBLE – Set to true.

  • FAKE_METADATA – Set to true.

MM MySQL Type 4 Driver (Non-XA)

The JAR file for the MySQL driver is mysql-connector-java-version-bin-g.jar, for example, mysql-connector-java-3.1.12-bin-g.jar. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Microsoft SQL Server

• DataSource Classname: Specify one of the following:

  com.mysql.jdbc.jdbc2.optional.MysqlDataSource

• Properties:

  • serverName – Specify the host name or IP address of the database server.

  • portNumber – Specify the port number of the database server.

  • databaseName – Set as appropriate.

  • user – Set as appropriate.

  • password – Set as appropriate.

  • URL – If you are using global transactions, you can set this property instead of serverName, port, and databaseName.

    The MM MySQL Type 4 driver doesn’t provide a method to set the required relaxAutoCommit property, so you must set it indirectly by setting the URL property:

    jdbc:mysql://host:port/database?relaxAutoCommit="true"

JDBC Drivers, Limited Support

The following JDBC drivers can also be used with Enterprise Server, but have not been fully tested. Although Sun offers no product support for these drivers, Sun does offer limited support for the use of these drivers with Enterprise Server:

• CloudScape 5.1 Type 4 Driver

• IBM Informix Type 4 Driver

• Inet Oraxo JDBC Driver for Oracle 8.1.7 and 9.x Databases

• Inet Merlia JDBC Driver for Microsoft SQL Server Databases

• Inet Sybelux JDBC Driver for Sybase Databases

• MM MySQL Type 4 Driver (XA Only)

• OCI Oracle Type 2 Driver for Oracle 8.1.7 and 9.x Databases

• Oracle Thin Type 4 Driver for Oracle 8.1.7 and 9.x Databases

---

Note –

An Oracle database user running the capture-schema command needs ANALYZE ANY TABLE privileges if that user does not own the schema. These privileges are granted to the user by the database administrator. For information about capture-schema, see Sun GlassFish Enterprise Server v3 Prelude Reference Manual.

---

CloudScape 5.1 Type 4 Driver

The JAR files for the CloudScape driver are db2j.jar, db2jtools.jar, db2jcview.jar, jh.jar, db2jcc.jar, and db2jnet.jar. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Cloudscape

• DataSource Classname: com.ibm.db2.jcc.DB2DataSource

• Properties:

  • user – Set as appropriate.

  • password – Set as appropriate.

  • databaseName – Set as appropriate.

IBM Informix Type 4 Driver

Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Informix

• DataSource Classname: Specify one of the following:

  com.informix.jdbcx.IfxDataSource
  com.informix.jdbcx.IfxXADataSource

• Properties:

  • serverName – Specify the Informix database server name.

  • portNumber – Specify the port number of the database server.

  • databaseName – Set as appropriate. This is optional.

  • user – Set as appropriate.

  • password – Set as appropriate.

  • IfxIFXHost – Specify the host name or IP address of the database server.

Inet Oraxo JDBC Driver for Oracle 8.1.7 and 9.x Databases

The JAR file for the Inet Oracle driver is Oranxo.jar. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Oracle

• DataSource Classname: com.inet.ora.OraDataSource

• Properties:

  • serverName – Specify the host name or IP address of the database server.

  • portNumber – Specify the port number of the database server.

  • user – Specify the database user.

  • password – Specify the database password.

  • serviceName – Specify the URL of the database. The syntax is as follows:

    jdbc:inetora:server:port:dbname
    

    For example:

    jdbc:inetora:localhost:1521:payrolldb

    In this example,localhost is the name of the host running the Oracle server, 1521 is the Oracle server’s port number, and payrolldb is the SID of the database. For more information about the syntax of the database URL, see the Oracle documentation.

  • streamstolob - If the size of BLOB or CLOB data types exceeds 4 KB and this driver is used for CMP, this property must be set to true.

  • xa-driver-does-not-support-non-tx-operations - Set to the value true. Only needed if both non-XA and XA connections are retrieved from the same connection pool. Might degrade performance.

    As an alternative to setting this property, you can create two connection pools, one for non-XA connections and one for XA connections.

Inet Merlia JDBC Driver for Microsoft SQL Server Databases

The JAR file for the Inet Microsoft SQL Server driver is Merlia.jar. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Microsoft SQL Server

• DataSource Classname: com.inet.tds.TdsDataSource

• Properties:

  • serverName – Specify the host name or IP address and the port of the database server.

  • portNumber – Specify the port number of the database server.

  • user – Set as appropriate.

  • password – Set as appropriate.

Inet Sybelux JDBC Driver for Sybase Databases

The JAR file for the Inet Sybase driver is Sybelux.jar. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Sybase

• DataSource Classname: com.inet.syb.SybDataSource

• Properties:

  • serverName – Specify the host name or IP address of the database server.

  • portNumber – Specify the port number of the database server.

  • databaseName – Set as appropriate. Do not specify the complete URL, only the database name.

  • user – Set as appropriate.

  • password – Set as appropriate.

MM MySQL Type 4 Driver (XA Only)

The JAR file for the MySQL^TM driver is mysql-connector-java-version-bin-g.jar, for example, mysql-connector-java-3.1.12-bin-g.jar. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Microsoft SQL Server

• DataSource Classname:

  com.mysql.jdbc.jdbc2.optional.MysqlXADataSource

• Properties:

  • serverName – Specify the host name or IP address of the database server.

  • portNumber – Specify the port number of the database server.

  • databaseName – Set as appropriate.

  • user – Set as appropriate.

  • password – Set as appropriate.

  • URL – If you are using global transactions, you can set this property instead of serverName, port, and databaseName.

    The MM MySQL Type 4 driver doesn’t provide a method to set the required relaxAutoCommit property, so you must set it indirectly by setting the URL property:

    jdbc:mysql://host:port/database?relaxAutoCommit="true"

OCI Oracle Type 2 Driver for Oracle 8.1.7 and 9.x Databases

The JAR file for the OCI Oracle driver is ojdbc14.jar. Make sure that the shared library is available through LD_LIBRARY_PATH and that the ORACLE_HOME property is set. Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Oracle

• DataSource Classname: Specify one of the following:

  oracle.jdbc.pool.OracleDataSource
  oracle.jdbc.xa.client.OracleXADataSource

• Properties:

  • user – Set as appropriate.

  • password – Set as appropriate.

  • URL – Specify the complete database URL using the following syntax:

    jdbc:oracle:oci:[user/password]@host[:port]/service
    

    For example:

    jdbc:oracle:oci:@localhost:1521:customer_db

  • xa-driver-does-not-support-non-tx-operations - Set to the value true. Only needed if both non-XA and XA connections are retrieved from the same connection pool. Might degrade performance.

    As an alternative to setting this property, you can create two connection pools, one for non-XA connections and one for XA connections.

Oracle Thin Type 4 Driver for Oracle 8.1.7 and 9.x Databases

The JAR file for the Oracle driver is ojdbc14.jar.

---

Note –

When using this driver, keep in mind that you cannot insert more than 2000 bytes of data into a column. To circumvent this problem, use the OCI driver (JDBC type 2).

---

Configure the connection pool using the following settings:

• Name: Use this name when you configure the JDBC resource later.

• Resource Type: Specify the appropriate value.

• Database Vendor: Oracle

• DataSource Classname: Specify one of the following:

  oracle.jdbc.pool.OracleDataSource
  oracle.jdbc.xa.client.OracleXADataSource

• Properties:

  • user – Set as appropriate.

  • password – Set as appropriate.

  • URL – Specify the complete database URL using the following syntax:

    jdbc:oracle:thin:[user/password]@host[:port]/service
    

    For example:

    jdbc:oracle:thin:@localhost:1521:customer_db

  • xa-driver-does-not-support-non-tx-operations - Set to the value true. Optional: only needed if both non-XA and XA connections are retrieved from the same connection pool. Might degrade performance.

    As an alternative to setting this property, you can create two connection pools, one for non-XA connections and one for XA connections.

  ---

  Note –

  For the Oracle thin driver, the XAResource.recover method repeatedly returns the same set of in-doubt Xids regardless of the input flag. According to the XA specifications, the Transaction Manager initially calls this method with TMSTARTSCAN and then with TMNOFLAGS repeatedly until no Xids are returned. The XAResource.commit method also has some issues.

  To disable this Enterprise Server workaround, the oracle-xa-recovery-workaround property value must be set to false.

  ---