Connect to Workable Data from a Connection Pool in Jetty

The CData JDBC driver for Workable is easy to integrate with Java Web applications. This article shows how to efficiently connect to Workable data in Jetty by configuring the driver for connection pooling. You will configure a JNDI resource for Workable 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 Workable data source at the level of the Web app, in WEB-INF\jetty-env.xml.

   
   <Configure id='workabledemo' class="org.eclipse.jetty.webapp.WebAppContext">
       <New id="workabledemo" class="org.eclipse.jetty.plus.jndi.Resource">
       <Arg><Ref refid="workabledemo"/></Arg>
       <Arg>jdbc/workabledb</Arg>
       <Arg>
         <New class="cdata.jdbc.api.APIDriver">
           <Set name="url">jdbc:api:</Set>
           <Set name="Profile">C:\profiles\Workable.apip</Set>
           <Set name="ProfileSettings">'AuthScheme</Set>
           <Set name="APIKey">my_api_key</Set>
           <Set name="Subdomain">acmeinc'</Set>
         </New>
       </Arg>
     </New>
   </Configure>
   

   Using API Key Authentication

   Workable uses API key authentication to control access to the API. To obtain an API Key:

   1. Log in to your Workable account.
   2. Navigate to Settings > Integrations > API Access Tokens.
   3. Click "Generate API Token".
   4. Copy the generated token.

   After obtaining your API Key, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   Set the following in the ProfileSettings connection property:
   • APIKey: Set this to your Workable API Key.
   • Subdomain: Set this to your Workable account subdomain. For example, if your Workable URL is acmeinc.workable.com, then the Subdomain is 'acmeinc'.

   Example Connection String

   Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';
   

4. Configure the resource in the Web.xml:

   
     jdbc/workabledb
     javax.sql.DataSource
     Container
   
   

5. You can then access Workable with a lookup to java:comp/env/jdbc/workabledb:

   InitialContext ctx = new InitialContext();
   DataSource myworkable = (DataSource)ctx.lookup("java:comp/env/jdbc/workabledb");
   

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.