Ready to get started?

Download a free trial of the AlloyDB Driver to get started:

 Download Now

Learn more:

AlloyDB Icon AlloyDB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with AlloyDB.

Connect to AlloyDB from a Connection Pool in WebLogic



Use the CData JDBC Driver for AlloyDB to connect to AlloyDB data from Web applications running on WebLogic.

The CData JDBC Driver for AlloyDB enables you to follow standard procedures to integrate AlloyDB data into Java Web applications. This article shows how to deploy the CData JDBC Driver for AlloyDB in WebLogic Server.

Deploy the JDBC Driver in WebLogic Server

To deploy the driver, add the driver JAR to your classpath. The .lic file must be located in the same folder as the JAR. These files are located in the lib subfolder of the installation directory.

If you want to add the driver to all domains, prepend the path to the JAR to the WEBLOGIC_CLASSPATH environment variable in WL_HOME\common\bin\commEnv.cmd/sh. This script is located in WL_HOME\common\bin\. For example:

set WEBLOGIC_CLASSPATH=your-installation-directory\lib\cdata.jdbc.alloydb.jar;%WEBLOGIC_CLASSPATH%

In WebLogic 12.2.1 if you want to add the driver to a specific domain, you can simply place the driver JAR and .lic file into DOMAIN_HOME\lib; for example, ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib. These files will be added to the server classpath at startup.

Earlier versions require that you manually add the driver to the classpath: Prepend the following to the PRE_CLASSPATH environment variable in setDomainEnv.cmd/sh. This script is located in the bin subfolder of the folder for that domain.

set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.alloydb.jar;%PRE_CLASSPATH%

After making these changes, restart the server.

Create a JDBC Data Source for AlloyDB

After deploying the driver, log into the WebLogic Administration Console and create the connection.

  1. In the Domain Structure tree, click Services -> Data Sources -> New -> Generic Data Source.
  2. On the JDBC Data Source Properties page, enter the following information:
    • Name: Enter a user-friendly name; for example, alloydbjdbc.
    • JNDI Name: Enter the path the JDBC data source will be bound to; for example, jdbc/AlloyDB.
    • Database Type: Select Other.

  3. Click Next to use the default options. On the last page, enter the following information and click Test Configuration:

    • Driver Class Name: Enter the driver class, cdata.jdbc.alloydb.AlloyDBDriver.
    • URL: Enter the JDBC URL. A typical JDBC URL is below:

      jdbc:alloydb:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432

      The following connection properties are usually required in order to connect to AlloyDB.

      • Server: The host name or IP of the server hosting the AlloyDB database.
      • User: The user which will be used to authenticate with the AlloyDB server.
      • Password: The password which will be used to authenticate with the AlloyDB server.

      You can also optionally set the following:

      • Database: The database to connect to when connecting to the AlloyDB Server. If this is not set, the user's default database will be used.
      • Port: The port of the server hosting the AlloyDB database. This property is set to 5432 by default.

      Authenticating with Standard Authentication

      Standard authentication (using the user/password combination supplied earlier) is the default form of authentication.

      No further action is required to leverage Standard Authentication to connect.

      Authenticating with pg_hba.conf Auth Schemes

      There are additional methods of authentication available which must be enabled in the pg_hba.conf file on the AlloyDB server.

      Find instructions about authentication setup on the AlloyDB Server here.

      Authenticating with MD5 Authentication

      This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to md5.

      Authenticating with SASL Authentication

      This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to scram-sha-256.

      Authenticating with Kerberos

      The authentication with Kerberos is initiated by AlloyDB Server when the ∏ is trying to connect to it. You should set up Kerberos on the AlloyDB Server to activate this authentication method. Once you have Kerberos authentication set up on the AlloyDB Server, see the Kerberos section of the help documentation for details on how to authenticate with Kerberos.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the AlloyDB JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.alloydb.jar

      Fill in the connection properties and copy the connection string to the clipboard.

    • Database User Name: Enter the username, if not specified in the JDBC URL.
    • Password: Enter the password, if not specified in the JDBC URL.

After selecting the server where you want to deploy the JDBC data source, you can now connect to AlloyDB data.

More WebLogic Integration

The steps above show how configure the driver in a simple connection pooling scenario. For more use cases and information, see the JDBC sections in the WebLogic Data Sources chapter of the Oracle Fusion Middleware documentation.