Create a Data Access Object for Opsgenie 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 Opsgenie integrates connectivity to live Opsgenie data in Java applications. By pairing these technologies, you gain simple, programmatic access to Opsgenie data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Opsgenie data.

Create a DAO for the Opsgenie ActionChannels 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 MyActionChannelsDAO {
  //request specific data from Opsgenie (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM ActionChannels WHERE TeamId = :teamId")
  String findNameByTeamId(@Bind("teamId") String teamId);

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

Open a Connection to Opsgenie

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

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

Opsgenie API Profile Settings

Navigate to your Opsgenie account Settings > App Settings > API Key Management to create a new API key.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Opsgenie 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 Opsgenie will typically look like the following:

jdbc:api:Profile=C:\profiles\Opsgenie.apip;ProfileSettings='APIKey=your_api_key';

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\Opsgenie.apip;ProfileSettings='APIKey=your_api_key';");
MyActionChannelsDAO dao = dbi.open(MyActionChannelsDAO.class);

//do stuff with the DAO

dao.close();

Read Opsgenie Data

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

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

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