JDBI でFreshdesk data 用のSQL オブジェクトAPIを作成する方法を概説します。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Freshdesk は、Java アプリケーションとリアルタイムFreshdesk data のデータ連携を実現します。これらの技術を組み合わせることによって、Freshdesk data へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するFreshdesk data の読み書きのためのコードの作成について説明します。
Freshdesk Tickets Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyTicketsDAO {
//insert new data into Freshdesk
@SqlUpdate("INSERT INTO Tickets (Status, Name) values (:status, :name)")
void insert(@Bind("status") String status, @Bind("name") String name);
//request specific data from Freshdesk (String type is used for simplicity)
@SqlQuery("SELECT Name FROM Tickets WHERE Status = :status")
String findNameByStatus(@Bind("status") String status);
/*
* close with no args is used to close the connection
*/
void close();
}
Freshdesk への接続を開く
必要な接続プロパティを収集し、Freshdesk に接続するための適切なJDBC URL を作成します。
FreshDesk makes use of basic authentication. To connect to data, set the following connection properties:
- Domain: Set this to the domain associated with your FreshDesk account. For example, in your URL: https://my_domain.freshdesk.com.
- APIKey: Set this to the API key associated with your FreshDesk account. To retrieve your API key, Log into your support Portal -> Click on profile picture in the top right corner -> profile settings page. The API key will be available below the change password section to the right.
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Freshdesk JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.freshdesk.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。

Freshdesk の接続文字列は、通常次のようになります。
jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;");
MyTicketsDAO dao = dbi.open(MyTicketsDAO.class);
//do stuff with the DAO
dao.close();
Freshdesk Data について
Freshdesk への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Freshdesk のTickets エンティティからデータを取得できます。
//disply the result of our 'find' method
String name = dao.findNameByStatus("2");
System.out.println(name);
Freshdesk Data の書き方
以前定義した方法を使用すれば、Freshdesk にデータを書き込むことも簡単になります。
//add a new entry to the Tickets entity
dao.insert(newStatus, newName);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for Freshdesk と統合することで、SQL Object API for Freshdesk を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでライブFreshdesk を操作しましょう。