Connect to Superchat Data from a Connection Pool in Jetty

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

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

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

    Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

    Authentication

    To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

    Using API Key Authentication

    You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

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

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your Superchat API key.

    Example connection string:

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

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

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

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

Connect to Superchat