Connect to Carbone from a Connection Pool in WebLogic

The CData JDBC Driver for Carbone enables you to follow standard procedures to integrate Carbone data into Java Web applications. This article shows how to deploy the CData JDBC Driver for Carbone 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.api.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.api.jar;%PRE_CLASSPATH%

After making these changes, restart the server.

Create a JDBC Data Source for Carbone

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, apijdbc.
   • JNDI Name: Enter the path the JDBC data source will be bound to; for example, jdbc/API.

   • 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.api.APIDriver.

   • URL: Enter the JDBC URL. A typical JDBC URL is below:

     jdbc:api:Profile=C:\profiles\Carbone.apip;AuthScheme=APIKey;APIKey=your_api_key;

     Start by setting the Profile connection property to the location of the Carbone Profile on disk (e.g. C:\profiles\Carbone.apip). Next, set the ProfileSettings connection property to the connection string for Carbone (see below).

     Carbone API Profile Settings

     Carbone uses API key authentication via a Bearer token in the Authorization header. To obtain an API key:

     1. Log in to your Carbone account at https://account.carbone.io
     2. Copy the API key shown on the account home page

     After obtaining your API key, set the following connection properties:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Carbone API key (Bearer token).
     • CarboneVersion: (Optional) The major version of the Carbone API to target via the carbone-version request header. Defaults to 5. Accepted values: 5, 4, 3, staging.

     Built-in Connection String Designer

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

     
     java -jar cdata.jdbc.api.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 Carbone 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.