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

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Sentry 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 Sentry data from a connection pool in Tomcat.

Connect to Sentry 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.

    Using API Key Authentication

    Sentry uses token-based authentication. To obtain an Auth Token:

    1. Log in to your Sentry account at https://sentry.io
    2. Navigate to Settings > Auth Tokens
    3. Click "Create New Token"
    4. Select the required scopes and click "Create Token"
    5. Copy the generated token (it will only be shown once)

    After obtaining your Auth Token, set the following connection properties:

    • AuthScheme: Set this to APIKey.
    Set the following in the ProfileSettings connection property:
    • APIKey: Set this to your Sentry Auth Token.
    • OrganizationId: Set this to your Sentry organization slug or ID.

    Example Connection String

    Profile=C:\profiles\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";
    

    Connecting to Sentry

    Once the authentication is configured, you can connect to Sentry and query data from any of the available tables such as Organizations, Projects, Issues, and Events.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Sentry 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\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";" maxActive="20" maxIdle="10" maxWait="-1" />
    

    To allow a single application to access Sentry 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 Sentry for all applications.

  3. Add a reference to the resource to the web.xml for the application.
    
      Sentry 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 Sentry data in a simple connection pooling scenario. For more use cases and information, see the JNDI Datasource How-To in the Tomcat documentation.

Ready to get started?

Connect to live data from Sentry with the API Driver

Connect to Sentry