Ready to get started?

Connect to live data from Harvest with the API Driver

Connect to Harvest

Connect to Harvest Data from a Connection Pool in Jetty



The Harvest JDBC Driver supports connection pooling: This article shows how to connect faster to Harvest data from Web apps in Jetty.

The CData JDBC driver for Harvest is easy to integrate with Java Web applications. This article shows how to efficiently connect to Harvest data in Jetty by configuring the driver for connection pooling. You will configure a JNDI resource for Harvest in Jetty.

Configure the JDBC Driver for Salesforce as a JNDI Data Source

Follow the steps below to connect to Salesforce from Jetty.

  1. Enable the JNDI module for your Jetty base. The following command enables JNDI from the command-line:

    java -jar ../start.jar --add-to-startd=jndi
  2. Add the CData and license file, located in the lib subfolder of the installation directory, into the lib subfolder of the context path.
  3. Declare the resource and its scope. Enter the required connection properties in the resource declaration. This example declares the Harvest data source at the level of the Web app, in WEB-INF\jetty-env.xml.

    <Configure id='harvestdemo' class="org.eclipse.jetty.webapp.WebAppContext"> <New id="harvestdemo" class="org.eclipse.jetty.plus.jndi.Resource"> <Arg><Ref refid="harvestdemo"/></Arg> <Arg>jdbc/harvestdb</Arg> <Arg> <New class="cdata.jdbc.api.APIDriver"> <Set name="url">jdbc:api:</Set> <Set name="Profile">C:\profiles\Harvest.apip</Set> <Set name="ProfileSettings">'APIKey</Set> <Set name="AccountId">_your_account_id'</Set> </New> </Arg> </New> </Configure>

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

    Harvest API Profile Settings

    To authenticate to Harvest, you can use either Token authentication or the OAuth standard. Use Basic authentication to connect to your own data. Use OAuth to allow other users to connect to their data.

    Using Token Authentication

    To use Token Authentication, set the APIKey to your Harvest Personal Access Token in the ProfileSettings connection property. In addition to APIKey, set your AccountId in ProfileSettings to connect.

    Using OAuth Authentication

    First, register an OAuth2 application with Harvest. The application can be created from the "Developers" section of Harvest ID.

    After setting the following connection properties, you are ready to connect:

    • ProfileSettings: Set your AccountId in ProfileSettings.
    • AuthScheme: Set this to OAuth.
    • OAuthClientId: Set this to the client ID that you specified in your app settings.
    • OAuthClientSecret: Set this to the client secret that you specified in your app settings.
    • CallbackURL: Set this to the Redirect URI that you specified in your app settings.
    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage how the driver obtains and refreshes the OAuthAccessToken.
  4. Configure the resource in the Web.xml:

    jdbc/harvestdb javax.sql.DataSource Container
  5. You can then access Harvest with a lookup to java:comp/env/jdbc/harvestdb: InitialContext ctx = new InitialContext(); DataSource myharvest = (DataSource)ctx.lookup("java:comp/env/jdbc/harvestdb");

More Jetty Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more use cases and information, see the Working with Jetty JNDI chapter in the Jetty documentation.