Connect to Webflow from a Connection Pool in WebLogic

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

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\Webflow.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

     Authentication

     Webflow uses OAuth 2.0 authentication to ensure secure access to sites, CMS collections, e-commerce data, and other resources. This authentication method allows you to securely connect to your Webflow workspace and manage resources with proper authorization.

     OAuth 2.0 Setup and Configuration

     Step 1: Create a Webflow OAuth Application

     To set up OAuth authentication:

     1. Visit the Webflow Developer Portal
     2. Navigate to "Apps & Integrations" in your Webflow account
     3. Click "Register an App" to create a new OAuth application
     4. Configure the application name, description, and redirect URI (CallbackURL)
     5. Copy the Client ID and Client Secret for use in your connection

     Required Connection Properties

     • AuthScheme: Set this to OAuth (required)
     • OAuthClientId: Client ID from your Webflow OAuth application (required)
     • OAuthClientSecret: Client secret from your Webflow OAuth application (required)
     • CallbackURL: Redirect URI specified in your OAuth application (required)
     • InitiateOAuth: Set to GETANDREFRESH for automatic token management (recommended)

     Required OAuth Scopes

     The Webflow API Profile requires the following OAuth scopes:

     • sites:read - Read access to site information and configuration
     • pages:read - Read access to site pages
     • cms:read - Read access to CMS collections and items
     • forms:read - Read access to forms and form submissions
     • assets:read - Read access to media assets and folders
     • ecommerce:read - Read access to products, orders, and inventory
     • authorized_user:read - Read access to the authorized user

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Webflow 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 Webflow 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.