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

Create a DAO for the Pushover GroupMembers 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 MyGroupMembersDAO {
  //request specific data from Pushover (String type is used for simplicity)
  @SqlQuery("SELECT Memo FROM GroupMembers WHERE GroupKey = :groupKey")
  String findMemoByGroupKey(@Bind("groupKey") String groupKey);

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

Open a Connection to Pushover

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

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

Pushover API Profile Settings

Pushover uses API Key authentication. Your Pushover Application API Token is used to authenticate all requests. You can create and manage API tokens in the Pushover dashboard at pushover.net by registering an application under Settings > Your Applications.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your 30-character Pushover Application API Token.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Pushover.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_application_token';

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\Pushover.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_application_token';");
MyGroupMembersDAO dao = dbi.open(MyGroupMembersDAO.class);

//do stuff with the DAO

dao.close();

Read Pushover Data

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

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

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