Connect to CleverPush Data from a Connection Pool in Jetty

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

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

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

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

    Cleverpush API Profile Settings

    CleverPush uses private API keys to authenticate requests. Your API key is passed as the Authorization request header value on every API call.

    You can find your private API key in the CleverPush dashboard under Settings > API. Use the private key (not the public key) for server-side access.

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

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your CleverPush private API key.

    Optional Connection Properties

    • ChannelId: Set this to your default CleverPush channel identifier. Most tables require a channel filter. Setting this property allows queries without specifying ChannelId in every WHERE clause.
  4. Configure the resource in the Web.xml:

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

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

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

Connect to CleverPush