Ready to get started?

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

 Download Now

Learn more:

BigCommerce Icon BigCommerce JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with BigCommerce Ecommerce Software

Connect to BigCommerce Data from a Connection Pool in JBoss



Integrate BigCommerce data into Java servlets: Use the Management Console in JBoss to install the BigCommerce JDBC Driver.

CData JDBC drivers can be configured in JBoss by following the standard procedure for connection pooling. This article details how to access BigCommerce data from a connection pool in JBoss applications. This article details how to use the JBoss Management Interface to configure the CData JDBC Driver for BigCommerce. You will then access BigCommerce data from a connection pool.

Create a JDBC Data Source for BigCommerce from the Management Console

Follow the steps below to add the driver JAR and define required connection properties.

  1. In the Runtime menu, select the Domain or Server menu, depending on whether you are deploying to a managed domain or to a stand-alone server, and click "Manage deployments" to open the Deployments page.
  2. Click Add. In the resulting wizard, add the JAR file and license for the driver, located in the lib subfolder of the installation directory. Finish the wizard with the defaults, select the driver, and click Enable.
  3. In the Configuration menu, click Subsystems -> Connector -> Datasources. This opens the JDBC Datasources page.
  4. Click Add and, in the resulting wizard, enter a name for the driver and the JNDI name. For example: java:jboss/root/jdbc/BigCommerce
  5. Select the driver that you added above.
  6. Enter the JDBC URL and the username and password. The syntax of the JDBC URL is jdbc:bigcommerce: followed by a semicolon-separated list of connection properties.

    BigCommerce authentication is based on the standard OAuth flow. To authenticate, you must initially create an app via the Big Commerce developer platform where you can obtain an OAuthClientId, OAuthClientSecret, and CallbackURL. These three parameters will be set as connection properties to your driver.

    Additionally, in order to connect to your BigCommerce Store, you will need your StoreId. To find your Store Id please follow these steps:

    1. Log in to your BigCommerce account.
    2. From the Home Page, select Advanced Settings > API Accounts.
    3. Click Create API Account.
    4. A text box named API Path will appear on your screen.
    5. Inside you can see a URL of the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
    6. As demonstrated above, your Store Id will be between the 'stores/' and '/v3' path paramters.
    7. Once you have retrieved your Store Id you can either click Cancel or proceed in creating an API Account in case you do not have one already.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.bigcommerce.jar

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

    A typical connection string is below:

    jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'InitiateOAuth=GETANDREFRESH
  7. Test the connection and finish the wizard. Select the BigCommerce data source and click Enable.

More JBoss Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more information, refer to the Data Source Management chapter in the JBoss EAP documentation.