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

Create a DAO for the Samanage Audits 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 MyAuditsDAO {
  //request specific data from Samanage (String type is used for simplicity)
  @SqlQuery("SELECT Messages FROM Audits WHERE SourceType = :sourceType")
  String findMessagesBySourceType(@Bind("sourceType") String sourceType);

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

Open a Connection to Samanage

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

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

Samanage API Profile Settings

Navigate to Setup > Users in Samanage, click your username, and select Generate JSON Web Token from the Action dropdown.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Samanage.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\Samanage.apip;ProfileSettings='APIKey=your_api_key';");
MyAuditsDAO dao = dbi.open(MyAuditsDAO.class);

//do stuff with the DAO

dao.close();

Read Samanage Data

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

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

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