Ready to get started?

Learn more about the CData JDBC Driver for IBM Cloud Object Storage or download a free trial:

Download Now

Connect to IBM Cloud Object Storage from a Connection Pool in WebLogic

Use the CData JDBC Driver for IBM Cloud Object Storage to connect to IBM Cloud Object Storage data from Web applications running on WebLogic.

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

After making these changes, restart the server.

Create a JDBC Data Source for IBM Cloud Object Storage

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, ibmcloudobjectstoragejdbc.
    • JNDI Name: Enter the path the JDBC data source will be bound to; for example, jdbc/IBMCloudObjectStorage.
    • 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.ibmcloudobjectstorage.IBMCloudObjectStorageDriver.
    • URL: Enter the JDBC URL. A typical JDBC URL is below:

      jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;

      Register a New Instance of Cloud Object Storage

      If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:

      1. Log in to your IBM Cloud account.
      2. Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.

      Connecting using OAuth Authentication

      There are certain connection properties you need to set before you can connect. You can obtain these as follows:

      API Key

      To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:

      1. Log in to your IBM Cloud account.
      2. Navigate to the Platform API Keys page.
      3. On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
      4. In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.

      Cloud Object Storage CRN

      If you have multiple accounts, you will need to specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:

      • Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
      • Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.

      Connecting to Data

      You can now set the following to connect to data:

      • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
      • ApiKey: Set this to your API key which was noted during setup.
      • CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.

      When you connect, the connector completes the OAuth process.

      1. Extracts the access token and authenticates requests.
      2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.ibmcloudobjectstorage.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 IBM Cloud Object Storage 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.