Connect to CircleCI Data from a Connection Pool in Jetty

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

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

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

    Using API Key Authentication

    CircleCI uses personal API tokens to authenticate API requests. To generate a personal API token, log in to your CircleCI account, navigate to User Settings > Personal API Tokens, and click Create New Token. Copy the token value immediately as it is only shown once.

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

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your CircleCI personal API token.

    Example connection string:

    Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';
    
  4. Configure the resource in the Web.xml:

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

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

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 CircleCI with the API Driver

Connect to CircleCI