Connect to BugHerd Data from a Connection Pool in Jetty

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

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

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

   BugHerd API Profile Settings

   BugHerd uses HTTP Basic authentication with an API key as the username. To obtain an API key:

   1. Sign in to your BugHerd account at https://www.bugherd.com
   2. Navigate to Settings > General Settings
   3. Locate the API Key section and copy the generated key

   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 BugHerd API key. The driver uses the key as the Basic auth username and sets the password internally to the literal value 'x' as required by BugHerd.

4. Configure the resource in the Web.xml:

   
   
     jdbc/bugherddb
     javax.sql.DataSource
     Container
   
   

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

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

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.