各製品の資料を入手。
詳細はこちら →
製品をチェック
JDBI からFreshdesk データのデータアクセスオブジェクトを作成
JDBI でFreshdesk のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるFreshdesk 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for FreshDesk は、Java アプリケーションとリアルタイムFreshdesk のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Freshdesk のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するFreshdesk のデータ の読み書きのためのコードの作成について説明します。
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 はbasic 認証を使用します。データへの接続には、次の接続プロパティを設定してください。
- Domain：この値を、FreshDesk アカウントに紐づけられたドメインに設定します。例えば、 https://my_domain.freshdesk.comです。
- APIKey：この値を、FreshDesk アカウントに紐づけられたAPI キーに設定します。API キーを取得するには、 サポートPortal にログインして、-> 右上端のプロファイル写真をクリック、-> プロファイル設定ページに移動します。API キーは、 右のchange password セクションの下から生成できます。
ビルトイン接続文字列デザイナー
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 データについて
Freshdesk への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Freshdesk のTickets エンティティからデータを取得できます。
//disply the result of our 'find' method
String name = dao.findNameByStatus("2");
System.out.println(name);
Freshdesk データの書き方
以前定義した方法を使用すれば、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 を操作しましょう。
関連コンテンツ
