JDBI からZendesk データのデータアクセスオブジェクトを作成

JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Zendesk は、Java アプリケーションとリアルタイムZendesk のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Zendesk のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するZendesk のデータ の読み書きのためのコードの作成について説明します。

Zendesk Tickets Entity のDAO を作成

以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。

public interface MyTicketsDAO {
  //insert new data into Zendesk
  @SqlUpdate("INSERT INTO Tickets (Industry, Subject) values (:industry, :subject)")
  void insert(@Bind("industry") String industry, @Bind("subject") String subject);

  //request specific data from Zendesk (String type is used for simplicity)
  @SqlQuery("SELECT Subject FROM Tickets WHERE Industry = :industry")
  String findSubjectByIndustry(@Bind("industry") String industry);

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

Zendesk への接続を開く

必要な接続プロパティを収集し、Zendesk に接続するための適切なJDBC URL を作成します。

Zendesk 接続プロパティの取得・設定方法

Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

Zendesk への認証

Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。

API トークン認証

API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

1. Token アクセスを有効にします。
2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。

その他の認証方法についてはヘルプドキュメントを参照してください。

ビルトイン接続文字列デザイナー

JDBC URL の構成については、Zendesk JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。

java -jar cdata.jdbc.zendesk.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

Zendesk の接続文字列は、通常次のようになります。

jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;

構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。

DBI dbi = new DBI("jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;");
MyTicketsDAO dao = dbi.open(MyTicketsDAO.class);

//do stuff with the DAO

dao.close();

Zendesk データについて

Zendesk への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Zendesk のTickets エンティティからデータを取得できます。

//disply the result of our 'find' method
String subject = dao.findSubjectByIndustry("Floppy Disks");
System.out.println(subject);

Zendesk データの書き方

以前定義した方法を使用すれば、Zendesk にデータを書き込むことも簡単になります。

//add a new entry to the Tickets entity
dao.insert(newIndustry, newSubject);

JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for Zendesk と統合することで、SQL Object API for Zendesk を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムZendesk を操作しましょう。