Connect to Carbone Data from a Connection Pool in Jetty

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

   
   
   <Configure id='carbonedemo' class="org.eclipse.jetty.webapp.WebAppContext">
       <New id="carbonedemo" class="org.eclipse.jetty.plus.jndi.Resource">
       <Arg><Ref refid="carbonedemo"/></Arg>
       <Arg>jdbc/carbonedb</Arg>
       <Arg>
         <New class="cdata.jdbc.api.APIDriver">
           <Set name="url">jdbc:api:</Set>
           <Set name="Profile">C:\profiles\Carbone.apip</Set>
           <Set name="AuthScheme">APIKey</Set>
           <Set name="APIKey">your_api_key</Set>
         </New>
       </Arg>
     </New>
   </Configure>
   

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

   Carbone API Profile Settings

   Carbone uses API key authentication via a Bearer token in the Authorization header. To obtain an API key:

   1. Log in to your Carbone account at https://account.carbone.io
   2. Copy the API key shown on the account home page

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

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Carbone API key (Bearer token).
   • CarboneVersion: (Optional) The major version of the Carbone API to target via the carbone-version request header. Defaults to 5. Accepted values: 5, 4, 3, staging.

4. Configure the resource in the Web.xml:

   
   
     jdbc/carbonedb
     javax.sql.DataSource
     Container
   
   

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

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

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.