Ready to get started?

Connect to live data from Drift with the API Driver

Connect to Drift

Configure the CData JDBC Driver for Drift in a Connection Pool in Tomcat



Connect to Drift data from a connection pool in Tomcat.

The CData JDBC Drivers support standard JDBC interfaces to integrate with Web applications running on the JVM. This article details how to connect to Drift data from a connection pool in Tomcat.

Connect to Drift Data through a Connection Pool in Tomcat

  1. Copy the CData JAR and CData .lic file to $CATALINA_HOME/lib. The CData JAR is located in the lib subfolder of the installation directory.
  2. Add a definition of the resource to the context. Specify the JDBC URL here.

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

    Drift API Profile Settings

    Drift uses OAuth-based authentication.

    You must first register an application here: https://dev.drift.com. Your app will be assigned a client ID and a client secret. Set these in your connection string via the OAuthClientId and OAuthClientSecret properties. More information on setting up an OAuth application can be found at https://devdocs.drift.com/docs/.

    After setting the following options in the ProfileSettings connection property, you are ready to connect:

    • AuthScheme: Set this to OAuth.
    • OAuthClientId: Set this to the Client Id that is specified in your app settings.
    • OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
    • CallbackURL: Set this to the Redirect URI you specified in your app settings.
    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Drift JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.api.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    You can see the JDBC URL specified in the resource definition below.

    <Resource name="jdbc/api" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.api.APIDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:api:Profile=C:\profiles\Drift.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH" maxActive="20" maxIdle="10" maxWait="-1" />

    To allow a single application to access Drift data, add the code above to the context.xml in the application's META-INF directory.

    For a shared resource configuration, add the code above to the context.xml located in $CATALINA_BASE/conf. A shared resource configuration provides connectivity to Drift for all applications.

  3. Add a reference to the resource to the web.xml for the application. Drift data JSP jdbc/API javax.sql.DataSource Container
  4. Initialize connections from the connection pool: Context initContext = new InitialContext(); Context envContext = (Context)initContext.lookup("java:/comp/env"); DataSource ds = (DataSource)envContext.lookup("jdbc/API"); Connection conn = ds.getConnection();

More Tomcat Integration

The steps above show how to connect to Drift data in a simple connection pooling scenario. For more use cases and information, see the JNDI Datasource How-To in the Tomcat documentation.