Connect to ConvertAPI Data from a Connection Pool in Jetty

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

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

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

    ConvertAPI uses API Secret Key authentication. Your ConvertAPI Secret is used to authenticate requests. You can find your API Secret in the ConvertAPI dashboard under your account settings.

    Using APIKey Authentication

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

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your ConvertAPI API secret key.

    Example connection string:

    Profile=C:\profiles\ConvertAPI.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
    
  4. Configure the resource in the Web.xml:

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

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

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

Connect to ConvertAPI