Create a Data Access Object for Sentry Data using JDBI

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Sentry integrates connectivity to live Sentry data in Java applications. By pairing these technologies, you gain simple, programmatic access to Sentry data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Sentry data.

Create a DAO for the Sentry UserOrganizations Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyUserOrganizationsDAO {
  //request specific data from Sentry (String type is used for simplicity)
  @SqlQuery("SELECT  FROM UserOrganizations WHERE  = :")
  String findBy(@Bind("") String );

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Open a Connection to Sentry

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Sentry.

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.

• 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.

A connection string for Sentry will typically look like the following:

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

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";");
MyUserOrganizationsDAO dao = dbi.open(MyUserOrganizationsDAO.class);

//do stuff with the DAO

dao.close();

Read Sentry Data

With the connection open to Sentry, simply call the previously defined method to retrieve data from the UserOrganizations entity in Sentry.

//disply the result of our 'find' method
String  = dao.findBy("");
System.out.println();

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Sentry by integrating with the CData JDBC Driver for Sentry. Download a free trial and work with live Sentry data in custom Java applications today.