Ready to get started?

Download a free trial of the QuickBooks Online Driver to get started:

 Download Now

Learn more:

QuickBooks Online Icon QuickBooks Online JDBC Driver

Complete read-write access to QuickBooks Online enables developers to search (Customers, Transactions, Invoices, Sales Receipts, etc.), update items, edit customers, and more, from any Java/J2EE application.

Configure the CData JDBC Driver for QuickBooks Online in a Connection Pool in Tomcat



Connect to QuickBooks Online data from a connection pool in Tomcat.

The CData JDBC Drivers support standard JDBC interfaces to integrate with Web applications running on the JVM. This article details how to connect to QuickBooks Online data from a connection pool in Tomcat.

Connect to QuickBooks Online Data through a Connection Pool in Tomcat

  1. Copy the CData JAR and CData .lic file to $CATALINA_HOME/lib. The CData JAR is located in the lib subfolder of the installation directory.
  2. Add a definition of the resource to the context. Specify the JDBC URL here.

    QuickBooks Online uses the OAuth authentication standard. OAuth requires the authenticating user to log in through the browser. To authenticate using OAuth, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL or you can obtain your own by registering an app with Intuit. Additionally, if you want to connect to sandbox data, set UseSandbox to true.

    See the Getting Started chapter of the help documentation for a guide to using OAuth.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.quickbooksonline.jar

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

    You can see the JDBC URL specified in the resource definition below.

    <Resource name="jdbc/quickbooksonline" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.quickbooksonline.QuickBooksOnlineDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:quickbooksonline:InitiateOAuth=GETANDREFRESH" maxActive="20" maxIdle="10" maxWait="-1" />

    To allow a single application to access QuickBooks Online data, add the code above to the context.xml in the application's META-INF directory.

    For a shared resource configuration, add the code above to the context.xml located in $CATALINA_BASE/conf. A shared resource configuration provides connectivity to QuickBooks Online for all applications.

  3. Add a reference to the resource to the web.xml for the application. QuickBooks Online data JSP jdbc/QuickBooksOnline javax.sql.DataSource Container
  4. Initialize connections from the connection pool: Context initContext = new InitialContext(); Context envContext = (Context)initContext.lookup("java:/comp/env"); DataSource ds = (DataSource)envContext.lookup("jdbc/QuickBooksOnline"); Connection conn = ds.getConnection();

More Tomcat Integration

The steps above show how to connect to QuickBooks Online data in a simple connection pooling scenario. For more use cases and information, see the JNDI Datasource How-To in the Tomcat documentation.