Connect to Buildkite Data from a Connection Pool in Jetty

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
The Buildkite JDBC Driver supports connection pooling: This article shows how to connect faster to Buildkite data from Web apps in Jetty.

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

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

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

    Buildkite API Profile Settings

    Buildkite uses HTTP API key authentication. Your Buildkite API access token is used to authenticate requests as a Bearer token. You can generate or view your tokens at https://buildkite.com/user/api-access-tokens.

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

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your Buildkite API access token.
    • Organization: Set this to your Buildkite organization slug (e.g. acme-inc).
  4. Configure the resource in the Web.xml:

    
    
      jdbc/buildkitedb
      javax.sql.DataSource
      Container
    
    
  5. You can then access Buildkite with a lookup to java:comp/env/jdbc/buildkitedb:

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

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.

Ready to get started?

Connect to live data from Buildkite with the API Driver

Connect to Buildkite