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

Create a DAO for the Egnyte Bookmarks 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 MyBookmarksDAO {
  //request specific data from Egnyte (String type is used for simplicity)
  @SqlQuery("SELECT Path FROM Bookmarks WHERE FolderId = :folderId")
  String findPathByFolderId(@Bind("folderId") String folderId);

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

Open a Connection to Egnyte

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

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

Egnyte API Profile Settings

Register a developer account with Egnyte and create an OAuth application to receive a Client ID and Secret. Your domain is extracted from your Egnyte URL.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Egnyte.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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\Egnyte.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyBookmarksDAO dao = dbi.open(MyBookmarksDAO.class);

//do stuff with the DAO

dao.close();

Read Egnyte Data

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

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

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